Package org.apache.ws.security.message

Class WSSecUsernameToken

  • public class WSSecUsernameToken
extends WSSecBase
    Builds a WS UsernameToken. Refer to the WS specification, UsernameToken profile
    Author:
    Werner Dittmann (werner@apache.org).

    • Constructor Detail

      • WSSecUsernameToken

        public WSSecUsernameToken()
        Constructor.

    • Method Detail

      • setPasswordType

        public void setPasswordType​(java.lang.String pwType)
        Defines how to construct the password element of the UsernameToken.
        Parameters:
        pwType - contains the password type. Only allowed values are WSConstants.PASSWORD_DIGEST and WSConstants.PASSWORD_TEXT.

      • addNonce

        public void addNonce()
        Add a Nonce element to the UsernameToken.

      • addCreated

        public void addCreated()
        Add a Created element to the UsernameToken.

      • getSecretKey

        public byte[] getSecretKey()
        Get the derived secret key. After the prepare() method was called use this method to compute a derived secret key. The generation of this secret key is according to WS-Trust specification.
        Returns:
        Return the derived secret key of this token or null if prepare() was not called before.

      • getId

        public java.lang.String getId()
        Get the id generated during prepare(). Returns the the value of wsu:Id attribute of this UsernameToken.
        Returns:
        Return the wsu:Id of this token or null if prepare() was not called before.

      • prepare

        public void prepare​(org.w3c.dom.Document doc)
        Creates a Username token. The method prepares and initializes a WSSec UsernameToken structure after the relevant information was set. A Before calling prepare() all parameters such as user, password, passwordType etc. must be set. A complete UsernameToken is constructed.
        Parameters:
        doc - The SOAP enevlope as W3C document

      • prependToHeader

        public void prependToHeader​(WSSecHeader secHeader)
        Prepends the UsernameToken element to the elements already in the Security header. The method can be called any time after prepare(). This allows to insert the UsernameToken element at any position in the Security header.
        Parameters:
        secHeader - The security header that holds the Signature element.

      • appendToHeader

        public void appendToHeader​(WSSecHeader secHeader)
        Appends the UsernameToken element to the elements already in the Security header. The method can be called any time after prepare(). This allows to insert the UsernameToken element at any position in the Security header.
        Parameters:
        secHeader - The security header that holds the Signature element.

      • build

        public org.w3c.dom.Document build​(org.w3c.dom.Document doc,
                                  WSSecHeader secHeader)
        Adds a new UsernameToken to a soap envelope. Before calling build() all parameters such as user, password, passwordType etc. must be set. A complete UsernameToken is constructed and added to the wsse:Security header.
        Parameters:
        doc - The SOAP enevlope as W3C document
        secHeader - The security header inside the SOAP envelope
        Returns:
        Document with UsernameToken added

      • getUsernameTokenElement

        public org.w3c.dom.Element getUsernameTokenElement()
        Returns the UsernameToken element. The method can be called any time after prepare(). This allows to insert the UsernameToken element at any position in the Security header.
        Returns: