Package com.sun.identity.liberty.ws.common.wsse

Class BinarySecurityToken

  • public class BinarySecurityToken
extends Object
    The class BinarySecurityToken provides interface to parse and create X.509 Security Token depicted by Web Service Security : X.509 Certificate Token Profile and Liberty ID-WSF Security Mechanisms specifications.

    The following schema fragment specifies the expected content within the BinarySecurityToken object. 

     <element name="BinarySecurityToken" type="wsse:BinarySecurityTokenType/>
 <complexType name="BinarySecurityTokenType">
   <simpleContent>
     <extension base="<http://schemas.xmlsoap.org/ws/2003/06/secext>EncodedString">
       <attribute name="ValueType" type="{http://www.w3.org/2001/XMLSchema}QName" />
     </extension>
   </simpleContent>
 </complexType>
 <xsd:complexType name="EncodedString">
   <xsd:simpleContent>
     <xsd:extension base="wsse:AttributedString">
       <xsd:attribute name="EncodingType" type="xsd:QName"/>
     </xsd:extension>
   </xsd:simpleContent>
 </xsd:complexType>
 <xsd:complexType name="AttributedString">
   <xsd:simpleContent>
     <xsd:extension base="xsd:string">
       <xsd:attribute ref="wsu:Id"/>
         <xsd:anyAttribute namespace="##other" processContents="lax"/>
     </xsd:extension>
   </xsd:simpleContent>
 </xsd:complexType>

    • Field Detail

      • X509V3

        public static final QName X509V3
        The X509V3 value type indicates that the value name given corresponds to a X509 Certificate.

      • KERBEROSV5TGT

        public static final QName KERBEROSV5TGT
        The KERBEROSV5TGT value type indicates that the value name given corresponds to a Kerberos V5 TGT.

      • KERBEROSV5ST

        public static final QName KERBEROSV5ST
        The KERBEROSV5ST value type indicates that the value name given corresponds to a Kerberos V5 service ticket.

      • PKCS7

        public static final QName PKCS7
        The PKCS7 value type indicates that the value name given corresponds to a PKCS7 object.

      • PKIPath

        public static final QName PKIPath
        The PKIPATH value type indicates that the value name given corresponds to a PKI Path object.

      • BASE64BINARY

        public static final QName BASE64BINARY
        The BASE64BINARY encoding type indicates that the encoding name given corresponds to base64 encoding of a binary value.

      • HEXBINARY

        public static final QName HEXBINARY
        The HEXBINARY encoding type indicates that the encoding name given corresponds to Hex encoding of a binary value.

    • Constructor Detail

      • BinarySecurityToken

        public BinarySecurityToken​(String value,
                           QName valueType,
                           QName encodingType)
                    throws Exception
        Constructor.
        Parameters:
        value - the value must be the specified valueType and encoded in the specified encodingType.
        valueType - type of the value
        encodingType - encoding type of the value
        Throws:
        Exception - if any input parameter is null

      • BinarySecurityToken

        public BinarySecurityToken​(Element token)
                    throws Exception
        Constructor.
        Parameters:
        token - Binary Security Token Element
        Throws:
        Exception - if token Element is not a valid binary security token

    • Method Detail

      • getEncodingType

        public QName getEncodingType()
        Gets encoding type for the token.
        Returns:
        encoding type for the token.

      • getValueType

        public QName getValueType()
        Gets value type for the token.
        Returns:
        value type for the token.

      • getId

        public String getId()
        Gets id attribute for the tokens.
        Returns:
        id attribute for the token.

      • getTokenValue

        public String getTokenValue()
        Gets value of the token.
        Returns:
        value of the token.

      • toString

        public String toString()
        Returns a String representation of the token.
        Overrides:
        toString in class Object
        Returns:
        A string containing the valid XML for this element

      • addToParent

        public void addToParent​(Element headerE)
                 throws Exception
        Adds th binary security token to the header element.
        Parameters:
        headerE - the security header element.
        Throws:
        Exception - if there is a failure in adding to the header.

      • getWSFVersion

        public String getWSFVersion()
        Returns the web services version.
        Returns:
        the web services version.

      • setWSFVersion

        public void setWSFVersion​(String version)
        Sets the web services version.
        Parameters:
        version - the web services version.