Package com.ibm.wsspi.rrd.extension.generator
This package contains the interfaces necessary to create and manipulate RRD extension generators.
See:
Interface Summary
Interface | Description |
---|---|
ExtensionGenerator | The ExtensionGenerator interface represents an RRD extension generator, which is used to generate extension data that is later attached to an RRD request. |
ExtensionGeneratorConfig | The ExtensionGeneratorConfig interface provides a method by which ExtensionGenerator objects can obtain
initialization and runtime configuration information. |
ExtensionGeneratorRequest | The ExtensionGeneratorRequest interface defines the request information that is attached to an RRD request. |
ExtensionGeneratorResponse | The ExtensionGeneratorResponse interface defines the response information that is attached to an RRD response. |
Class Summary
Class | Description |
---|---|
ExtensionGeneratorRequestWrapper | The ExtensionGeneratorRequestWrapper class defines a wrapper for
ExtensionGeneratorRequest objects, which are in turn provided to
extension generators for processing. |
ExtensionGeneratorResponseWrapper | The ExtensionGeneratorResponseWrapper class defines a wrapper for
ExtensionGeneratorResponse objects, which are in turn provided to
extension generators for processing. |
GenericExtensionGenerator | The GenericExtensionGenerator class defines an abstract class which provides a base for RRD extension generator classes that handles basic initialization and configuration methods. |
Package com.ibm.wsspi.rrd.extension.generator Description
This package contains the interfaces necessary to create and manipulate RRD extension generators.An RRD extension generator is a class that implements
ExtensionGenerator
and obeys the
extension generator lifecycle: initialization, generation, and destruction,
which occurs as follows:
When the local portion of an RRD-enabled application is initialized, the RRD extension generator descriptor is parsed, and each extension generator is initialized with a parsed
ExtensionConfig
object. Each extension
generator is then placed in an extension generator chain. This chain is
executed prior to the sending of each RRD request by calling the
doGenerate
method on each extension generator in sequence.
Each extension generator, with the assistance of the provided ExtensionGeneratorRequest
object, is
then expected to attach an instance of an EMF object to either the header,
body, or header and body of the outbound RRD request. Afterwards, each
extension generator is responsible for executing the next portion of the
extension generator chain.
Once the RRD request has been received and processed by the remote RRD-enabled application, a series of extensions may be attached to the RRD response, which is received by the local RRD-enabled application. Each extension generator in the extension generator chain may potentially receive extension data from this RRD response, which can be retrieved from the provided
ExtensionGeneratorResponse
instance.
After this (optional) processing has occurred, the extension generator
chain execution is completed until another RRD request is created.
Upon application server termination, each extension generator will be destroyed via a call to its
destroy
method. At this point,
any persistent resources associated with the extension generator should be
released.
Version:
1.1.0