Class WSSecTimestamp

java.lang.Object
org.apache.ws.security.message.WSSecBase
org.apache.ws.security.message.WSSecTimestamp
public class WSSecTimestamp extends WSSecBase
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)., Werner Dittmann (werner@apache.org).

  • Constructor Details

    • WSSecTimestamp

      public WSSecTimestamp()
      Constructor.

  • Method Details

    • setTimeToLive

      public void setTimeToLive(int ttl)
      Set the time to live. This is the time difference in seconds between the Created and the Expires in Timestamp.

      Parameters:
      ttl - The time to live in second

    • prepare

      public void prepare(Document doc)
      Creates a Timestamp element. The method prepares and initializes a WSSec Timestamp structure after the relevant information was set. Before calling prepare() the parameter such as timeToLive can be set if the deafult value is not suitable.
      Parameters:
      doc - The SOAP enevlope as W3C document

    • prependToHeader

      public void prependToHeader(WSSecHeader secHeader)
      Prepends the Timestamp element to the elements already in the Security header. The method can be called any time after prepare(). This allows to insert the Timestamp element at any position in the Security header.
      Parameters:
      secHeader - The security header that holds the Signature element.

    • build

      public Document build(Document doc, WSSecHeader secHeader)
      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
      secHeader - The security header that hold this Timestamp
      Returns:
      Document with Timestamp added
      Throws:
      Exception

    • getId

      public String getId()
      Get the id generated during prepare(). Returns the the value of wsu:Id attribute of this Timestamp.
      Returns:
      Return the wsu:Id of this token or null if prepareToken() was not called before.

    • getElement

      public Element getElement()
      Get the timestamp element generated during prepare().