com.ibm.websphere.wssecurity.wssapi.token

Interface DerivedKeyToken

All Superinterfaces:
SecurityToken

  1. public interface DerivedKeyToken
  2. extends SecurityToken
This interface is responsible for the derived key token <wsc:DerivedKeyToken> element.
It defined in the specification of WS-SecureConvesation.
This object is dereived from the SecurityContextToken object.
See Also:
SecurityContextToken, SecurityToken

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
PSHA1
The algorithm for the PSHA1: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
  1. static
  2. java.lang.String
PSHA1L128
The algorithm for the PSHA1_L128: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
  1. static
  2. java.lang.String
PSHA1L192
The algorithm for the PSHA1_L192: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
  1. static
  2. java.lang.String
PSHA1L256
The algorithm for the PSHA1_L256: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
  1. static
  2. javax.xml.namespace.QName
TokenQname
Represents the QName of this class, <wsu:DerivedKeyToken>.
  1. static
  2. javax.xml.namespace.QName
ValueType
Represents the value type.
Fields inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
DECRYPTING_KEY, ENCRYPTING_KEY, REF_EMBEDDED, REF_KEYID, REF_STR, REF_THUMBPRINT, SIGNING_KEY, VERIFING_KEY

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getAlgorithm()
Returns the key derivation algorithm.
  1. java.lang.String
getClientLabel()
Returns the client label.
  1. int
getLength()
Returns the length of the derived key.
  1. byte[]
getNonce()
Returns the nonce.
  1. int
getOffset()
Returns the offset of the byte stream to find the generated key.
  1. byte[]
getSecret()
Returns the secret is processed as octets representing their binary value.
  1. SecurityContextToken
getSecurityContextToken()
Retuens the SecurityContextToken in order to derive the key.
  1. java.lang.String
getSecurityContextTokenTokenUUID()
Gets the uuid of the related security context token.
  1. java.lang.String
getServiceLabel()
Returns the service label.
  1. void
setClientLabel(java.lang.String label)
Sets the client label.
  1. void
setSecurityContextTokenUUID(java.lang.String uuid)
Sets the uuid of the related security context token.
  1. void
setServiceLabel(java.lang.String label)
Sets the service label.
Methods inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
getId, getKey, getKeyIdentifier, getKeyIdentifierEncodingType, getKeyIdentifierValueType, getKeyName, getPrincipal, getReferenceURI, getThumbprint, getThumbprintEncodingType, getThumbprintValueType, getTokenQname, getValueType, getXML

Field Detail

PSHA1

  1. static final java.lang.String PSHA1
The algorithm for the PSHA1: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
See Also:

PSHA1L128

  1. static final java.lang.String PSHA1L128
The algorithm for the PSHA1_L128: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
See Also:

PSHA1L192

  1. static final java.lang.String PSHA1L192
The algorithm for the PSHA1_L192: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
See Also:

PSHA1L256

  1. static final java.lang.String PSHA1L256
The algorithm for the PSHA1_L256: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
See Also:

TokenQname

  1. static final javax.xml.namespace.QName TokenQname
Represents the QName of this class, <wsu:DerivedKeyToken>.
NamespaceURI: "http://schemas.xmlsoap.org/ws/2005/02/sc"
LocalPart: "DerivedKeyToken"

ValueType

  1. static final javax.xml.namespace.QName ValueType
Represents the value type.
ValueType: "http://schemas.xmlsoap.org/ws/2005/02/sc/dk"

Method Detail

getSecurityContextToken

  1. SecurityContextToken getSecurityContextToken( )
Retuens the SecurityContextToken in order to derive the key.
Returns:
The security context token

getSecret

  1. byte[] getSecret()
Returns the secret is processed as octets representing their binary value. It is used to calcurate the DerivedKey.
Returns:
secret secret

getNonce

  1. byte[] getNonce()
Returns the nonce. This optional elements defines a label to use for all keys derived from this key.
Returns:
nonce nonce

setClientLabel

  1. void setClientLabel(java.lang.String label)
Sets the client label.
Parameters:
label - client label

setServiceLabel

  1. void setServiceLabel(java.lang.String label)
Sets the service label.
Parameters:
label - service label

getClientLabel

  1. java.lang.String getClientLabel( )
Returns the client label.
Returns:
client label

getServiceLabel

  1. java.lang.String getServiceLabel( )
Returns the service label.
Returns:
service label

getLength

  1. int getLength()
Returns the length of the derived key.
Returns:
length of the derived key

getOffset

  1. int getOffset()
Returns the offset of the byte stream to find the generated key.
Returns:
offset offset

getAlgorithm

  1. java.lang.String getAlgorithm()
Returns the key derivation algorithm.
Returns:
name of algorithm

setSecurityContextTokenUUID

  1. void setSecurityContextTokenUUID( java.lang.String uuid)
Sets the uuid of the related security context token.
Parameters:
uuid - uuid of related security context token

getSecurityContextTokenTokenUUID

  1. java.lang.String getSecurityContextTokenTokenUUID( )
Gets the uuid of the related security context token.
Returns:
the uuid of the related security context token