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

Class JAXBEncryptedKey

java.lang.Object

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

All Implemented Interfaces:

EncryptedKey, SecurityElement, SecurityElementWriter, SecurityHeaderElement, XMLStructure

public class JAXBEncryptedKey
extends Object
implements EncryptedKey, SecurityHeaderElement, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

Constructors

Constructor and Description
JAXBEncryptedKey(EncryptedKeyType ekt, Key kk, Key dk, com.sun.xml.ws.api.SOAPVersion soapVersion) Creates a new instance of JAXBEncryptedKey

Method Summary

Modifier and Type	Method and Description
byte[]	canonicalize(String algorithm, List<AttributeNS> namespaceDecls)
void	decrypt()
void	encrypt()
String	getAttribute(QName name)
String	getAttribute(String nsUri, String localName)
byte[]	getCipherValue()
String	getId()
Key	getKey()
String	getLocalPart() Gets the local name of this header element.
String	getNamespaceURI()
ReferenceList	getReferenceList()
boolean	hasReferenceList()
boolean	isCanonicalized()
boolean	isFeatureSupported(String feature)
<T> T	readAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge)
<T> T	readAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge, com.sun.xml.bind.api.BridgeContext context)
<T> T	readAsJAXB(Unmarshaller unmarshaller)
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	setReferenceList(ReferenceList list)
void	writeTo(ContentHandler contentHandler, ErrorHandler errorHandler)
void	writeTo(OutputStream os) writes the jaxb encrypted key to to an XMLStreamWriter
void	writeTo(SOAPMessage saaj)
void	writeTo(XMLStreamWriter streamWriter) writes the jaxb encrypted key to to an XMLStreamWriter
void	writeTo(XMLStreamWriter streamWriter, HashMap props) writes the jaxb encrypted key to to an XMLStreamWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

JAXBEncryptedKey

public JAXBEncryptedKey(EncryptedKeyType ekt,
                        Key kk,
                        Key dk,
                        com.sun.xml.ws.api.SOAPVersion soapVersion)
                 throws XWSSecurityException

Creates a new instance of JAXBEncryptedKey

Throws:

XWSSecurityException

Method Detail

encrypt

public void encrypt()

decrypt

public void decrypt()

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.

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

readAsJAXB

public <T> T readAsJAXB(Unmarshaller unmarshaller)
                 throws JAXBException

Throws:

JAXBException

readAsJAXB

public <T> T readAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge,
                        com.sun.xml.bind.api.BridgeContext context)
                 throws JAXBException

Throws:

JAXBException

readAsJAXB

public <T> T readAsJAXB(com.sun.xml.bind.api.Bridge<T> bridge)
                 throws JAXBException

Throws:

JAXBException

writeTo

public void writeTo(XMLStreamWriter streamWriter)
             throws XMLStreamException

writes the jaxb encrypted key to to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - javax.xml.stream.XMLStreamWriter

Throws:

XMLStreamException

writeTo

public void writeTo(OutputStream os)

writes the jaxb encrypted key to to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

os - OutputStream

writeTo

public void writeTo(SOAPMessage saaj)
             throws SOAPException

Throws:

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

getReferenceList

public ReferenceList getReferenceList()

Specified by:

getReferenceList in interface EncryptedKey

Returns:

hasReferenceList

public boolean hasReferenceList()

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 -

Returns:

setReferenceList

public void setReferenceList(ReferenceList list)

Specified by:

setReferenceList in interface EncryptedKey

getKey

public Key getKey()

Specified by:

getKey in interface EncryptedKey

Returns:

getCipherValue

public byte[] getCipherValue()

writeTo

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

writes the jaxb encrypted key to to an XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - javax.xml.stream.XMLStreamWriter

props - HashMap

Throws:

XMLStreamException

isFeatureSupported

public boolean isFeatureSupported(String feature)

Specified by:

isFeatureSupported in interface XMLStructure