IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.wssecurity.token
Interface TokenGeneratorComponent

All Superinterfaces:
Initializable, com.ibm.ws.webservices.wssecurity.WSSComponent, com.ibm.ws.webservices.wssecurity.WSSGeneratorComponent
All Known Implementing Classes:
LTPATokenGenerator, UsernameTokenGenerator, X509TokenGenerator

public interface TokenGeneratorComponent
extends com.ibm.ws.webservices.wssecurity.WSSGeneratorComponent

This is the interface for generating a security token element into SOAP messages. Implementors must provide the init() and invoke() methods.

The signature of the init() method is:

public void init(java.util.Map map) throws SoapSecurityException

This method initializes the generator with a TokenGeneratorConfig object which is passed in by the map parameter.

The map parameter is a Map object which contains name-value pairs. These pairs include <Property> elements in the configuration XMI files and a TokenGeneratorConfig object. The TokenGeneratorConfig is stored with a key of TokenGeneratorConfig.CONFIG_KEY.

The signature of the invoke() method is:

public void invoke(org.w3c.dom.Document doc, org.w3c.dom.Element parent, java.util.Map context) throws SoapSecurityException

The doc parameter is a Document object that contains the SOAP envelope.

The parent parameter is an Element object that is the parent of the element to be generated.

The context parameter is a Map object which contains name-value pairs. The following list shows the only supported names (keys) and their meaning. The keys shown are fields from the com.ibm.wsspi.wssecurity.Constants and com.ibm.wsspi.wssecurity.config.TokenGeneratorConfig classes.

See Also:
LTPATokenGenerator, UsernameTokenGenerator, X509TokenGenerator, Constants, TokenGeneratorConfig

Field Summary
static java.lang.String STANDALONE
           
 
Method Summary
 
Methods inherited from interface com.ibm.ws.webservices.wssecurity.WSSGeneratorComponent
invoke
 
Methods inherited from interface com.ibm.ws.webservices.wssecurity.WSSComponent
init
 

Field Detail

STANDALONE

static final java.lang.String STANDALONE
See Also:
Constant Field Values

IBM WebSphere Application ServerTM
Release 8