|
|
Tomcat example source code file (InstanceEvent.java)
This example Tomcat source code file (InstanceEvent.java) is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.
The Tomcat InstanceEvent.java source code
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina;
import java.util.EventObject;
import javax.servlet.Filter;
import javax.servlet.Servlet;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
/**
* General event for notifying listeners of significant events related to
* a specific instance of a Servlet, or a specific instance of a Filter,
* as opposed to the Wrapper component that manages it.
*
* @author Craig R. McClanahan
* @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
*/
public final class InstanceEvent
extends EventObject {
// ----------------------------------------------------- Manifest Constants
/**
* The event indicating that the <code>init() method is about
* to be called for this instance.
*/
public static final String BEFORE_INIT_EVENT = "beforeInit";
/**
* The event indicating that the <code>init() method has returned.
*/
public static final String AFTER_INIT_EVENT = "afterInit";
/**
* The event indicating that the <code>service() method is about
* to be called on a servlet. The <code>servlet property contains
* the servlet being called, and the <code>request and
* <code>response properties contain the current request and
* response being processed.
*/
public static final String BEFORE_SERVICE_EVENT = "beforeService";
/**
* The event indicating that the <code>service() method has
* returned. The <code>servlet property contains the servlet
* that was called, and the <code>request and
* <code>response properties contain the current request and
* response being processed.
*/
public static final String AFTER_SERVICE_EVENT = "afterService";
/**
* The event indicating that the <code>destroy method is about
* to be called for this instance.
*/
public static final String BEFORE_DESTROY_EVENT = "beforeDestroy";
/**
* The event indicating that the <code>destroy() method has
* returned.
*/
public static final String AFTER_DESTROY_EVENT = "afterDestroy";
/**
* The event indicating that the <code>service() method of a
* servlet accessed via a request dispatcher is about to be called.
* The <code>servlet property contains a reference to the
* dispatched-to servlet instance, and the <code>request and
* <code>response properties contain the current request and
* response being processed. The <code>wrapper property will
* contain a reference to the dispatched-to Wrapper.
*/
public static final String BEFORE_DISPATCH_EVENT = "beforeDispatch";
/**
* The event indicating that the <code>service() method of a
* servlet accessed via a request dispatcher has returned. The
* <code>servlet property contains a reference to the
* dispatched-to servlet instance, and the <code>request and
* <code>response properties contain the current request and
* response being processed. The <code>wrapper property will
* contain a reference to the dispatched-to Wrapper.
*/
public static final String AFTER_DISPATCH_EVENT = "afterDispatch";
/**
* The event indicating that the <code>doFilter() method of a
* Filter is about to be called. The <code>filter property
* contains a reference to the relevant filter instance, and the
* <code>request and response properties contain
* the current request and response being processed.
*/
public static final String BEFORE_FILTER_EVENT = "beforeFilter";
/**
* The event indicating that the <code>doFilter() method of a
* Filter has returned. The <code>filter property contains
* a reference to the relevant filter instance, and the
* <code>request and response properties contain
* the current request and response being processed.
*/
public static final String AFTER_FILTER_EVENT = "afterFilter";
// ----------------------------------------------------------- Constructors
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for filter lifecycle events.
*
* @param wrapper Wrapper managing this servlet instance
* @param filter Filter instance for which this event occurred
* @param type Event type (required)
*/
public InstanceEvent(Wrapper wrapper, Filter filter, String type) {
super(wrapper);
this.wrapper = wrapper;
this.filter = filter;
this.servlet = null;
this.type = type;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for filter lifecycle events.
*
* @param wrapper Wrapper managing this servlet instance
* @param filter Filter instance for which this event occurred
* @param type Event type (required)
* @param exception Exception that occurred
*/
public InstanceEvent(Wrapper wrapper, Filter filter, String type,
Throwable exception) {
super(wrapper);
this.wrapper = wrapper;
this.filter = filter;
this.servlet = null;
this.type = type;
this.exception = exception;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for filter processing events.
*
* @param wrapper Wrapper managing this servlet instance
* @param filter Filter instance for which this event occurred
* @param type Event type (required)
* @param request Servlet request we are processing
* @param response Servlet response we are processing
*/
public InstanceEvent(Wrapper wrapper, Filter filter, String type,
ServletRequest request, ServletResponse response) {
super(wrapper);
this.wrapper = wrapper;
this.filter = filter;
this.servlet = null;
this.type = type;
this.request = request;
this.response = response;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for filter processing events.
*
* @param wrapper Wrapper managing this servlet instance
* @param filter Filter instance for which this event occurred
* @param type Event type (required)
* @param request Servlet request we are processing
* @param response Servlet response we are processing
* @param exception Exception that occurred
*/
public InstanceEvent(Wrapper wrapper, Filter filter, String type,
ServletRequest request, ServletResponse response,
Throwable exception) {
super(wrapper);
this.wrapper = wrapper;
this.filter = filter;
this.servlet = null;
this.type = type;
this.request = request;
this.response = response;
this.exception = exception;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for processing servlet lifecycle events.
*
* @param wrapper Wrapper managing this servlet instance
* @param servlet Servlet instance for which this event occurred
* @param type Event type (required)
*/
public InstanceEvent(Wrapper wrapper, Servlet servlet, String type) {
super(wrapper);
this.wrapper = wrapper;
this.filter = null;
this.servlet = servlet;
this.type = type;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for processing servlet lifecycle events.
*
* @param wrapper Wrapper managing this servlet instance
* @param servlet Servlet instance for which this event occurred
* @param type Event type (required)
* @param exception Exception that occurred
*/
public InstanceEvent(Wrapper wrapper, Servlet servlet, String type,
Throwable exception) {
super(wrapper);
this.wrapper = wrapper;
this.filter = null;
this.servlet = servlet;
this.type = type;
this.exception = exception;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for processing servlet processing events.
*
* @param wrapper Wrapper managing this servlet instance
* @param servlet Servlet instance for which this event occurred
* @param type Event type (required)
* @param request Servlet request we are processing
* @param response Servlet response we are processing
*/
public InstanceEvent(Wrapper wrapper, Servlet servlet, String type,
ServletRequest request, ServletResponse response) {
super(wrapper);
this.wrapper = wrapper;
this.filter = null;
this.servlet = servlet;
this.type = type;
this.request = request;
this.response = response;
}
/**
* Construct a new InstanceEvent with the specified parameters. This
* constructor is used for processing servlet processing events.
*
* @param wrapper Wrapper managing this servlet instance
* @param servlet Servlet instance for which this event occurred
* @param type Event type (required)
* @param request Servlet request we are processing
* @param response Servlet response we are processing
* @param exception Exception that occurred
*/
public InstanceEvent(Wrapper wrapper, Servlet servlet, String type,
ServletRequest request, ServletResponse response,
Throwable exception) {
super(wrapper);
this.wrapper = wrapper;
this.filter = null;
this.servlet = servlet;
this.type = type;
this.request = request;
this.response = response;
this.exception = exception;
}
// ----------------------------------------------------- Instance Variables
/**
* The exception that was thrown during the processing being reported
* by this event (AFTER_INIT_EVENT, AFTER_SERVICE_EVENT,
* AFTER_DESTROY_EVENT, AFTER_DISPATCH_EVENT, and AFTER_FILTER_EVENT only).
*/
private Throwable exception = null;
/**
* The Filter instance for which this event occurred (BEFORE_FILTER_EVENT
* and AFTER_FILTER_EVENT only).
*/
private Filter filter = null;
/**
* The servlet request being processed (BEFORE_FILTER_EVENT,
* AFTER_FILTER_EVENT, BEFORE_SERVICE_EVENT, and AFTER_SERVICE_EVENT).
*/
private ServletRequest request = null;
/**
* The servlet response being processed (BEFORE_FILTER_EVENT,
* AFTER_FILTER_EVENT, BEFORE_SERVICE_EVENT, and AFTER_SERVICE_EVENT).
*/
private ServletResponse response = null;
/**
* The Servlet instance for which this event occurred (not present on
* BEFORE_FILTER_EVENT or AFTER_FILTER_EVENT events).
*/
private Servlet servlet = null;
/**
* The event type this instance represents.
*/
private String type = null;
/**
* The Wrapper managing the servlet instance for which this event occurred.
*/
private Wrapper wrapper = null;
// ------------------------------------------------------------- Properties
/**
* Return the exception that occurred during the processing
* that was reported by this event.
*/
public Throwable getException() {
return (this.exception);
}
/**
* Return the filter instance for which this event occurred.
*/
public Filter getFilter() {
return (this.filter);
}
/**
* Return the servlet request for which this event occurred.
*/
public ServletRequest getRequest() {
return (this.request);
}
/**
* Return the servlet response for which this event occurred.
*/
public ServletResponse getResponse() {
return (this.response);
}
/**
* Return the servlet instance for which this event occurred.
*/
public Servlet getServlet() {
return (this.servlet);
}
/**
* Return the event type of this event.
*/
public String getType() {
return (this.type);
}
/**
* Return the Wrapper managing the servlet instance for which this
* event occurred.
*/
public Wrapper getWrapper() {
return (this.wrapper);
}
}
Other Tomcat examples (source code examples)
Here is a short list of links related to this Tomcat InstanceEvent.java source code file:
|
The search page
Other Tomcat source code examples at this package level
Click here to learn more about this project
