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

Class GSHeaderElement

java.lang.Object

com.sun.xml.ws.security.opt.impl.message.GSHeaderElement

All Implemented Interfaces:

SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class GSHeaderElement
extends Object
implements SecurityHeaderElement, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

Constructors

Constructor and Description
GSHeaderElement(Element obj)
GSHeaderElement(Element obj, com.sun.xml.ws.api.SOAPVersion sv)
GSHeaderElement(JAXBElement el, com.sun.xml.ws.api.SOAPVersion sv)
GSHeaderElement(Object obj, com.sun.xml.ws.api.SOAPVersion sv)
GSHeaderElement(com.sun.xml.stream.buffer.XMLStreamBuffer buffer)

Method Summary

Modifier and Type	Method and Description
byte[]	canonicalize(String algorithm, List<AttributeNS> namespaceDecls)
String	getAttribute(QName name)
String	getAttribute(String nsUri, String localName)
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)
void	setId(String id)
void	writeTo(OutputStream os)
void	writeTo(SOAPMessage saaj)
void	writeTo(XMLStreamWriter streamWriter) Writes out the header.
void	writeTo(XMLStreamWriter streamWriter, HashMap props)

Methods inherited from class java.lang.Object

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

Constructor Detail

GSHeaderElement

public GSHeaderElement(JAXBElement el,
                       com.sun.xml.ws.api.SOAPVersion sv)

GSHeaderElement

public GSHeaderElement(Object obj,
                       com.sun.xml.ws.api.SOAPVersion sv)

GSHeaderElement

public GSHeaderElement(Element obj,
                       com.sun.xml.ws.api.SOAPVersion sv)

GSHeaderElement

public GSHeaderElement(Element obj)

GSHeaderElement

public GSHeaderElement(com.sun.xml.stream.buffer.XMLStreamBuffer buffer)

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

Description copied from interface: SecurityElementWriter

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.

writeTo

public void writeTo(SOAPMessage saaj)
             throws SOAPException

Throws:

SOAPException

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

getAttribute

public String getAttribute(String nsUri,
                           String localName)

getAttribute

public String getAttribute(QName name)

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Returns:

writeTo

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

Specified by:

writeTo in interface SecurityElementWriter

Throws:

XMLStreamException