org.apache.catalina

Class InstanceEvent

java.lang.Object

java.util.EventObject

org.apache.catalina.InstanceEvent

All Implemented Interfaces:

Serializable

public final class InstanceEvent
extends EventObject

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.

Version:

$Revision: 1.2 $ $Date: 2005/12/08 01:27:17 $

Author:

Craig R. McClanahan

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceEvent.EventType

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
InstanceEvent(Wrapper wrapper, javax.servlet.Filter filter, InstanceEvent.EventType type) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Filter filter, InstanceEvent.EventType type, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Filter filter, InstanceEvent.EventType type, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, Throwable exception) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Filter filter, InstanceEvent.EventType type, Throwable exception) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Servlet servlet, InstanceEvent.EventType type) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Servlet servlet, InstanceEvent.EventType type, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Servlet servlet, InstanceEvent.EventType type, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, Throwable exception) Construct a new InstanceEvent with the specified parameters.
InstanceEvent(Wrapper wrapper, javax.servlet.Servlet servlet, InstanceEvent.EventType type, Throwable exception) Construct a new InstanceEvent with the specified parameters.

Method Summary

Modifier and Type	Method and Description
Throwable	getException() Return the exception that occurred during the processing that was reported by this event.
javax.servlet.Filter	getFilter() Return the filter instance for which this event occurred.
javax.servlet.ServletRequest	getRequest() Return the servlet request for which this event occurred.
javax.servlet.ServletResponse	getResponse() Return the servlet response for which this event occurred.
javax.servlet.Servlet	getServlet() Return the servlet instance for which this event occurred.
InstanceEvent.EventType	getType() Return the event type of this event.
Wrapper	getWrapper() Return the Wrapper managing the servlet instance for which this event occurred.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Filter filter,
                     InstanceEvent.EventType 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)

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Filter filter,
                     InstanceEvent.EventType type,
                     Throwable 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

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Filter filter,
                     InstanceEvent.EventType type,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse 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

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Filter filter,
                     InstanceEvent.EventType type,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     Throwable 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

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Servlet servlet,
                     InstanceEvent.EventType 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)

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Servlet servlet,
                     InstanceEvent.EventType type,
                     Throwable 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

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Servlet servlet,
                     InstanceEvent.EventType type,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse 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

InstanceEvent

public InstanceEvent(Wrapper wrapper,
                     javax.servlet.Servlet servlet,
                     InstanceEvent.EventType type,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     Throwable 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 Detail

getException

public Throwable getException()

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

getFilter

public javax.servlet.Filter getFilter()

Return the filter instance for which this event occurred.

getRequest

public javax.servlet.ServletRequest getRequest()

Return the servlet request for which this event occurred.

getResponse

public javax.servlet.ServletResponse getResponse()

Return the servlet response for which this event occurred.

getServlet

public javax.servlet.Servlet getServlet()

Return the servlet instance for which this event occurred.

getType

public InstanceEvent.EventType getType()

Return the event type of this event.

getWrapper

public Wrapper getWrapper()

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