Package org.apache.ws.security.message.token

Class SecurityContextToken

  • public class SecurityContextToken
extends java.lang.Object
    Version:
    1.0
    Author:
    Ruchith Fernando

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.w3c.dom.Element element
      Security context token element
      protected org.w3c.dom.Element elementIdentifier
      Identifier element

    • Constructor Summary

      Constructors 
      Constructor Description
      SecurityContextToken​(int version, org.w3c.dom.Document doc)
      Constructor to create the SCT
      SecurityContextToken​(int version, org.w3c.dom.Document doc, java.lang.String uuid)
      Constructor to create the SCT with a given uuid
      SecurityContextToken​(org.w3c.dom.Document doc)
      Constructor to create the SCT
      SecurityContextToken​(org.w3c.dom.Document doc, java.lang.String uuid)
      Constructor to create the SCT with a given uuid
      SecurityContextToken​(org.w3c.dom.Element elem)
      This is used to create a SecurityContestToken using a DOM Element

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.w3c.dom.Element getElement()
      Returns the dom element of this SecurityContextToken object.
      java.lang.String getID()
      Gets the id.
      java.lang.String getIdentifier()
      Get the identifier.
      void setElement​(org.w3c.dom.Element elem)  
      void setID​(java.lang.String id)
      Set the id of this security context token.
      void setIdentifier​(org.w3c.dom.Document doc, java.lang.String uuid)
      Set the identifier.
      java.lang.String toString()
      Returns the string representation of the token.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • element

        protected org.w3c.dom.Element element
        Security context token element

      • elementIdentifier

        protected org.w3c.dom.Element elementIdentifier
        Identifier element

    • Constructor Detail

      • SecurityContextToken

        public SecurityContextToken​(org.w3c.dom.Document doc)
                     throws org.apache.ws.security.conversation.ConversationException
        Constructor to create the SCT
        Parameters:
        doc -
        Throws:
        org.apache.ws.security.conversation.ConversationException

      • SecurityContextToken

        public SecurityContextToken​(org.w3c.dom.Document doc,
                            java.lang.String uuid)
                     throws org.apache.ws.security.conversation.ConversationException
        Constructor to create the SCT with a given uuid
        Parameters:
        doc -
        Throws:
        org.apache.ws.security.conversation.ConversationException

      • SecurityContextToken

        public SecurityContextToken​(int version,
                            org.w3c.dom.Document doc)
                     throws org.apache.ws.security.conversation.ConversationException
        Constructor to create the SCT
        Parameters:
        doc -
        Throws:
        org.apache.ws.security.conversation.ConversationException

      • SecurityContextToken

        public SecurityContextToken​(int version,
                            org.w3c.dom.Document doc,
                            java.lang.String uuid)
                     throws org.apache.ws.security.conversation.ConversationException
        Constructor to create the SCT with a given uuid
        Parameters:
        doc -
        Throws:
        org.apache.ws.security.conversation.ConversationException

      • SecurityContextToken

        public SecurityContextToken​(org.w3c.dom.Element elem)
                     throws WSSecurityException
        This is used to create a SecurityContestToken using a DOM Element
        Parameters:
        elem - The DOM element: The security context token
        Throws:
        WSSecurityException - If the element passed in in not a security context token

    • Method Detail

      • setIdentifier

        public void setIdentifier​(org.w3c.dom.Document doc,
                          java.lang.String uuid)
        Set the identifier.
        Parameters:
        name - sets a text node containing the identifier into the identifier element.

      • getIdentifier

        public java.lang.String getIdentifier()
        Get the identifier.
        Returns:
        the data from the identifier element.

      • setElement

        public void setElement​(org.w3c.dom.Element elem)

      • getElement

        public org.w3c.dom.Element getElement()
        Returns the dom element of this SecurityContextToken object.
        Returns:
        the wsse:UsernameToken element

      • toString

        public java.lang.String toString()
        Returns the string representation of the token.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a XML string representation

      • getID

        public java.lang.String getID()
        Gets the id.
        Returns:
        the value of the wsu:Id attribute of this SecurityContextToken

      • setID

        public void setID​(java.lang.String id)
        Set the id of this security context token.
        Parameters:
        id - the value for the wsu:Id attribute of this SecurityContextToken