IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.rrd.extension.generator
Interface ExtensionGenerator

All Known Implementing Classes:
GenericExtensionGenerator

public interface ExtensionGenerator

The ExtensionGenerator interface represents an RRD extension generator, which is used to generate extension data that is later attached to an RRD request.

Since:
WAS6.1

Method Summary
 void destroy()
          Destroys this extension generator.
 void doGenerate(ExtensionGeneratorRequest request, ExtensionGeneratorResponse response, ExtensionChain chain)
          Performs processing using this extension generator by generating an extension element and attaching it to an RRD request.
 ExtensionGeneratorConfig getExtensionGeneratorConfig()
          Retrieves the extension generator configuration information associated with this extension generator.
 void init(ExtensionGeneratorConfig config)
          Initializes this extension generator.
 

Method Detail

getExtensionGeneratorConfig

ExtensionGeneratorConfig getExtensionGeneratorConfig()
Retrieves the extension generator configuration information associated with this extension generator.

Returns:
an ExtensionGeneratorConfig object cotnaining the extension generator configuration information associated with this extension generator.

init

void init(ExtensionGeneratorConfig config)
          throws RRDException
Initializes this extension generator.

Parameters:
config - an ExtensionConfig object containing configuration information for this extension generator.
Throws:
RRDException - if an error occurs during initialization.

doGenerate

void doGenerate(ExtensionGeneratorRequest request,
                ExtensionGeneratorResponse response,
                ExtensionChain chain)
                throws RRDException,
                       java.io.IOException
Performs processing using this extension generator by generating an extension element and attaching it to an RRD request.

Parameters:
request - an ExtensionGeneratorRequest object containing request information for this extension generator.
response - an ExtensionGeneratorResponse object that is used by this extension generator to provide response information.
chain - an ExtensionChain object used to invoke the next extension generator in the chain.
Throws:
RRDException - if an error occurs during extension generation.
java.io.IOException - if an IOException occurs during extension generation.

destroy

void destroy()
Destroys this extension generator.


IBM WebSphere Application ServerTM
Release 8