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

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

public class Timestamp
extends java.lang.Object

Timestamp according to SOAP Message Security 1.0, chapter 10 / appendix A.2

Author:
Christof Soehngen (christof.soehngen@syracom.de)

Field Summary
protected  java.util.Calendar created
           
protected  java.util.Vector customElements
           
protected  org.w3c.dom.Element element
           
protected  java.util.Calendar expires
           
 
Constructor Summary
Timestamp(boolean milliseconds, org.w3c.dom.Document doc, int ttl)
          Constructs a Timestamp object according to the defined parameters.
Timestamp(org.w3c.dom.Element element)
          Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.
 
Method Summary
 void addCustomElement(org.w3c.dom.Document doc, org.w3c.dom.Element customElement)
          Creates and adds a custom element to this Timestamp
 java.util.Calendar getCreated()
          Get the time of creation.
protected  java.util.Calendar getCurrentTime()
          Get the current time
 java.util.Vector getCustomElements()
          Get the the custom elements from this Timestamp
 org.w3c.dom.Element getElement()
          Returns the dom element of this Timestamp object.
 java.util.Calendar getExpires()
          Get the time of expiration.
 java.lang.String getID()
          Returns the value of the wsu:Id attribute
 void setID(java.lang.String id)
          Set wsu:Id attribute of this timestamp
 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

customElements

protected java.util.Vector customElements

created

protected java.util.Calendar created

expires

protected java.util.Calendar expires
Constructor Detail

Timestamp

public Timestamp(org.w3c.dom.Element element)
          throws WSSecurityException
Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.

Parameters:
element - the wsu:Timestamp element that contains the timestamp data

Timestamp

public Timestamp(boolean milliseconds,
                 org.w3c.dom.Document doc,
                 int ttl)
Constructs a Timestamp object according to the defined parameters.

Parameters:
doc - the SOAP envelope as Document
ttl - the time to live (validity of the security semantics) in seconds
Method Detail

getCurrentTime

protected java.util.Calendar getCurrentTime()
Get the current time

Returns:
calendar the current time

getElement

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

Returns:
the wsse:UsernameToken element

toString

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

Returns:
a XML string representation

getCreated

public java.util.Calendar getCreated()
Get the time of creation.

Returns:
the "created" time

getExpires

public java.util.Calendar getExpires()
Get the time of expiration.

Returns:
the "expires" time

addCustomElement

public void addCustomElement(org.w3c.dom.Document doc,
                             org.w3c.dom.Element customElement)
Creates and adds a custom element to this Timestamp


getCustomElements

public java.util.Vector getCustomElements()
Get the the custom elements from this Timestamp

Returns:
the vector containing the custom elements.

setID

public void setID(java.lang.String id)
Set wsu:Id attribute of this timestamp

Parameters:
id -

getID

public java.lang.String getID()
Returns the value of the wsu:Id attribute

Returns:
TODO


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