IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.token
Class X509TokenGenerator

java.lang.Object
  extended by com.ibm.wsspi.wssecurity.token.X509TokenGenerator
All Implemented Interfaces:
com.ibm.ws.webservices.wssecurity.WSSComponent, com.ibm.ws.webservices.wssecurity.WSSGeneratorComponent, Initializable, TokenGeneratorComponent

public class X509TokenGenerator
extends java.lang.Object
implements TokenGeneratorComponent

Generates an X509 binary security token element into the SOAP message according to a given configuration. It also creates the X509Token object and stores in in the Subject of the current thread.


Field Summary
 
Fields inherited from interface com.ibm.wsspi.wssecurity.token.TokenGeneratorComponent
STANDALONE
 
Constructor Summary
X509TokenGenerator()
           
 
Method Summary
protected static org.w3c.dom.Element createTokenElement(org.w3c.dom.Document doc, org.w3c.dom.Element parent, javax.xml.namespace.QName valueType, java.lang.String binary, java.lang.String insertId, int wssVersion)
          Ceates BinarySecurityToken Element and insert it as a child of the parent
 void init(java.util.Map map)
          Initializes this generator with a TokenGeneratorConfig object which is passed in by the map parameter.
 void invoke(org.w3c.dom.Document doc, org.w3c.dom.Element parent, java.util.Map context)
          Generates a new X509 binary security token in a SOAP message and sets the token in the Subject of the current thread.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

X509TokenGenerator

public X509TokenGenerator()
Method Detail

init

public void init(java.util.Map map)
          throws SoapSecurityException
Initializes this generator with a TokenGeneratorConfig object which is passed in by the map parameter.

Specified by:
init in interface com.ibm.ws.webservices.wssecurity.WSSComponent
Specified by:
init in interface Initializable
Parameters:
map - A Map object which contains name-value pairs. These pairs includes a configuration object and <Property> elements in the configuration XMI files. In the map, the TokenGeneratorConfig object is stored with a key of TokenGeneratorConfig.CONFIG_KEY.
Throws:
SoapSecurityException - When there is a problem initializing the generator
See Also:
Initializable.init(java.util.Map), TokenGeneratorConfig

invoke

public void invoke(org.w3c.dom.Document doc,
                   org.w3c.dom.Element parent,
                   java.util.Map context)
            throws SoapSecurityException
Generates a new X509 binary security token in a SOAP message and sets the token in the Subject of the current thread.

Note that token generator processes only a single token at a time, i.e., those which matched the Token's Id and (possibly) its reference name given by its "parent" component (that invokes this token generator component), that are propagated throgh the local context. The generated token is added under the parent.

Specified by:
invoke in interface com.ibm.ws.webservices.wssecurity.WSSGeneratorComponent
Parameters:
doc - The Document object that includes a SOAP envelope
parent - The parent element that has the element to be generated
context - A Map object which contains necessary name-value pairs, such as a Subject object.
Throws:
SoapSecurityException - When there is a problem during generating a new X509 binary security token
See Also:
WSSGeneratorComponent.invoke(org.w3c.dom.Document, org.w3c.dom.Element, java.util.Map)

createTokenElement

protected static org.w3c.dom.Element createTokenElement(org.w3c.dom.Document doc,
                                                        org.w3c.dom.Element parent,
                                                        javax.xml.namespace.QName valueType,
                                                        java.lang.String binary,
                                                        java.lang.String insertId,
                                                        int wssVersion)
Ceates BinarySecurityToken Element and insert it as a child of the parent

Returns:
BST element

IBM WebSphere Application ServerTM
Release 7