org.apache.ws.security.message.token
Class DerivedKeyToken

java.lang.Object
  extended byorg.apache.ws.security.message.token.DerivedKeyToken

public class DerivedKeyToken
extends java.lang.Object

Version:
1.0
Author:
Ruchith Fernando

Field Summary
protected  org.w3c.dom.Element element
           
protected  org.w3c.dom.Element elementGeneration
           
protected  org.w3c.dom.Element elementLabel
           
protected  org.w3c.dom.Element elementLength
           
protected  org.w3c.dom.Element elementNonce
           
protected  org.w3c.dom.Element elementOffset
           
protected  org.w3c.dom.Element elementProperties
           
protected  org.w3c.dom.Element elementSecurityTokenReference
           
 
Constructor Summary
DerivedKeyToken(org.w3c.dom.Document doc)
          This will create an empty DerivedKeyToken
DerivedKeyToken(org.w3c.dom.Element elem)
          This will create a DerivedKeyToken object with the given DErivedKeyToken element
DerivedKeyToken(int version, org.w3c.dom.Document doc)
          This will create an empty DerivedKeyToken
 
Method Summary
 java.lang.String getAlgorithm()
          Gets the derivation algorithm
 org.w3c.dom.Element getElement()
          Returns the dom element of this SecurityContextToken object.
 int getGeneration()
           
 java.lang.String getID()
          Gets the id.
 java.lang.String getLabel()
          Returns the label of the derived key token
 int getLength()
           
 java.lang.String getNonce()
          Return the nonce of the derived key token
 int getOffset()
           
 java.util.Hashtable getProperties()
           
 SecurityTokenReference getSecuityTokenReference()
          Deprecated. use getSecurityTokenReference() instead
 SecurityTokenReference getSecurityTokenReference()
          Returns the SecurityTokenReference of the derived key token
 void setAlgorithm(java.lang.String algo)
          Set the derivation algorithm of this derived key token.
 void setGeneration(int generation)
          Sets the generation of the derived key
 void setID(java.lang.String id)
          Set the id of this derived key token.
 void setLabel(java.lang.String label)
          Sets the label of the derived key
 void setLength(int length)
          Sets the length of the derived key
 void setNonce(java.lang.String nonce)
          Sets the nonce value of the derived key
 void setOffset(int offset)
          Sets the offset
 void setProperties(java.util.Hashtable properties)
          If there are other types of properties other than Name, Label and Nonce This is provided for extensibility purposes
 void setProperties(java.lang.String name, java.lang.String label, java.lang.String nonce)
          This is used to set the Name, Label and Nonce element values in the properties element At this point I'm not sure if these are the only properties that will appear in the Properties element.
 void setSecuityTokenReference(org.w3c.dom.Element elem)
          Deprecated. use setSecurityTokenReference(Element elem) instead
 void setSecuityTokenReference(SecurityTokenReference ref)
          Deprecated. use setSecurityTokenReference(SecurityTokenReference ref) instead
 void setSecurityTokenReference(org.w3c.dom.Element elem)
           
 void setSecurityTokenReference(SecurityTokenReference ref)
          Sets the security token reference of the derived key token This is the reference to the shared secret used in the conversation/context
 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

elementSecurityTokenReference

protected org.w3c.dom.Element elementSecurityTokenReference

elementProperties

protected org.w3c.dom.Element elementProperties

elementGeneration

protected org.w3c.dom.Element elementGeneration

elementOffset

protected org.w3c.dom.Element elementOffset

elementLength

protected org.w3c.dom.Element elementLength

elementLabel

protected org.w3c.dom.Element elementLabel

elementNonce

protected org.w3c.dom.Element elementNonce
Constructor Detail

DerivedKeyToken

public DerivedKeyToken(org.w3c.dom.Document doc)
                throws ConversationException
This will create an empty DerivedKeyToken

Parameters:
doc - THe DOM document

DerivedKeyToken

public DerivedKeyToken(int version,
                       org.w3c.dom.Document doc)
                throws ConversationException
This will create an empty DerivedKeyToken

Parameters:
doc - THe DOM document

DerivedKeyToken

public DerivedKeyToken(org.w3c.dom.Element elem)
                throws WSSecurityException
This will create a DerivedKeyToken object with the given DErivedKeyToken element

Parameters:
elem - The DErivedKeyToken DOM element
Throws:
WSSecurityException - If the element is not a derived key token
Method Detail

setSecurityTokenReference

public void setSecurityTokenReference(SecurityTokenReference ref)
Sets the security token reference of the derived key token This is the reference to the shared secret used in the conversation/context

Parameters:
ref - Security token reference

setSecuityTokenReference

public void setSecuityTokenReference(SecurityTokenReference ref)
Deprecated. use setSecurityTokenReference(SecurityTokenReference ref) instead

Sets the security token reference of the derived key token This is the reference to the shared secret used in the conversation/context

Parameters:
ref - Security token reference

setSecurityTokenReference

public void setSecurityTokenReference(org.w3c.dom.Element elem)

setSecuityTokenReference

public void setSecuityTokenReference(org.w3c.dom.Element elem)
Deprecated. use setSecurityTokenReference(Element elem) instead


getSecurityTokenReference

public SecurityTokenReference getSecurityTokenReference()
                                                 throws WSSecurityException
Returns the SecurityTokenReference of the derived key token

Returns:
the Security Token Reference of the derived key token
Throws:
WSSecurityException

getSecuityTokenReference

public SecurityTokenReference getSecuityTokenReference()
                                                throws WSSecurityException
Deprecated. use getSecurityTokenReference() instead

Returns the SecurityTokenReference of the derived key token

Returns:
the Security Token Reference of the derived key token
Throws:
WSSecurityException

setProperties

public void setProperties(java.lang.String name,
                          java.lang.String label,
                          java.lang.String nonce)
This is used to set the Name, Label and Nonce element values in the properties element At this point I'm not sure if these are the only properties that will appear in the Properties element. There fore this method is provided If this is not required feel free to remove this :D

Parameters:
name - Value of the Properties/Name element
label - Value of the Properties/Label element
nonce - Value of the Properties/Nonce element

setProperties

public void setProperties(java.util.Hashtable properties)
If there are other types of properties other than Name, Label and Nonce This is provided for extensibility purposes

Parameters:
properties - The properties and values in a hashtable

getProperties

public java.util.Hashtable getProperties()

setLength

public void setLength(int length)
Sets the length of the derived key

Parameters:
length - The length of the derived key as a long

getLength

public int getLength()

setOffset

public void setOffset(int offset)
               throws ConversationException
Sets the offset

Parameters:
offset - The offset value as an integer
Throws:
ConversationException

getOffset

public int getOffset()

setGeneration

public void setGeneration(int generation)
                   throws ConversationException
Sets the generation of the derived key

Parameters:
generation - generation value as an integer
Throws:
ConversationException

getGeneration

public int getGeneration()

setLabel

public void setLabel(java.lang.String label)
Sets the label of the derived key

Parameters:
label - Label value as a string

setNonce

public void setNonce(java.lang.String nonce)
Sets the nonce value of the derived key

Parameters:
nonce - Nonce value as a string

getLabel

public java.lang.String getLabel()
Returns the label of the derived key token

Returns:
Label of the derived key token

getNonce

public java.lang.String getNonce()
Return the nonce of the derived key token

Returns:
Nonce of the derived key token

getElement

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

Returns:
the DerivedKeyToken element

toString

public java.lang.String toString()
Returns the string representation of the token.

Returns:
a XML string representation

getID

public java.lang.String getID()
Gets the id.

Returns:
the value of the wsu:Id attribute of this DerivedKeyToken

setID

public void setID(java.lang.String id)
Set the id of this derived key token.

Parameters:
id - the value for the wsu:Id attribute of this DerivgedKeyToken

getAlgorithm

public java.lang.String getAlgorithm()
Gets the derivation algorithm

Returns:
the value of the wsc:Algorithm attribute of this DerivedKeyToken

setAlgorithm

public void setAlgorithm(java.lang.String algo)
Set the derivation algorithm of this derived key token.

Parameters:
algo - the value for the wsu:Algorithm attribute of this DerivedKeyToken


Copyright © 2004-2008 The Apache Software Foundation. All Rights Reserved.