com.ibm.wsspi.wssecurity.trust.config

Interface ConsumerConfig.RSTR

  • Enclosing interface:
    ConsumerConfig


    public static interface ConsumerConfig.RSTR
    ConsumerConfig.RSTR contains keys to the properies map contained within a SecurityToken. These keys provide access to the contents of the RequestSecurityTokenResponse message returned from a Security Token Service (STS) in response to the WSSTrustClient's RequestSecurityToken.

    NOTE: By default the security token's property map is not populated. ProviderConfig.setIncludeRSTRProperties(boolean) must be set true for this map to be populated.

    Example use:

     String wstNamespace = "http://schemas.xmlsoap.org/ws/2005/02/trust";
      
    List<SecurityToken> securityTokens = null;
    try {
       ProviderConfig providerConfig = WSSTrustClient.newProviderConfig(wstNamespace, "http://www.ibm.com:9080/SecurityTokenService");
       providerConfig.setIncludeRSTRproperties(true);
       WSSTrustClient client = WSSTrustClient.getInstance(providerConfig);
    
       RequesterConfig requestConfig = WSSTrustClient.newRequesterConfig(wstNamespace);
    
       requestConfig.setSOAPNamespace("http://schemas.xmlsoap.org/soap/envelope/");
       requestConfig.put(RequesterConfiguration.RSTT.TOKENTYPE, "http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1");
    
       securityTokens = client.issue(providerConfig, requestConfig);
    
    } catch (Throwable e) {
       e.printStackTrace();
    }
    
    GenericSecurityToken token = null;
    if (SecuirtyTokens != null)
       token = (GenericSecurityToken) (securityTokens.get(0));
    
    Map properties = null;
    if (token != null)
       properties = token.getProperties();
     
    XMLStructure xmlRSTR = null;
    if (properties != null) 
       xmlRSTR = (XMLStructure)properties.get(ConsumerConfig.RSTR.REQUESTSECURITYTOKENRESPONSEXML);
    
    if (xmlRSTR != null) 
       System.out.println("RSTR: " + ((OMStructure) xmlRSTR).getNode();
    
     
    The example will print the RequestSecurityTokenResponse returned from the STS. Similarly certain items within the RSTR may be accessed by referencing other keys listed in ConsumerConfig.RSTR.

    For example if the TokenType was returned in the RSTR by the STS then it can be accessed either through the RSTR displayed above or by directly retrieving TOKENTYPE from the SecurityToken's properties Map.

    For Example:

     String tokenType = null;
    if (properties != null) 
       tokenType = (XMLStructure)properties.get(ConsumerConfig.RSTR.TOKENTYPE);
    
      
    Some entries in the RSTR may reference tokens included in the SOAP Envelope's Security Header. For these cases the intact RSTR includes the token's id, not the actual token in the Security Header. However the specific ConsumerConfig.RSTR key for that element includes the dereferenced token from the SecurityHeader in place of the token's id.

    For example, if the RSTR returned from the STS includes a wst:ProofEncryption element and that element references a token in the Security Header, the returned SOAP envelope may look something like:

     <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
       xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wscoor="http://schemas.xmlsoap.org/ws/2004/10/wscoor"
       xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
       <soapenv:Header>
          <wsat-ext:imported xmlns:wsat-ext="http://www.ibm.com/ws-tx/wsat/2007/12" />
          <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous
          </wsa:To>
          <wsse:Security
             xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:BinarySecurityToken wsu:Id="requestProofToken"
                ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1">MIIEZzCCA9CgAwIBAgIQEmtJZc0</wsse:BinarySecurityToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <wst:RequestSecurityTokenResponse
             xmlns:wst="http://schemas.xmlsoap.org/ws/2005/02/trust"
             xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
             wsu:Id="uuidc8b3389d-0123-1e5d-8de4-fc57a42b21a1">
          <wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1
          </wst:TokenType>
          <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
             xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
             <wsa:EndpointReference>
                <wsa:Address>rst_saml1x_wst12</wsa:Address>
             </wsa:EndpointReference>
          </wsp:AppliesTo> 
          <wst:ProofEncryption>
             <wsse:Reference
                xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
                URI="#requestProofToken" />
             </wst:ProofEncryption>
          </wst:RequestSecurityTokenResponse>
       </soapenv:Body>
    </soapenv:Envelope>
     
    For this example the RSTR retrieved from the SecurityToken's properties map would be accessed by:

    XMLStructure xmlRSTR = (XMLStructure)properties.get(ConsumerConfig.RSTR.REQUESTSECURITYTOKENRESPONSEXML);

    and the contents would be similar to:

      <wst:RequestSecurityTokenResponse
       xmlns:wst="http://schemas.xmlsoap.org/ws/2005/02/trust"
       xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
       wsu:Id="uuidc8b3389d-0123-1e5d-8de4-fc57a42b21a1">
       <wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1
       </wst:TokenType>
       <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
          xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
          <wsa:EndpointReference>
             <wsa:Address>rst_saml1x_wst12</wsa:Address>
          </wsa:EndpointReference>
       </wsp:AppliesTo>
       <wst:ProofEncryption>
          <wsse:Reference
             xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
             URI="#requestProofToken" />
       </wst:ProofEncryption>
    </wst:RequestSecurityTokenResponse>
     
    Also the contents of ProofEncryption retrieved from the SecurityToken's properties will have the Reference element replaced with the token it references in the Security Header The entry in the properties Map would be accessed by:

     XMLStructure xmlRSTR = (XMLStructure)properties..get(ConsumerConfig.RSTR.PROOFENCRYPTIONXML);
      
      
    and the contents would be similar to:

      <wst:ProofEncryption>
       <wsse:BinarySecurityToken wsu:Id="requestProofToken" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
          ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1">MIIEZzCCA9CgAwIBAgIQEmtJZc0</wsse:BinarySecurityToken>
    </wst:ProofEncryption>
     
    NOTES:

    The SOAP Envelope's SOAP Header element is not available in a SecurityToken's properties map.

    If the STS returns a RequesteSecurityTokenResponseCollection (RSTRC), the individual RequestSecurityTokenResponse (RSTR) elements within the RSTRC are accessible in the SecurityTokens's properties Map.

    Data associated with the keys listed in ConsumerConfig.RSTR have been parsed from the STS response. The RSTR may contain other elements not in this list. Access and parse the RSTR to retrieve these elements.

    The value associated with each key may be a String, Integer, Boolean, Date, XMLStructure, or otherwise as documented.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ALLOWPOSTDATING
      Contents of the AllowPostdating element.
      static java.lang.String APPLIESTO_ADDRESS
      Contents of the AppliesTo element's EndpontReference's child element's Address child element.
      static java.lang.String APPLIESTO_PORTTYPE
      Contents of the AppliesTo element's EndpontReference's child element's PortType child element.
      static java.lang.String APPLIESTO_SERVICENAME
      Contents of the AppliesTo element's EndpontReference's child element's ServiceName child element.
      static java.lang.String AUTHENTICATIONTYPE
      Contents of the AuthenticationType element.
      static java.lang.String CANONICALIZATIONALGORITHM
      Contents of the CanonicalizationAlgorithm element.
      static java.lang.String DELEGATABLE
      Contents of the Delegatable element.
      static java.lang.String ENCRYPTIONALGORITHM
      Contents of the EncryptionAlgorithm element.
      static java.lang.String ENCRYPTIONXML
      Contents of the Encryption element.
      static java.lang.String ENCRYPTWITH
      Contents of the EncryptWith element.
      static java.lang.String ENTROPY_BINARYSECRET
      Contents of the Entropy element's BinarySecret child element.
      static java.lang.String FORWARDABLE
      Contents of the Forwardable element.
      static java.lang.String ISSUER_ADDRESS
      Contents of the Issuer element Address child element.
      static java.lang.String ISSUER_PORTTYPE
      Contents of the Issuer element PortType child element.
      static java.lang.String ISSUER_SERVICENAME
      Contents of the Issuer element ServiceName child element.
      static java.lang.String KEYSIZE
      Contents of the KeySize element.
      static java.lang.String KEYTYPE
      Contents of the KeyType element.
      static java.lang.String LIFETIME_CREATED
      Contents of the LifeTime element's Created child element.
      static java.lang.String LIFETIME_EXPIRES
      Contents of the LifeTime element's Expires child element.
      static java.lang.String PROOFENCRYPTIONXML
      Contents of the ProofEncryption element.
      static java.lang.String RENEWING_ALLOW
      Contents of the Renewing elemnt's Allow attribute.
      static java.lang.String RENEWING_OK
      Contents of the Renewing elemnt's OK attribute.
      static java.lang.String REQUESTEDATTACHEDREFERENCEXML
      Contents of the RequestedAttachedReference element.
      static java.lang.String REQUESTEDPROOFTOKENXML
      Contents of the RequestedProofToken element.
      static java.lang.String REQUESTEDUNATTACHEDREFERENCEXML
      Contents of the RequestedUnattachedReference element.
      static java.lang.String REQUESTSECURITYTOKENRESPONSEXML
      Contents of the RequestSecurityTokenResponse element.
      static java.lang.String REQUESTTYPE
      Contents of the RequestType element.
      static java.lang.String SIGNATUREALGORITHM
      Contents of the SignatureAlgorithm element.
      static java.lang.String SIGNWITH
      Contents of the SignWith element.
      static java.lang.String STATUS_CODE
      Contents of the Status element's Code child element.
      static java.lang.String STATUS_REASON
      Contents of the Status element's Reason child element.
      static java.lang.String TOKENTYPE
      Contents of the TokenType element.
    • Field Detail

      • ALLOWPOSTDATING

        static final java.lang.String ALLOWPOSTDATING
        Contents of the AllowPostdating element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:AllowPostdating/>
        The corresponding Boolean value in the SecurityToken's properties Map would be: true

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • APPLIESTO_ADDRESS

        static final java.lang.String APPLIESTO_ADDRESS
        Contents of the AppliesTo element's EndpontReference's child element's Address child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
           xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
           <wsa:EndpointReference>
              <wsa:Address>http:\\www.ibm.com</wsa:Address>
              <wsa:PortType>http:\\myporttype</wsa:PortType>
              <wsa:ServiceName>MyServiceName</wsa:ServiceName>
           </wsa:EndpointReference>
        </wsp:AppliesTo>
        
        The corresponding String value in the SecurityToken's properties Map would be: http:\\www.ibm.com

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • APPLIESTO_PORTTYPE

        static final java.lang.String APPLIESTO_PORTTYPE
        Contents of the AppliesTo element's EndpontReference's child element's PortType child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
           xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
           <wsa:EndpointReference>
              <wsa:Address>http:\\www.ibm.com</wsa:Address>
              <wsa:PortType>http:\\myporttype</wsa:PortType>
              <wsa:ServiceName>MyServiceName</wsa:ServiceName>
           </wsa:EndpointReference>
        </wsp:AppliesTo>
         
        The corresponding String value in the SecurityToken's properties Map would be: http:\\myporttype

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • APPLIESTO_SERVICENAME

        static final java.lang.String APPLIESTO_SERVICENAME
        Contents of the AppliesTo element's EndpontReference's child element's ServiceName child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
           xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
           <wsa:EndpointReference>
              <wsa:Address>http:\\www.ibm.com</wsa:Address>
              <wsa:PortType>http:\\myporttype</wsa:PortType>
              <wsa:ServiceName>MyServiceName</wsa:ServiceName>
           </wsa:EndpointReference>
        </wsp:AppliesTo>
         
        The corresponding String value in the SecurityToken's properties Map would be: MyServiceName

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • AUTHENTICATIONTYPE

        static final java.lang.String AUTHENTICATIONTYPE
        Contents of the AuthenticationType element.
        This key corresponds to a property value of type String

        For the example RSTR element:
        <wst:AuthenticationType>http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey</wst:AuthenticationType>

        The corresponding String value in the SecurityToken's properties Map would be:
        http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • CANONICALIZATIONALGORITHM

        static final java.lang.String CANONICALIZATIONALGORITHM
        Contents of the CanonicalizationAlgorithm element.
        This key corresponds to a property value of type String

        For the example RSTR element:
        <wst:CanonicalizationAlgorithm>http://www.w3.org/2001/10/xml-exc-c14n#</wst:CanonicalizationAlgorithm>

        The corresponding String value in the SecurityToken's properties Map would be: http://www.w3.org/2001/10/xml-exc-c14n#

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • DELEGATABLE

        static final java.lang.String DELEGATABLE
        Contents of the Delegatable element.
        This key corresponds to a property value of type Boolean

        For the example RSTR element: <wst:Delegatable>true</wst:Delegatable>

        The corresponding Boolean value in the SecurityToken's properties Map would be: true

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ENCRYPTIONALGORITHM

        static final java.lang.String ENCRYPTIONALGORITHM
        Contents of the EncryptionAlgorithm element.
        This key corresponds to a property value of type String

        For the example RSTR element:
        <wst:EncryptionAlgorithm>http://www.w3.org/2001/04/xmlenc#aes128-cbc</wst:EncryptionAlgorithm>
        The corresponding String value in the SecurityToken's properties Map would be: http://www.w3.org/2001/04/xmlenc#aes128-cbc

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ENCRYPTIONXML

        static final java.lang.String ENCRYPTIONXML
        Contents of the Encryption element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:Encryption>
           <wsse:BinarySecurityToken wsu:Id="requestProofToken" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
              ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"> MIIEZzCCA9CgAwIBAgIQEmtJZc0 </wsse:BinarySecurityToken>
        </wst:Encryption>
         
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:Encryption>
           <wsse:BinarySecurityToken wsu:Id="requestProofToken" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
              ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"> MIIEZzCCA9CgAwIBAgIQEmtJZc0 </wsse:BinarySecurityToken>
        </wst:Encryption>
          
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • ENCRYPTWITH

        static final java.lang.String ENCRYPTWITH
        Contents of the EncryptWith element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:EncrypWith>http://www.w3.org/2001/04/xmlenc#aes128-cbc</wst:EncryptWith>
        The corresponding value in the SecurityToken's properties Map would be: http://www.w3.org/2001/04/xmlenc#aes128-cbc

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ENTROPY_BINARYSECRET

        static final java.lang.String ENTROPY_BINARYSECRET
        Contents of the Entropy element's BinarySecret child element.
        This key corresponds to a property value of type byte[]

        For the example RSTR element:

        <wst:Entropy> 
           <wst:BinarySecret>MIIEZzCCA9CgAwIBAgIQEmtJZc0b</wst:BinarySecret> 
        </wst:Entropy> 
         
        The corresponding byte[] values in the SecurityToken's properties Map would be:
        {{48}{-126}{4}{103}{48}{-126}{3}{-48}{-96}{3}{2}{1}{2}{2}{16}{18}{107}{73}}

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • FORWARDABLE

        static final java.lang.String FORWARDABLE
        Contents of the Forwardable element.
        This key corresponds to a property value of type Boolean

        For the example RSTR element: <wst:Forwardable>true</wst:Forwardable>
        The corresponding Boolean value in the SecurityToken's properties Map would be: true

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ISSUER_ADDRESS

        static final java.lang.String ISSUER_ADDRESS
        Contents of the Issuer element Address child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wst:Issuer>
           <wsa:Address>http:\\www.ibm.com</wsa:Address>
           <wsa:PortType>http:\\myporttype</wsa:PortType>
           <wsa:ServiceName>MyServiceName</wsa:ServiceName>
        </wst:Issuer>
         
        The corresponding String value in the SecurityToken's properties Map would be: http:\\www.ibm.com

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ISSUER_PORTTYPE

        static final java.lang.String ISSUER_PORTTYPE
        Contents of the Issuer element PortType child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wst:Issuer>
           <wsa:Address>http:\\www.ibm.com</wsa:Address>
           <wsa:PortType>http:\\myporttype</wsa:PortType>
           <wsa:ServiceName>MyServiceName</wsa:ServiceName>
        </wst:Issuer>
         
        The corresponding value in the SecurityToken's properties Map would be: http:\\myporttype

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • ISSUER_SERVICENAME

        static final java.lang.String ISSUER_SERVICENAME
        Contents of the Issuer element ServiceName child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

        <wst:Issuer>
           <wsa:Address>http:\\www.ibm.com</wsa:Address>
           <wsa:PortType>http:\\myporttype</wsa:PortType>
           <wsa:ServiceName>MyServiceName</wsa:ServiceName>
        </wst:Issuer>
         
        The corresponding value in the SecurityToken's properties Map would be: MyServiceName

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • KEYSIZE

        static final java.lang.String KEYSIZE
        Contents of the KeySize element.
        This key corresponds to a property value of type Integer

        For the example RSTR element: <wst:KeySize>128</wst:KeySize>
        The corresponding Integer value in the SecurityToken's properties Map would be: 128

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • KEYTYPE

        static final java.lang.String KEYTYPE
        Contents of the KeyType element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:KeyType>http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey</wst:KeyType>
        The corresponding String value in the SecurityToken's properties Map would be: http://docs.oasis-open.org/ws-sx/ws-trust/200512/PublicKey

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • LIFETIME_CREATED

        static final java.lang.String LIFETIME_CREATED
        Contents of the LifeTime element's Created child element.
        This key corresponds to a property value of type Date

        For the example RSTR element:

        <wst:Lifetime>
           <wsu:Created xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">2008-09-15T18:35:32.766Z</wsu:Created>
           <wsu:Expires xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">2008-09-15T20:35:32.766Z</wsu:Expires>
        </wst:Lifetime>
          
        The corresponding Date value in the SecurityToken's properties Map would be: 2008-09-15T18:35:32.766Z

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • LIFETIME_EXPIRES

        static final java.lang.String LIFETIME_EXPIRES
        Contents of the LifeTime element's Expires child element.
        This key corresponds to a property value of type Date

        For the example RSTR element:

         <wst:Lifetime>
           <wsu:Created xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">2008-09-15T18:35:32.766Z</wsu:Created>
           <wsu:Expires xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\">2008-09-15T20:35:32.766Z</wsu:Expires>
        </wst:Lifetime>
         
        The corresponding Date value in the SecurityToken's properties Map would be: 2008-09-15T20:35:32.766Z

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • PROOFENCRYPTIONXML

        static final java.lang.String PROOFENCRYPTIONXML
        Contents of the ProofEncryption element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:ProofEncryption>
           <wsse:BinarySecurityToken wsu:Id="requestProofToken" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
              ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"> MIIEZzCCA9CgAwIBAgIQEmtJZc0 </wsse:BinarySecurityToken>
        </wst:ProofEncryption>
         
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:ProofEncryption>
           <wsse:BinarySecurityToken wsu:Id="requestProofToken" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
              ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1"> MIIEZzCCA9CgAwIBAgIQEmtJZc0 </wsse:BinarySecurityToken>
        </wst:ProofEncryption>
         
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • RENEWING_ALLOW

        static final java.lang.String RENEWING_ALLOW
        Contents of the Renewing elemnt's Allow attribute.
        This key corresponds to a property value of type Boolean

        For the example RSTR element: <wst:Renewing Allow="true" OK="true"/>
        The corresponding Boolean value in the SecurityToken's properties Map would be: true

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • RENEWING_OK

        static final java.lang.String RENEWING_OK
        Contents of the Renewing elemnt's OK attribute.
        This key corresponds to a property value of type Boolean

        For the example RSTR element: <wst:Renewing Allow="true" OK="true"/>
        The corresponding Boolean value in the SecurityToken's properties Map would be: true

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • REQUESTEDATTACHEDREFERENCEXML

        static final java.lang.String REQUESTEDATTACHEDREFERENCEXML
        Contents of the RequestedAttachedReference element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:RequestedAttachedReference>
           <wsse:SecurityTokenReference xmlns:wsse="...">
              <wsse:Reference URI="urn:fabrikam123:5445"/>
           </wsse:SecurityTokenReference>
        </wst:RequestedAttachedReference>
         
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:RequestedAttachedReference>
           <wsse:SecurityTokenReference xmlns:wsse="...">
              <wsse:Reference URI="urn:fabrikam123:5445"/>
           </wsse:SecurityTokenReference>
        </wst:RequestedAttachedReference>
          
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • REQUESTEDPROOFTOKENXML

        static final java.lang.String REQUESTEDPROOFTOKENXML
        Contents of the RequestedProofToken element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:RequestedProofToken xmlns:wst=\"http://docs.oasis-open.org/ws-sx/ws-trust/200512\"> 
           <wss:UsernameToken xmlns:wss=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\" wsu:Id=\"usernameac39d715-0123-19d7-a926-9d6bd9a2f0bb\"> 
              <wss:Username>testuser</wss:Username> 
              <wss:Nonce EncodingType=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary\">GgCG/gPHgxRozesLqAubeQ==</wss:Nonce> 
              <wsu:Created>2009-09-12T03:09:14Z</wsu:Created> 
           </wss:UsernameToken> 
        </wst:RequestedProofToken>
         
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:RequestedProofToken xmlns:wst=\"http://docs.oasis-open.org/ws-sx/ws-trust/200512\"> 
           <wss:UsernameToken xmlns:wss=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:wsu=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd\" wsu:Id=\"usernameac39d715-0123-19d7-a926-9d6bd9a2f0bb\"> 
              <wss:Username>testuser</wss:Username> 
              <wss:Nonce EncodingType=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary\">GgCG/gPHgxRozesLqAubeQ==</wss:Nonce> 
              <wsu:Created>2009-09-12T03:09:14Z</wsu:Created> 
           </wss:UsernameToken> 
        </wst:RequestedProofToken>
          
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • REQUESTEDUNATTACHEDREFERENCEXML

        static final java.lang.String REQUESTEDUNATTACHEDREFERENCEXML
        Contents of the RequestedUnattachedReference element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:RequestedUnattachedReference xmlns:wst="http://docs.oasis-open.org/ws-sx/ws-trust/200512" xmlns:wss="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"> 
           <wss:SecurityTokenReference> 
           <wss:Reference URI="#usernameac39d715-0123-19d7-a926-9d6bd9a2f0bb" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#UsernameToken"></wss:Reference> 
           </wss:SecurityTokenReference> 
        </wst:RequestedUnattachedReference>
          
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:RequestedUnattachedReference xmlns:wst="http://docs.oasis-open.org/ws-sx/ws-trust/200512" xmlns:wss="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"> 
           <wss:SecurityTokenReference> 
           <wss:Reference URI="#usernameac39d715-0123-19d7-a926-9d6bd9a2f0bb" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#UsernameToken"></wss:Reference> 
           </wss:SecurityTokenReference> 
        </wst:RequestedUnattachedReference>
          
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • REQUESTSECURITYTOKENRESPONSEXML

        static final java.lang.String REQUESTSECURITYTOKENRESPONSEXML
        Contents of the RequestSecurityTokenResponse element.
        This key corresponds to a property value of type XMLStructure

        For the example RSTR element:

         <wst:RequestSecurityTokenResponse
           xmlns:wst="http://schemas.xmlsoap.org/ws/2005/02/trust"
           xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
           wsu:Id="uuidc8b3389d-0123-1e5d-8de4-fc57a42b21a1">
           <wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1
           </wst:TokenType>
           <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
              xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
              <wsa:EndpointReference>
                 <wsa:Address>rst_saml1x_wst12</wsa:Address>
              </wsa:EndpointReference>
           </wsp:AppliesTo>
           <wst:ProofEncryption>
              <wsse:Reference
                 xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
                 URI="#requestProofToken" />
           </wst:ProofEncryption>
        </wst:RequestSecurityTokenResponse>
         
        The corresponding value in the SecurityToken's properties Map would be:
         <wst:RequestSecurityTokenResponse
           xmlns:wst="http://schemas.xmlsoap.org/ws/2005/02/trust"
           xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
           wsu:Id="uuidc8b3389d-0123-1e5d-8de4-fc57a42b21a1">
           <wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1
           </wst:TokenType>
           <wsp:AppliesTo xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
              xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
              <wsa:EndpointReference>
                 <wsa:Address>rst_saml1x_wst12</wsa:Address>
              </wsa:EndpointReference>
           </wsp:AppliesTo>
           <wst:ProofEncryption>
              <wsse:Reference
                 xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
                 URI="#requestProofToken" />
           </wst:ProofEncryption>
        </wst:RequestSecurityTokenResponse>
         
        If the element was not included in the RSTR then the value will be null.
        See Also:
        Constant Field Values
      • REQUESTTYPE

        static final java.lang.String REQUESTTYPE
        Contents of the RequestType element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:RequestType>http://schemas.xmlsoap.org/ws/2005/02/trust/Issue</wst:RequestType>
        The corresponding value in the SecurityToken's properties Map would be: http://schemas.xmlsoap.org/ws/2005/02/trust/Issue

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • SIGNATUREALGORITHM

        static final java.lang.String SIGNATUREALGORITHM
        Contents of the SignatureAlgorithm element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:SignatureAlgorithm>http://www.w3.org/2000/09/xmldsig#rsa-sha1</wst:SignatureAlgorithm>
        The corresponding value in the SecurityToken's properties Map would be: http://www.w3.org/2000/09/xmldsig#rsa-sha1

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • SIGNWITH

        static final java.lang.String SIGNWITH
        Contents of the SignWith element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:SignWith>http://www.w3.org/2000/09/xmldsig#rsa-sha1</wst:SignWith>
        The corresponding value in the SecurityToken's properties Map would be: http://www.w3.org/2000/09/xmldsig#rsa-sha1

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • STATUS_CODE

        static final java.lang.String STATUS_CODE
        Contents of the Status element's Code child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

         <wst:Status> 
           <wst:Code>http://docs.oasis-open.org/ws-sx/ws-trust/200512/status/valid</wst:Code>  
           <wst:Reason>Reason for status code.</wst:Reason> 
        </wst:Status>
          
        The corresponding value in the SecurityToken's properties Map would be: http://docs.oasis-open.org/ws-sx/ws-trust/200512/status/valid

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • STATUS_REASON

        static final java.lang.String STATUS_REASON
        Contents of the Status element's Reason child element.
        This key corresponds to a property value of type String

        For the example RSTR element:

         <wst:Status> 
           <wst:Code>http://docs.oasis-open.org/ws-sx/ws-trust/200512/status/valid</wst:Code>  
           <wst:Reason>Reason for status code.</wst:Reason> 
        </wst:Status>
          
        The corresponding value in the SecurityToken's properties Map would be: Reason for status code.

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
      • TOKENTYPE

        static final java.lang.String TOKENTYPE
        Contents of the TokenType element.
        This key corresponds to a property value of type String

        For the example RSTR element: <wst:TokenType>http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1 </wst:TokenType>
        The corresponding value in the SecurityToken's properties Map would be: http://docs.oasis-open.org/wss/oasis-wss-saml-token-profile-1.1#SAMLV1.1

        If the element was not included in the RSTR then the value will be null.

        See Also:
        Constant Field Values
IBM WebSphere Application ServerTM
Release 9.0