IBM WebSphere Application ServerTM
Release 8

Package com.ibm.wsspi.rrd.extension.handler

This package contains the interfaces necessary to create and manipulate RRD extension handlers.

See:
          Description

Interface Summary
ExtensionHandler The ExtensionHandler interface represents an RRD extension handler, which is used to handle extension data that is received in an RRD request.
ExtensionHandlerConfig Ths ExtensionHandlerConfig interface provides a method by which ExtensionHandler objects can obtain initialization and runtime configuration information.
ExtensionHandlerRequest The ExtensionHandlerRequest interface defines the request information that is received from an RRD request.
ExtensionHandlerResponse The ExtensionHandlerResponse interface defines the response information that is attached to an RRD response.
 

Class Summary
ExtensionHandlerRequestWrapper The ExtensionHandlerRequestWrapper class defines a wrapper for ExtensionHandlerRequest objects, which are in turn provided to extension handlers for processing.
ExtensionHandlerResponseWrapper The ExtensionHandlerResponseWrapper class defines a wrapper for ExtensionHandlerResponse objects, which are in turn provided to extension handlers for processing.
GenericExtensionHandler The GenericExtensionHandler class defines an abstract class which provides a base for RRD extension handler classes that handles basic initialization and configuration methods.
 

Package com.ibm.wsspi.rrd.extension.handler Description

This package contains the interfaces necessary to create and manipulate RRD extension handlers.

An RRD extension handlers is a class that implements ExtensionHandler and obeys the extension handler lifecycle: initialization, handling, and destruction, which occurs as follows:

When the remote portion of an RRD-enabled application is initialized, the RRD extension handler descriptor is parsed, and each extension handler is initialized with a parsed ExtensionConfig object. Each extension handler is then placed in an extension handler chain. This chain is executed upon receiving an RRD request by calling the doHandle method on each extension handler that matches the qualified name of some extension data attached to the RRD request. Each extension handler, with the assistance of the provided ExtensionHandlerRequest object, is then expected to process the received extension data (which may be located in the header, body, or header and body of the RRD request) in some manner. Afterwards, each extension handler is responsible for executing the next portion of the extension handler chain.

Once the end of the extension handler chain is reached, an RRD response will be created, and each extension handler has the opportunity to attach and EMF object to the response as extension data via the provided ExtensionHandlerResponse instance; this extension data will then be received by the appropriate extension generator on the local portion of the RRD-enabled application. After this (optional) processing has occurred, the extension handler chain execution is completed until another RRD request is received.

Upon application server termination, each extension handler will be destroyed via a call to its destroy method. At this point, any persistent resources associated with the extension handler should be released.

Version:
1.1.0

IBM WebSphere Application ServerTM
Release 8