com.sun.xml.ws.security.opt.impl.keyinfo
Class SAMLToken

java.lang.Object
  com.sun.xml.ws.security.opt.impl.keyinfo.SAMLToken

All Implemented Interfaces:

SecurityElement, SecurityElementWriter, SecurityHeaderElement

public class SAMLToken
extends java.lang.Object
implements SecurityHeaderElement, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

SAMLToken(Assertion assertion, JAXBContext jxbContext, com.sun.xml.ws.api.SOAPVersion soapVersion)
Creates a new instance of SAMLToken

Method Summary

java.lang.String	getId()
java.lang.String	getLocalPart() Gets the local name of this header element.
java.lang.String	getNamespaceURI()
javax.xml.stream.XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(java.lang.String id)
void	setId(java.lang.String id)
void	writeTo(java.io.OutputStream os)
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter) writes the SAML assertion to the XMLStreamWriter
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter, java.util.HashMap props)

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLToken

public SAMLToken(Assertion assertion,
                 JAXBContext jxbContext,
                 com.sun.xml.ws.api.SOAPVersion soapVersion)

Creates a new instance of SAMLToken

Method Detail

refersToSecHdrWithId

public boolean refersToSecHdrWithId(java.lang.String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Returns:

getId

public java.lang.String getId()

Specified by:

getId in interface SecurityElement

Returns:

id

setId

public void setId(java.lang.String id)

Specified by:

setId in interface SecurityElement

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface SecurityElement

Returns:

namespace uri of the security header element.

getLocalPart

public java.lang.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 javax.xml.stream.XMLStreamReader readHeader()
                                            throws javax.xml.stream.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:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter)
             throws javax.xml.stream.XMLStreamException

writes the SAML assertion to the XMLStreamWriter

Specified by:

writeTo in interface SecurityElementWriter

Parameters:

streamWriter - XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter streamWriter,
                    java.util.HashMap props)
             throws javax.xml.stream.XMLStreamException

Specified by:

writeTo in interface SecurityElementWriter

Throws:

javax.xml.stream.XMLStreamException

writeTo

public void writeTo(java.io.OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter