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

Class SignedMessagePart

java.lang.Object

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

All Implemented Interfaces:

SecurityElement, SecurityElementWriter, SignedData

Direct Known Subclasses:

SignedMessageHeader

public class SignedMessagePart
extends Object
implements SecurityElement, SignedData, SecurityElementWriter

Author:

Ashutosh.Shahi@sun.com

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	digestValue
protected boolean	isCanonicalized

Constructor Summary

Constructors

Constructor	Description
SignedMessagePart()	Creates a new instance of SignedMessagePart
SignedMessagePart(SecurityElement se)
SignedMessagePart(SOAPBody body, boolean contentOnly)

Method Summary

Modifier and Type	Method	Description
List	getAttributeValuePrefixes()
byte[]	getDigestValue()
String	getId()
String	getLocalPart()	Gets the local name of this header element.
String	getNamespaceURI()
XMLStreamReader	readHeader()	Reads the header as a XMLStreamReader.
void	setDigestValue(byte[] digestValue)
void	setId(String id)
void	writeCanonicalized(OutputStream os)
void	writeTo(OutputStream os)
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

Field Detail

isCanonicalized

protected boolean isCanonicalized

digestValue

protected byte[] digestValue

Constructor Detail

SignedMessagePart

public SignedMessagePart()

Creates a new instance of SignedMessagePart

SignedMessagePart

public SignedMessagePart(SecurityElement se)

SignedMessagePart

public SignedMessagePart(SOAPBody body,
                         boolean contentOnly)

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(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.

writeTo

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

Specified by:

writeTo in interface SecurityElementWriter

Throws:

XMLStreamException

writeCanonicalized

public void writeCanonicalized(OutputStream os)
                        throws IOException

Throws:

IOException

setDigestValue

public void setDigestValue(byte[] digestValue)

Specified by:

setDigestValue in interface SignedData

getDigestValue

public byte[] getDigestValue()

Specified by:

getDigestValue in interface SignedData

Returns:

digestvalue

getAttributeValuePrefixes

public List getAttributeValuePrefixes()