Class Timestamp
- java.lang.Object
-
- org.apache.wss4j.dom.message.token.Timestamp
-
public class Timestamp extends Object
Timestamp according to SOAP Message Security 1.0, chapter 10 / appendix A.2
-
-
Constructor Summary
Constructors Constructor Description Timestamp(boolean milliseconds, Document doc, int ttl)
Constructs aTimestamp
object according to the defined parameters.Timestamp(boolean milliseconds, Document doc, WSTimeSource timeSource, int ttl)
Constructs aTimestamp
object according to the defined parameters.Timestamp(Element timestampElement, BSPEnforcer bspEnforcer)
Constructs aTimestamp
object and parses thewsu:Timestamp
element to initialize it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addWSUNamespace()
Add the WSU Namespace to this T.boolean
equals(Object object)
Instant
getCreated()
Get the time of creation.String
getCreatedString()
Get the time of creation as a StringElement
getElement()
Returns the dom element of thisTimestamp
object.Instant
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 timestampString
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".
-
-
-
Constructor Detail
-
Timestamp
public Timestamp(Element timestampElement, BSPEnforcer bspEnforcer) throws WSSecurityException
Constructs aTimestamp
object and parses thewsu:Timestamp
element to initialize it.- Parameters:
timestampElement
- thewsu:Timestamp
element that contains the timestamp databspEnforcer
- a BSPEnforcer instance to enforce BSP rules- Throws:
WSSecurityException
-
Timestamp
public Timestamp(boolean milliseconds, Document doc, int ttl)
Constructs aTimestamp
object according to the defined parameters.- Parameters:
doc
- the SOAP envelope asDocument
ttl
- the time to live (validity of the security semantics) in seconds
-
Timestamp
public Timestamp(boolean milliseconds, Document doc, WSTimeSource timeSource, int ttl)
Constructs aTimestamp
object according to the defined parameters.- Parameters:
doc
- the SOAP envelope asDocument
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 thisTimestamp
object.- Returns:
- the
wsse:UsernameToken
element
-
toString
public String toString()
Returns the string representation of the token.
-
getCreated
public Instant getCreated()
Get the time of creation.- Returns:
- the "created" time
-
getCreatedString
public String getCreatedString()
Get the time of creation as a String- Returns:
- the time of creation as a String
-
getExpires
public Instant getExpires()
Get the time of expiration.- Returns:
- the "expires" time
-
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 timefutureTimeToLive
- the value in seconds for the future validity of the Created time- Returns:
- true if the timestamp is before (now-timeToLive), false otherwise
-
-