org.apache.ws.security.message
Class WSAddTimestamp

java.lang.Object
  extended byorg.apache.ws.security.message.WSBaseMessage
      extended byorg.apache.ws.security.message.WSAddTimestamp

public class WSAddTimestamp
extends WSBaseMessage

Builds a WS Timestamp and inserts it into the SOAP Envelope. Refer to the WS specification 1.0. chapter 10 / appendix A.2

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

Field Summary
 
Fields inherited from class org.apache.ws.security.message.WSBaseMessage
actor, doDebug, keyIdentifierType, mustunderstand, parts, password, timeToLive, user, wssConfig
 
Constructor Summary
WSAddTimestamp()
          Constructor.
WSAddTimestamp(java.lang.String actor)
          Constructor.
WSAddTimestamp(java.lang.String actor, boolean mu)
          Constructor.
WSAddTimestamp(WSSConfig wssConfig, java.lang.String actor, boolean mu)
          Constructor.
 
Method Summary
 org.w3c.dom.Document build(org.w3c.dom.Document doc, int ttl)
          Adds a new Timestamp to a soap envelope.
 
Methods inherited from class org.apache.ws.security.message.WSBaseMessage
getKeyIdentifierType, insertSecurityHeader, setActor, setBodyID, setKeyIdentifierType, setMustUnderstand, setParts, setTimeToLive, setUserInfo, setWsuId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSAddTimestamp

public WSAddTimestamp()
Constructor.


WSAddTimestamp

public WSAddTimestamp(java.lang.String actor)
Constructor.

Parameters:
actor - the name of the actor of the wsse:Security header

WSAddTimestamp

public WSAddTimestamp(java.lang.String actor,
                      boolean mu)
Constructor.

Parameters:
actor - The name of the actor of the wsse:Security header
mu - Set mustUnderstand to true or false

WSAddTimestamp

public WSAddTimestamp(WSSConfig wssConfig,
                      java.lang.String actor,
                      boolean mu)
Constructor.

Parameters:
wssConfig - Configuration options for processing and building security headers
actor - The name of the actor of the wsse:Security header
mu - Set mustUnderstand to true or false
Method Detail

build

public org.w3c.dom.Document build(org.w3c.dom.Document doc,
                                  int ttl)
Adds a new Timestamp to a soap envelope.

A complete Timestamp is constructed and added to the wsse:Security header.

Parameters:
doc - The SOAP enevlope as W3C document
ttl - This is the time difference in seconds between the Created and the Expires in Timestamp, set to zero if Expires should not be added.
Returns:
Document with Timestamp added
Throws:
java.lang.Exception