com.ibm.wsspi.wssecurity.token

Class X509TokenConsumer

  • java.lang.Object
    • com.ibm.wsspi.wssecurity.token.X509TokenConsumer
  • All Implemented Interfaces:
    com.ibm.ws.webservices.wssecurity.WSSComponent, com.ibm.ws.webservices.wssecurity.WSSConsumerComponent, Initializable, TokenConsumerComponent


    public class X509TokenConsumer
    extends java.lang.Object
    implements TokenConsumerComponent
    Consumes the X509 binary security token from the SOAP message and stores it into the Subject of the current thread for the later use. It also creates a WSSAuthToken for later use in the WebSphere login process by WSSConsumerComponent.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void init(java.util.Map map)
      Initializes this consumer with a TokenConsumerConfig object which is passed in by the map parameter.
      void invoke(org.w3c.dom.Node target, java.util.Map context)
      Consumes the X509 binary security token in a SOAP message.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • X509TokenConsumer

        public X509TokenConsumer()
    • Method Detail

      • init

        public void init(java.util.Map map)
                  throws SoapSecurityException
        Initializes this consumer with a TokenConsumerConfig 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 TokenConsumerConfig object is stored with a key of TokenConsumerConfig.CONFIG_KEY.
        Throws:
        SoapSecurityException - When there is a problem initializing the consumer
        See Also:
        Initializable.init(java.util.Map), TokenConsumerConfig
      • invoke

        public void invoke(org.w3c.dom.Node target,
                  java.util.Map context)
                    throws SoapSecurityException
        Consumes the X509 binary security token in a SOAP message. Responsible for processing an X509 token specified by the target parameter. The X509TokenLoginModule will create an X509Token object and set in into the Subject of the current thread. It also creates a WSSAuthToken if authentication is required with this token.
        Specified by:
        invoke in interface com.ibm.ws.webservices.wssecurity.WSSConsumerComponent
        Parameters:
        target - The element to be consumed or the Document object
        context - A Map object which contains necessary name-value pairs, such as a Subject object.
        Throws:
        SoapSecurityException - When there is a problem during consuming the X509 binary security token
        See Also:
        WSSConsumerComponent.invoke(org.w3c.dom.Node, java.util.Map)
IBM WebSphere Application ServerTM
Release 9.0