InstanceSupport (Tomcat API Documentation)
Keywords: org.apache.catalina.util.InstanceSupport class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.catalina.util
Class InstanceSupport

    java.lang.Object
      org.apache.catalina.util.InstanceSupport

    public final class InstanceSupport

extends java.lang.Object

Support class to assist in firing InstanceEvent notifications to registered InstanceListeners.

Version:
  $Id: InstanceSupport.java 771009 2009-05-03 01:15:41Z markt $
Author:
  Craig R. McClanahan

Constructor Summary
`InstanceSupport(Wrapper wrapper)` Construct a new InstanceSupport object associated with the specified Instance component.

Method Summary
`void` | `addInstanceListener(InstanceListener listener)` Add a lifecycle event listener to this component.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Filter filter)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Filter filter, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Filter filter, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.Throwable exception)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Filter filter, java.lang.Throwable exception)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Servlet servlet)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.Throwable exception)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`void` | `fireInstanceEvent(java.lang.String type, javax.servlet.Servlet servlet, java.lang.Throwable exception)` Notify all lifecycle event listeners that a particular event has occurred for this Container.
`Wrapper` | `getWrapper()` Return the Wrapper with which we are associated.
`void` | `removeInstanceListener(InstanceListener listener)` Remove a lifecycle event listener from this component.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### InstanceSupport

    public InstanceSupport(Wrapper wrapper)

  Construct a new InstanceSupport object associated with the specified Instance component.

  Parameters:
    `wrapper` - The component that will be the source of events that we fire

Method Detail

### getWrapper

    public Wrapper getWrapper()

  Return the Wrapper with which we are associated.

### addInstanceListener

    public void addInstanceListener(InstanceListener listener)

  Add a lifecycle event listener to this component.

  Parameters:
    `listener` - The listener to add

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Filter filter)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `filter` - The relevant Filter for this event

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Filter filter,
                                  java.lang.Throwable exception)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `filter` - The relevant Filter for this event
    `exception` - Exception that occurred

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Filter filter,
                                  javax.servlet.ServletRequest request,
                                  javax.servlet.ServletResponse response)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `filter` - The relevant Filter for this event
    `request` - The servlet request we are processing
    `response` - The servlet response we are processing

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Filter filter,
                                  javax.servlet.ServletRequest request,
                                  javax.servlet.ServletResponse response,
                                  java.lang.Throwable exception)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `filter` - The relevant Filter for this event
    `request` - The servlet request we are processing
    `response` - The servlet response we are processing
    `exception` - Exception that occurred

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Servlet servlet)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `servlet` - The relevant Servlet for this event

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Servlet servlet,
                                  java.lang.Throwable exception)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `servlet` - The relevant Servlet for this event
    `exception` - Exception that occurred

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Servlet servlet,
                                  javax.servlet.ServletRequest request,
                                  javax.servlet.ServletResponse response)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `servlet` - The relevant Servlet for this event
    `request` - The servlet request we are processing
    `response` - The servlet response we are processing

### fireInstanceEvent

    public void fireInstanceEvent(java.lang.String type,
                                  javax.servlet.Servlet servlet,
                                  javax.servlet.ServletRequest request,
                                  javax.servlet.ServletResponse response,
                                  java.lang.Throwable exception)

  Notify all lifecycle event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.

  Parameters:
    `type` - Event type
    `servlet` - The relevant Servlet for this event
    `request` - The servlet request we are processing
    `response` - The servlet response we are processing
    `exception` - Exception that occurred

### removeInstanceListener

    public void removeInstanceListener(InstanceListener listener)

  Remove a lifecycle event listener from this component.

  Parameters:
    `listener` - The listener to remove

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.