IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.wssecurity.wssapi.token
Interface DerivedKeyToken

All Superinterfaces:
SecurityToken

public interface DerivedKeyToken
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
static java.lang.String PSHA1
          The algorithm for the PSHA1: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
static java.lang.String PSHA1L128
          The algorithm for the PSHA1_L128: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
static java.lang.String PSHA1L192
          The algorithm for the PSHA1_L192: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
static java.lang.String PSHA1L256
          The algorithm for the PSHA1_L256: http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1.
static javax.xml.namespace.QName TokenQname
          Represents the QName of this class, <wsu:DerivedKeyToken>.
static 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
 java.lang.String getAlgorithm()
          Returns the key derivation algorithm.
 java.lang.String getClientLabel()
          Returns the client label.
 int getLength()
          Returns the length of the derived key.
 byte[] getNonce()
          Returns the nonce.
 int getOffset()
          Returns the offset of the byte stream to find the generated key.
 byte[] getSecret()
          Returns the secret is processed as octets representing their binary value.
 SecurityContextToken getSecurityContextToken()
          Retuens the SecurityContextToken in order to derive the key.
 java.lang.String getSecurityContextTokenTokenUUID()
          Gets the uuid of the related security context token.
 java.lang.String getServiceLabel()
          Returns the service label.
 void setClientLabel(java.lang.String label)
          Sets the client label.
 void setSecurityContextTokenUUID(java.lang.String uuid)
          Sets the uuid of the related security context token.
 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

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

See Also:
Constant Field Values

PSHA1L128

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:
Constant Field Values

PSHA1L192

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:
Constant Field Values

PSHA1L256

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:
Constant Field Values

TokenQname

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

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

Method Detail

getSecurityContextToken

SecurityContextToken getSecurityContextToken()
Retuens the SecurityContextToken in order to derive the key.

Returns:
The security context token

getSecret

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

Returns:
secret secret

getNonce

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

Returns:
nonce nonce

setClientLabel

void setClientLabel(java.lang.String label)
Sets the client label.

Parameters:
label - client label

setServiceLabel

void setServiceLabel(java.lang.String label)
Sets the service label.

Parameters:
label - service label

getClientLabel

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

Returns:
client label

getServiceLabel

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

Returns:
service label

getLength

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

Returns:
length of the derived key

getOffset

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

Returns:
offset offset

getAlgorithm

java.lang.String getAlgorithm()
Returns the key derivation algorithm.

Returns:
name of algorithm

setSecurityContextTokenUUID

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

Parameters:
uuid - uuid of related security context token

getSecurityContextTokenTokenUUID

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

Returns:
the uuid of the related security context token

IBM WebSphere Application ServerTM
Release 8