com.sun.xml.ws.security.opt.impl.dsig

Class JAXBSignatureHeaderElement

java.lang.Object

com.sun.xml.ws.security.opt.impl.dsig.JAXBSignatureHeaderElement

All Implemented Interfaces:

SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class JAXBSignatureHeaderElement
extends Object
implements SecurityHeaderElement, SecurityElementWriter

Author:

Ashutosh.Shahi@sun.com

Constructor Summary

Constructors

Constructor and Description
JAXBSignatureHeaderElement(Signature signature, com.sun.xml.ws.api.SOAPVersion soapVersion) Creates a new instance of JAXBSignatureHeaderElement
JAXBSignatureHeaderElement(Signature signature, com.sun.xml.ws.api.SOAPVersion soapVersion, XMLSignContext signctx)

Method Summary

Modifier and Type	Method and Description
byte[]	canonicalize(String algorithm, List<AttributeNS> namespaceDecls)
String	getId()
String	getLocalPart() Gets the local name of this header element.
String	getNamespaceURI()
boolean	isCanonicalized()
XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(String id) finds whether this security header element refers to the element with given id
void	setId(String id)
void	sign() signs the data using the signContext
void	writeTo(OutputStream os)
void	writeTo(XMLStreamWriter streamWriter) writes the jaxb signature header element to an XMLStreamWriter
void	writeTo(XMLStreamWriter streamWriter, HashMap props) writes the jaxb signature header element to an XMLStreamWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

JAXBSignatureHeaderElement

public JAXBSignatureHeaderElement(Signature signature,
                                  com.sun.xml.ws.api.SOAPVersion soapVersion)

Creates a new instance of JAXBSignatureHeaderElement

JAXBSignatureHeaderElement

public JAXBSignatureHeaderElement(Signature signature,
                                  com.sun.xml.ws.api.SOAPVersion soapVersion,
                                  XMLSignContext signctx)

Method Detail

getId

public String getId()

Specified by:

getId in interface SecurityElement

Returns:

id

setId

public void setId(String id)

Specified by:

setId in interface SecurityElement

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.

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(XMLStreamWriter streamWriter)
             throws XMLStreamException

writes the jaxb signature header element to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - javax.xml.stream.XMLStreamWriter

Throws:

XMLStreamException

writeTo

public void writeTo(XMLStreamWriter streamWriter,
                    HashMap props)
             throws XMLStreamException

writes the jaxb signature header element to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - javax.xml.stream.XMLStreamWriter

props - HashMap

Throws:

XMLStreamException

canonicalize

public byte[] canonicalize(String algorithm,
                           List<AttributeNS> namespaceDecls)

isCanonicalized

public boolean isCanonicalized()

writeTo

public void writeTo(OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)

finds whether this security header element refers to the element with given id

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Parameters:

id - String

Returns:

boolean

sign

public void sign()
          throws XMLStreamException

signs the data using the signContext

Throws:

XMLStreamException