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

Class SAMLAssertion

java.lang.Object

com.sun.xml.ws.security.opt.impl.incoming.SAMLAssertion

All Implemented Interfaces:

NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, TokenValidator

public class SAMLAssertion
extends Object
implements SecurityHeaderElement, PolicyBuilder, TokenValidator, NamespaceContextInfo, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

Constructors

Constructor	Description
SAMLAssertion()
SAMLAssertion(XMLStreamReader reader, JAXBFilterProcessingContext jpc, com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator, HashMap nsDecl)	Creates a new instance of SAMLAssertion

Method Summary

Modifier and Type	Method	Description
String	getId()
HashMap<String,String>	getInscopeNSContext()	map of all inscope namespace declarations.
Key	getKey()
String	getLocalPart()	Gets the local name of this header element.
String	getNamespaceURI()
WSSPolicy	getPolicy()	returns the WSSPolicy that was created for the SecurityHeaderElement
XMLStreamReader	getSamlReader()
boolean	isHOK()
void	process(XMLStreamReader reader)
void	processNoValidation(XMLStreamReader reader, XMLStreamWriter buffer)
XMLStreamReader	readHeader()	Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(String id)
void	setId(String id)
void	skipAdviceValidation(XMLStreamReader reader)
void	validate(ProcessingContext context)	Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.
boolean	validateSignature()
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

Constructor Details

SAMLAssertion

public SAMLAssertion(XMLStreamReader reader,
 JAXBFilterProcessingContext jpc,
 com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator,
 HashMap nsDecl)
              throws com.sun.xml.wss.XWSSecurityException

Creates a new instance of SAMLAssertion

Throws:

com.sun.xml.wss.XWSSecurityException

SAMLAssertion

public SAMLAssertion()

Method Details

getSamlReader

public XMLStreamReader getSamlReader()
                              throws XMLStreamException,
com.sun.xml.wss.XWSSecurityException

Throws:

XMLStreamException

com.sun.xml.wss.XWSSecurityException

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Returns:

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

getPolicy

public WSSPolicy getPolicy()

Description copied from interface: PolicyBuilder

returns the WSSPolicy that was created for the SecurityHeaderElement

Specified by:

getPolicy in interface PolicyBuilder

Returns:

WSSPolicy

validate

public void validate(ProcessingContext context)
              throws com.sun.xml.wss.XWSSecurityException

Description copied from interface: TokenValidator

Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.

Specified by:

validate in interface TokenValidator

Throws:

com.sun.xml.wss.XWSSecurityException

getInscopeNSContext

public HashMap<String,String> getInscopeNSContext()

Description copied from interface: NamespaceContextInfo

map of all inscope namespace declarations.

Specified by:

getInscopeNSContext in interface NamespaceContextInfo

Returns:

HashMap of all inscope namespaces.

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

writeTo

public void writeTo(OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter

isHOK

public boolean isHOK()

validateSignature

public boolean validateSignature()
                          throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

processNoValidation

public void processNoValidation(XMLStreamReader reader,
 XMLStreamWriter buffer)
                         throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

process

public void process(XMLStreamReader reader)
             throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

skipAdviceValidation

public void skipAdviceValidation(XMLStreamReader reader)
                          throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getKey

public Key getKey()
           throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException