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

java.lang.Object
  org.apache.ws.security.message.token.Timestamp

public class Timestamp
extends Object

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

Author:

Christof Soehngen (christof.soehngen@syracom.de)

Field Summary

protected Date	createdDate
protected List<Element>	customElements
protected Element	element
protected Date	expiresDate

Constructor Summary

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

Timestamp(boolean milliseconds, Document doc, WSTimeSource timeSource, int ttl)
Constructs a Timestamp object according to the defined parameters.

Timestamp(Element timestampElement)
Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.

Timestamp(Element timestampElement, boolean bspCompliant)
Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.

Method Summary

void	addCustomElement(Document doc, Element customElement) Creates and adds a custom element to this Timestamp
void	addWSUNamespace() Add the WSU Namespace to this T.
boolean	equals(Object object)
Date	getCreated() Get the time of creation.
List<Element>	getCustomElements() Get the the custom elements from this Timestamp
Element	getElement() Returns the dom element of this Timestamp object.
Date	getExpires() Get the time of expiration.
String	getID()
int	hashCode()
boolean	isExpired() Return true if the current Timestamp is expired, meaning if the "Expires" value is before the current time.
void	setID(String id) Set wsu:Id attribute of this timestamp
String	toString() Returns the string representation of the token.
boolean	verifyCreated(int timeToLive, int futureTimeToLive) Return true if the "Created" value is before the current time minus the timeToLive argument, and if the Created value is not "in the future".

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

element

protected Element element

customElements

protected List<Element> customElements

createdDate

protected Date createdDate

expiresDate

protected Date expiresDate

Constructor Detail

Timestamp

public Timestamp(Element timestampElement)
          throws WSSecurityException

Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.

Parameters:

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

Throws:

WSSecurityException

Timestamp

public Timestamp(Element timestampElement,
                 boolean bspCompliant)
          throws WSSecurityException

Constructs a Timestamp object and parses the wsu:Timestamp element to initialize it.

Parameters:

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

bspCompliant - whether the Timestamp processing complies with the BSP spec

Throws:

WSSecurityException

Timestamp

public Timestamp(boolean milliseconds,
                 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

Timestamp

public Timestamp(boolean milliseconds,
                 Document doc,
                 WSTimeSource timeSource,
                 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

addWSUNamespace

public void addWSUNamespace()

Add the WSU Namespace to this T. The namespace is not added by default for efficiency purposes.

getElement

public Element getElement()

Returns the dom element of this Timestamp object.

Returns:

the wsse:UsernameToken element

toString

public String toString()

Returns the string representation of the token.

Overrides:

toString in class Object

Returns:

a XML string representation

getCreated

public Date getCreated()

Get the time of creation.

Returns:

the "created" time

getExpires

public Date getExpires()

Get the time of expiration.

Returns:

the "expires" time

addCustomElement

public void addCustomElement(Document doc,
                             Element customElement)

Creates and adds a custom element to this Timestamp

getCustomElements

public List<Element> getCustomElements()

Get the the custom elements from this Timestamp

Returns:

the list containing the custom elements.

setID

public void setID(String id)

Set wsu:Id attribute of this timestamp

Parameters:

id -

getID

public String getID()

Returns:

the value of the wsu:Id attribute

isExpired

public boolean isExpired()

Return true if the current Timestamp is expired, meaning if the "Expires" value is before the current time. It returns false if there is no Expires value.

verifyCreated

public boolean verifyCreated(int timeToLive,
                             int futureTimeToLive)

Return true if the "Created" value is before the current time minus the timeToLive argument, and if the Created value is not "in the future".

Parameters:

timeToLive - the value in seconds for the validity of the Created time

futureTimeToLive - the value in seconds for the future validity of the Created time

Returns:

true if the timestamp is before (now-timeToLive), false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object