com.sun.xml.ws.security.opt.impl.tokens
Class Timestamp

java.lang.Object
  extended by com.sun.xml.ws.security.wsu10.TimestampType
      extended by com.sun.xml.ws.security.opt.impl.tokens.Timestamp
All Implemented Interfaces:
SecurityElement, SecurityElementWriter, SecurityHeaderElement, Timestamp

public class Timestamp
extends TimestampType
implements Timestamp, SecurityHeaderElement, SecurityElementWriter

Representation of Timestamp SecurityHeaderElement

Author:
Ashutosh.Shahi@sun.com

Field Summary
static SimpleDateFormat calendarFormatter1
           
 
Fields inherited from class com.sun.xml.ws.security.wsu10.TimestampType
any, created, expires, id
 
Constructor Summary
Timestamp(SOAPVersion sv)
          Creates a new instance of Timestamp
 
Method Summary
 void createDateTime()
           
 String getAttribute(QName name)
           
 String getAttribute(String nsUri, String localName)
           
 String getCreatedValue()
           
 String getExpiresValue()
           
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 void setCreated(String created)
           
 void setExpires(String expires)
           
 void setTimeout(long timeout)
          The timeout is assumed to be in seconds
 void writeTo(OutputStream os)
           
 void writeTo(XMLStreamWriter streamWriter)
          Writes out the header.
 void writeTo(XMLStreamWriter streamWriter, HashMap props)
           
 
Methods inherited from class com.sun.xml.ws.security.wsu10.TimestampType
getAny, getCreated, getExpires, getId, getOtherAttributes, setCreated, setExpires, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sun.xml.ws.security.opt.api.SecurityElement
getId, setId
 

Field Detail

calendarFormatter1

public static final SimpleDateFormat calendarFormatter1
Constructor Detail

Timestamp

public Timestamp(SOAPVersion sv)
Creates a new instance of Timestamp

Parameters:
sv - the soapVersion for this message
Method Detail

setCreated

public void setCreated(String created)
Specified by:
setCreated in interface Timestamp
Parameters:
created - set the creation time on timestamp

setExpires

public void setExpires(String expires)
Specified by:
setExpires in interface Timestamp
Parameters:
expires - set the expiry time on timestamp

getCreatedValue

public String getCreatedValue()
Specified by:
getCreatedValue in interface Timestamp
Returns:
the creation time value

getExpiresValue

public String getExpiresValue()
Specified by:
getExpiresValue in interface Timestamp
Returns:
the expiry time value

setTimeout

public void setTimeout(long timeout)
The timeout is assumed to be in seconds


getNamespaceURI

public String getNamespaceURI()
Specified by:
getNamespaceURI in interface SecurityElement
Returns:
namespace uri of the security header element.

getLocalPart

public String getLocalPart()
Description copied from interface: SecurityElement
Gets the local name of this header element.

Specified by:
getLocalPart in interface SecurityElement
Returns:
this string must be interned.

getAttribute

public String getAttribute(String nsUri,
                           String localName)

getAttribute

public String getAttribute(QName name)

readHeader

public XMLStreamReader readHeader()
                           throws XMLStreamException
Description copied from interface: SecurityElement
Reads the header as a XMLStreamReader.

The returned parser points at the start element of this header. (IOW, XMLStreamReader.getEventType() would return XMLStreamConstants.START_ELEMENT.

Performance Expectation

For some Header implementations, this operation is a non-trivial operation. Therefore, use of this method is discouraged unless the caller is interested in reading the whole header.

Similarly, if the caller wants to use this method only to do the API conversion (such as simply firing SAX events from XMLStreamReader), then the JAX-WS team requests that you talk to us.

Messages that come from tranport usually provides a reasonably efficient implementation of this method.

Specified by:
readHeader in interface SecurityElement
Returns:
must not null.
Throws:
XMLStreamException

writeTo

public void writeTo(OutputStream os)
Specified by:
writeTo in interface SecurityElementWriter
Parameters:
os -

writeTo

public void writeTo(XMLStreamWriter streamWriter)
             throws XMLStreamException
Writes out the header.

Specified by:
writeTo in interface SecurityElementWriter
Throws:
XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

createDateTime

public void createDateTime()
                    throws XWSSecurityException
Throws:
XWSSecurityException

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)
Specified by:
refersToSecHdrWithId in interface SecurityHeaderElement
Parameters:
id -
Returns:

writeTo

public void writeTo(XMLStreamWriter streamWriter,
                    HashMap props)
             throws XMLStreamException
Specified by:
writeTo in interface SecurityElementWriter
Parameters:
streamWriter -
props -
Throws:
XMLStreamException


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.