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

java.lang.Object
  extended byorg.apache.ws.sandbox.security.conversation.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
           
static javax.xml.namespace.QName TOKEN
           
 
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
 
Method Summary
 java.lang.String getAlgorithm()
          Gets the derivattion 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
 long getLength()
           
 java.lang.String getNonce()
          Return the nonce of the derived key token
 int getOffset()
           
 java.util.Hashtable getProperties()
           
 SecurityTokenReference getSecuityTokenReference()
          Returns the SecurityTokenReference of the derived key token
 void setAlgorithm(java.lang.String algo)
          Set the derivattion algorithm of this derived key token.
 void setGeneration(org.w3c.dom.Document doc, 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(org.w3c.dom.Document doc, java.lang.String label)
          Sets the label of the derived key
 void setLength(org.w3c.dom.Document doc, long length)
          Sets the length of the derived key
 void setNonce(org.w3c.dom.Document doc, java.lang.String nonce)
          Sets the nonce value of the derived key
 void setOffset(org.w3c.dom.Document doc, int offset)
          Sets the offset
 void setProperties(org.w3c.dom.Document doc, 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(org.w3c.dom.Document doc, 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.Document doc, 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

TOKEN

public static final javax.xml.namespace.QName TOKEN

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)
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

setSecuityTokenReference

public void setSecuityTokenReference(org.w3c.dom.Document doc,
                                     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:
doc - The DOM document
ref - Security token reference

getSecuityTokenReference

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

Returns:
Throws:
WSSecurityException

setProperties

public void setProperties(org.w3c.dom.Document doc,
                          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:
doc - The DOM document
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(org.w3c.dom.Document doc,
                          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(org.w3c.dom.Document doc,
                      long length)
Sets the length of the derived key

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

getLength

public long getLength()

setOffset

public void setOffset(org.w3c.dom.Document doc,
                      int offset)
               throws ConversationException
Sets the offset

Parameters:
doc - The DOM document
offset - The offset value as an integer
Throws:
ConversationException

getOffset

public int getOffset()

setGeneration

public void setGeneration(org.w3c.dom.Document doc,
                          int generation)
                   throws ConversationException
Sets the generation of the derived key

Parameters:
doc - The DOM document
generation - generation value as an integer
Throws:
ConversationException

getGeneration

public int getGeneration()

setLabel

public void setLabel(org.w3c.dom.Document doc,
                     java.lang.String label)
Sets the label of the derived key

Parameters:
doc - The DOM document
label - Label value as a string

setNonce

public void setNonce(org.w3c.dom.Document doc,
                     java.lang.String nonce)
Sets the nonce value of the derived key

Parameters:
doc - The DOM document
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 derivattion algorithm

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

setAlgorithm

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



Copyright © 2004-2008 Apache Web Services. All Rights Reserved.