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

Class JAXBEncryptedData

java.lang.Object

com.sun.xml.ws.security.opt.impl.enc.JAXBEncryptedData

All Implemented Interfaces:

EncryptedData, SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class JAXBEncryptedData
extends Object
implements EncryptedData, SecurityHeaderElement, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

Constructors

Constructor	Description
JAXBEncryptedData(EncryptedDataType edt, Data data, com.sun.xml.ws.api.SOAPVersion soapVersion)
JAXBEncryptedData(EncryptedDataType edt, Data data, Key key, com.sun.xml.ws.api.SOAPVersion soapVersion)	Creates a new instance of JAXBEncryptedData

Method Summary

Modifier and Type	Method	Description
byte[]	canonicalize(String algorithm, List<AttributeNS> namespaceDecls)
void	decrypt()
void	encrypt()
String	getEncryptedId()
String	getEncryptedLocalName()
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 the this security header element refers to the element with given id
void	setId(String id)
void	writeTo(jakarta.xml.soap.SOAPMessage saaj)
void	writeTo(OutputStream os)	writes the jaxb encrypted data to an XMLStreamWriter
void	writeTo(XMLStreamWriter streamWriter)	writes the jaxb encrypted data to an XMLStreamWriter
void	writeTo(XMLStreamWriter streamWriter, HashMap props)	writes the jaxb encrypted data to an XMLStreamWriter
void	writeTo(ContentHandler contentHandler, ErrorHandler errorHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

JAXBEncryptedData

public JAXBEncryptedData(EncryptedDataType edt,
                         Data data,
                         Key key,
                         com.sun.xml.ws.api.SOAPVersion soapVersion)

Creates a new instance of JAXBEncryptedData

JAXBEncryptedData

public JAXBEncryptedData(EncryptedDataType edt,
                         Data data,
                         com.sun.xml.ws.api.SOAPVersion soapVersion)

Method Detail

getEncryptedLocalName

public String getEncryptedLocalName()

getEncryptedId

public String getEncryptedId()

encrypt

public void encrypt()

Specified by:

encrypt in interface EncryptedData

decrypt

public void decrypt()

Specified by:

decrypt in interface EncryptedData

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.

writeTo

public void writeTo(XMLStreamWriter streamWriter)
             throws XMLStreamException

writes the jaxb encrypted data 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 encrypted data to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - javax.xml.stream.XMLStreamWriter

props - HashMap

Throws:

XMLStreamException

writeTo

public void writeTo(OutputStream os)

writes the jaxb encrypted data to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

os - java.io.OutputStream

writeTo

public void writeTo(jakarta.xml.soap.SOAPMessage saaj)
             throws jakarta.xml.soap.SOAPException

Throws:

jakarta.xml.soap.SOAPException

writeTo

public void writeTo(ContentHandler contentHandler,
                    ErrorHandler errorHandler)
             throws SAXException

Throws:

SAXException

canonicalize

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

isCanonicalized

public boolean isCanonicalized()

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

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)

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

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Parameters:

id - String

Returns:

boolean