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

Class SignatureConfirmation

java.lang.Object

com.sun.xml.ws.security.secext11.SignatureConfirmationType

com.sun.xml.ws.security.opt.impl.tokens.SignatureConfirmation

All Implemented Interfaces:

SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class SignatureConfirmation
extends SignatureConfirmationType
implements SecurityHeaderElement, SecurityElementWriter

Author:

Ashutosh.Shahi@sun.com

Field Summary

Fields inherited from class com.sun.xml.ws.security.secext11.SignatureConfirmationType

id, value

Constructor Summary

Constructors

Constructor and Description
SignatureConfirmation(String id, com.sun.xml.ws.api.SOAPVersion sv) Creates a new instance of SignatureConfirmation

Method Summary

Modifier and Type	Method and Description
String	getAttribute(QName name)
String	getAttribute(String nsUri, String localName)
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	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.secext11.SignatureConfirmationType

getId, getValue, setId, setValue

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

Constructor Detail

SignatureConfirmation

public SignatureConfirmation(String id,
                             com.sun.xml.ws.api.SOAPVersion sv)

Creates a new instance of SignatureConfirmation

Method Detail

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

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.

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

Throws:

XMLStreamException