IBM WebSphere Extended Deployment (XD)TM
Release 6.0

com.ibm.wsspi.giop.filter
GiopDefaultFilter

java.lang.Object
  |
  +--com.ibm.wsspi.giop.filter.GiopDefaultFilter
All Implemented Interfaces
GiopFilter


This class has been picked up from the proxy component. Defines an GIOP, multi-threaded filter that implements the GiopFilter interface. GiopDefaultFilter makes writing filters easier. It provides simple versions of the lifecycle methods init and destroy. To write a filter, you need only override the abstract doFilter method.

As a further convenience, this class provides instance variables for a filter's configuration, context, and manager.


Field Summary
protected  GiopFilterChainManagerfilterChainManager
           A filter's view of its manager to system-wide services.

Constructor Summary
GiopDefaultFilter()
           Does nothing because all initialization is performed by the init method. This.


Method Summary
public  voidinit()
           Called by the proxy to indicate the filter is being placed into service; Convenience method which can be overridden so that there's no need to call super.
public  GiopFilterStatusCodesdoFilter(com.ibm.wsspi.giop.filter.GiopProxyServiceContext)
           Called by the proxy to allow the filter to service an event. .
public  voiddestroy()
           Called by the proxy to indicate the filter is being taken out of service; this implementation performs no resource cleanup.

Inherited Methods

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

Field Detail

filterChainManager

protected 
  filterChainManager
A filter's view of its manager to system-wide services.

Constructor Detail

GiopDefaultFilter

protected GiopDefaultFilter( )
Does nothing because all initialization is performed by the init method. This constructor, together with init, enables subclasses to implement serializable properly.


Method Detail

init

public void init()
Called by the proxy to indicate the filter is being placed into service; Convenience method which can be overridden so that there's no need to call super.init(filter). Simply override this method and it will be called by HttpDefaultFilter.init(filterWrapper).


Throws:
    java.lang.Exception


doFilter

public GiopFilterStatusCodes doFilter(GiopProxyServiceContext serviceContext)
Called by the proxy to allow the filter to service an event.

This method is declared abstract so subclasses must override it. Refer to GiopFilter for an overview of multithreading and object lifetime issues that must be adhered to when implementing this method.

Parameters:
    serviceContext - The event to be processed; provides access to request and response objects.


Returns:
     =STATUS_FILTER_CONTINUE when filter event processing succeeds and chaining should continue. =STATUS_FILTER_WAIT When a filter wants to suspend further processing on the service context until it is resumed. The next filter in the chain will receive control after the service context is resumed. This status code cannot be used by local provider filters or "response" filters. =STATUS_FILTER_ABORT When a filter wants to abort further processing on the service context. It is expected that the filter will set the response to be sent to the client, if not a standard error response will be sent to the client.


Throws:
    java.lang.Exception


destroy

public void destroy()
Called by the proxy to indicate the filter is being taken out of service; this implementation performs no resource cleanup.


IBM WebSphere Extended Deployment (XD)TM
Release 6.0