IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.token
Interface TokenConsumerComponent

All Superinterfaces:
Initializable, com.ibm.ws.webservices.wssecurity.WSSComponent, com.ibm.ws.webservices.wssecurity.WSSConsumerComponent
All Known Implementing Classes:
IDAssertionUsernameTokenConsumer, LTPATokenConsumer, UsernameTokenConsumer, X509TokenConsumer

public interface TokenConsumerComponent
extends com.ibm.ws.webservices.wssecurity.WSSConsumerComponent

This is the interface for consuming security token elements from 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 consumer with a TokenConsumerConfig 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 TokenConsumerConfig object. The TokenConsumerConfig is stored with a key of TokenConsumerConfig.CONFIG_KEY.

The signature of the invoke() method is:

public void invoke(org.w3c.dom.Node target, java.util.Map context) throws SoapSecurityException

The target parameter is a Node object that represents the element or document to be consumed.

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.TokenConsumerConfig classes.

See Also:
IDAssertionUsernameTokenConsumer, LTPATokenConsumer, UsernameTokenConsumer, X509TokenConsumer, Constants, TokenConsumerConfig

Method Summary
 
Methods inherited from interface com.ibm.ws.webservices.wssecurity.WSSConsumerComponent
invoke
 
Methods inherited from interface com.ibm.ws.webservices.wssecurity.WSSComponent
init
 


IBM WebSphere Application ServerTM
Release 7