com.sun.xml.ws.security.opt.impl.incoming
Class TimestampHeader

java.lang.Object
  com.sun.xml.ws.security.opt.impl.incoming.TimestampHeader

All Implemented Interfaces:

NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, Timestamp, TokenValidator

public class TimestampHeader
extends java.lang.Object
implements Timestamp, SecurityHeaderElement, TokenValidator, PolicyBuilder, NamespaceContextInfo, SecurityElementWriter

Author:

Ashutosh.Shahi@sun.com

Constructor Summary

TimestampHeader(javax.xml.stream.XMLStreamReader reader, com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator, java.util.HashMap nsDecls, JAXBFilterProcessingContext ctx)
Creates a new instance of TimestampHeader

Method Summary

byte[]	canonicalize(java.lang.String algorithm, java.util.List<AttributeNS> namespaceDecls)
java.lang.String	getAttribute(javax.xml.namespace.QName name)
java.lang.String	getAttribute(java.lang.String nsUri, java.lang.String localName)
java.lang.String	getCreatedValue()
java.lang.String	getExpiresValue()
java.lang.String	getId()
java.util.HashMap<java.lang.String,java.lang.String>	getInscopeNSContext() map of all inscope namespace declarations.
java.lang.String	getLocalPart() Gets the local name of this header element.
java.lang.String	getNamespaceURI()
WSSPolicy	getPolicy() returns the WSSPolicy that was created for the SecurityHeaderElement
boolean	isCanonicalized()
javax.xml.stream.XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(java.lang.String id)
void	setCreated(java.lang.String created)
void	setExpires(java.lang.String expires)
void	setId(java.lang.String id)
void	validate(ProcessingContext context) Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.
void	writeTo(java.io.OutputStream os)
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter) Writes out the header.
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter, java.util.HashMap props)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimestampHeader

public TimestampHeader(javax.xml.stream.XMLStreamReader reader,
                       com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator,
                       java.util.HashMap nsDecls,
                       JAXBFilterProcessingContext ctx)
                throws javax.xml.stream.XMLStreamException,
                       com.sun.xml.stream.buffer.XMLStreamBufferException

Creates a new instance of TimestampHeader

Throws:

javax.xml.stream.XMLStreamException

com.sun.xml.stream.buffer.XMLStreamBufferException

Method Detail

validate

public void validate(ProcessingContext context)
              throws XWSSecurityException

Description copied from interface: TokenValidator

Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.

Specified by:

validate in interface TokenValidator

Throws:

XWSSecurityException

getPolicy

public WSSPolicy getPolicy()

Description copied from interface: PolicyBuilder

returns the WSSPolicy that was created for the SecurityHeaderElement

Specified by:

getPolicy in interface PolicyBuilder

Returns:

WSSPolicy

setCreated

public void setCreated(java.lang.String created)

Specified by:

setCreated in interface Timestamp

Parameters:

created - set the creation time on timestamp

setExpires

public void setExpires(java.lang.String expires)

Specified by:

setExpires in interface Timestamp

Parameters:

expires - set the expiry time on timestamp

getCreatedValue

public java.lang.String getCreatedValue()

Specified by:

getCreatedValue in interface Timestamp

Returns:

the creation time value

getExpiresValue

public java.lang.String getExpiresValue()

Specified by:

getExpiresValue in interface Timestamp

Returns:

the expiry time value

refersToSecHdrWithId

public boolean refersToSecHdrWithId(java.lang.String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Returns:

getId

public java.lang.String getId()

Specified by:

getId in interface SecurityElement

Returns:

id

setId

public void setId(java.lang.String id)

Specified by:

setId in interface SecurityElement

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface SecurityElement

Returns:

namespace uri of the security header element.

getLocalPart

public java.lang.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 java.lang.String getAttribute(java.lang.String nsUri,
                                     java.lang.String localName)

getAttribute

public java.lang.String getAttribute(javax.xml.namespace.QName name)

readHeader

public javax.xml.stream.XMLStreamReader readHeader()
                                            throws javax.xml.stream.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:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(java.io.OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter)
             throws javax.xml.stream.XMLStreamException

Description copied from interface: SecurityElementWriter

Writes out the header.

Specified by:

writeTo in interface SecurityElementWriter

Throws:

javax.xml.stream.XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

canonicalize

public byte[] canonicalize(java.lang.String algorithm,
                           java.util.List<AttributeNS> namespaceDecls)

isCanonicalized

public boolean isCanonicalized()

getInscopeNSContext

public java.util.HashMap<java.lang.String,java.lang.String> getInscopeNSContext()

Description copied from interface: NamespaceContextInfo

map of all inscope namespace declarations.

Specified by:

getInscopeNSContext in interface NamespaceContextInfo

Returns:

HashMap of all inscope namespaces.

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter,
                    java.util.HashMap props)
             throws javax.xml.stream.XMLStreamException

Specified by:

writeTo in interface SecurityElementWriter

Throws:

javax.xml.stream.XMLStreamException