org.apache.catalina: public final class: InstanceEvent

org.apache.catalina
public final class: InstanceEvent [javadoc | source]

java.lang.Object
   java.util.EventObject
      org.apache.catalina.InstanceEvent

All Implemented Interfaces:
Serializable

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) $

Field Summary
public static final String	BEFORE_INIT_EVENT	The event indicating that the `init()` method is about to be called for this instance.
public static final String	AFTER_INIT_EVENT	The event indicating that the `init()` method has returned.
public static final String	BEFORE_SERVICE_EVENT	The event indicating that the `service()` method is about to be called on a servlet. The `servlet` property contains the servlet being called, and the `request` and `response` properties contain the current request and response being processed.
public static final String	AFTER_SERVICE_EVENT	The event indicating that the `service()` method has returned. The `servlet` property contains the servlet that was called, and the `request` and `response` properties contain the current request and response being processed.
public static final String	BEFORE_DESTROY_EVENT	The event indicating that the `destroy` method is about to be called for this instance.
public static final String	AFTER_DESTROY_EVENT	The event indicating that the `destroy()` method has returned.
public static final String	BEFORE_DISPATCH_EVENT	The event indicating that the `service()` method of a servlet accessed via a request dispatcher is about to be called. The `servlet` property contains a reference to the dispatched-to servlet instance, and the `request` and `response` properties contain the current request and response being processed. The `wrapper` property will contain a reference to the dispatched-to Wrapper.
public static final String	AFTER_DISPATCH_EVENT	The event indicating that the `service()` method of a servlet accessed via a request dispatcher has returned. The `servlet` property contains a reference to the dispatched-to servlet instance, and the `request` and `response` properties contain the current request and response being processed. The `wrapper` property will contain a reference to the dispatched-to Wrapper.
public static final String	BEFORE_FILTER_EVENT	The event indicating that the `doFilter()` method of a Filter is about to be called. The `filter` property contains a reference to the relevant filter instance, and the `request` and `response` properties contain the current request and response being processed.
public static final String	AFTER_FILTER_EVENT	The event indicating that the `doFilter()` method of a Filter has returned. The `filter` property contains a reference to the relevant filter instance, and the `request` and `response` properties contain the current request and response being processed.

Constructor:

Constructor:
public InstanceEvent(Wrapper wrapper, Filter filter, String type) { // ----------------------------------------------------------- Constructors 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. Parameters: `wrapper` - Wrapper managing this servlet instance `filter` - Filter instance for which this event occurred `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. Parameters: `wrapper` - Wrapper managing this servlet instance `servlet` - Servlet instance for which this event occurred `type` - Event type (required)
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 lifecycle events. Parameters: `wrapper` - Wrapper managing this servlet instance `filter` - Filter instance for which this event occurred `type` - Event type (required) `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 lifecycle events. Parameters: `wrapper` - Wrapper managing this servlet instance `servlet` - Servlet instance for which this event occurred `type` - Event type (required) `exception` - Exception that occurred
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. Parameters: `wrapper` - Wrapper managing this servlet instance `filter` - Filter instance for which this event occurred `type` - Event type (required) `request` - Servlet request we are processing `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. Parameters: `wrapper` - Wrapper managing this servlet instance `servlet` - Servlet instance for which this event occurred `type` - Event type (required) `request` - Servlet request we are processing `response` - Servlet response we are processing
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 filter processing events. Parameters: `wrapper` - Wrapper managing this servlet instance `filter` - Filter instance for which this event occurred `type` - Event type (required) `request` - Servlet request we are processing `response` - Servlet response we are processing `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; } Construct a new InstanceEvent with the specified parameters. This constructor is used for processing servlet processing events. Parameters: `wrapper` - Wrapper managing this servlet instance `servlet` - Servlet instance for which this event occurred `type` - Event type (required) `request` - Servlet request we are processing `response` - Servlet response we are processing `exception` - Exception that occurred

 public InstanceEvent(Wrapper wrapper,
    Filter filter,
    String type) {
    // ----------------------------------------------------------- Constructors
      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.

Parameters:

wrapper - Wrapper managing this servlet instance

filter - Filter instance for which this event occurred

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.

Parameters:

wrapper - Wrapper managing this servlet instance

servlet - Servlet instance for which this event occurred

type - Event type (required)

 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 lifecycle events.

Parameters:

wrapper - Wrapper managing this servlet instance

filter - Filter instance for which this event occurred

type - Event type (required)

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 lifecycle events.

Parameters:

wrapper - Wrapper managing this servlet instance

servlet - Servlet instance for which this event occurred

type - Event type (required)

exception - Exception that occurred

 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.

Parameters:

wrapper - Wrapper managing this servlet instance

filter - Filter instance for which this event occurred

type - Event type (required)

request - Servlet request we are processing

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.

Parameters:

wrapper - Wrapper managing this servlet instance

servlet - Servlet instance for which this event occurred

type - Event type (required)

request - Servlet request we are processing

response - Servlet response we are processing

 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 filter processing events.

Parameters:

wrapper - Wrapper managing this servlet instance

filter - Filter instance for which this event occurred

type - Event type (required)

request - Servlet request we are processing

response - Servlet response we are processing

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;
}

Construct a new InstanceEvent with the specified parameters. This constructor is used for processing servlet processing events.

Parameters:

wrapper - Wrapper managing this servlet instance

servlet - Servlet instance for which this event occurred

type - Event type (required)

request - Servlet request we are processing

response - Servlet response we are processing

exception - Exception that occurred

Method from org.apache.catalina.InstanceEvent Summary:
getException, getFilter, getRequest, getResponse, getServlet, getType, getWrapper

Methods from java.util.EventObject:
getSource, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.catalina.InstanceEvent Detail:
public Throwable getException() { // ------------------------------------------------------------- Properties return (this.exception); } Return the exception that occurred during the processing that was reported by this event.
public Filter getFilter() { return (this.filter); } Return the filter instance for which this event occurred.
public ServletRequest getRequest() { return (this.request); } Return the servlet request for which this event occurred.
public ServletResponse getResponse() { return (this.response); } Return the servlet response for which this event occurred.
public Servlet getServlet() { return (this.servlet); } Return the servlet instance for which this event occurred.
public String getType() { return (this.type); } Return the event type of this event.
public Wrapper getWrapper() { return (this.wrapper); } Return the Wrapper managing the servlet instance for which this event occurred.

Method from org.apache.catalina.InstanceEvent Detail:

 public Throwable getException() {
    // ------------------------------------------------------------- Properties
        return (this.exception);
}

Return the exception that occurred during the processing that was reported by this event.

 public Filter getFilter() {
        return (this.filter);
}

Return the filter instance for which this event occurred.

 public ServletRequest getRequest() {
        return (this.request);
}

Return the servlet request for which this event occurred.

 public ServletResponse getResponse() {
        return (this.response);
}

Return the servlet response for which this event occurred.

 public Servlet getServlet() {
        return (this.servlet);
}

Return the servlet instance for which this event occurred.

 public String getType() {
        return (this.type);
}

Return the event type of this event.

 public Wrapper getWrapper() {
        return (this.wrapper);
}

Return the Wrapper managing the servlet instance for which this event occurred.