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

Class SecurityContextToken

java.lang.Object

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

All Implemented Interfaces:

NamespaceContextInfo, SecurityElement, SecurityElementWriter, SecurityHeaderElement, SecurityContextToken, Token

public class SecurityContextToken
extends Object
implements SecurityHeaderElement, NamespaceContextInfo, SecurityElementWriter, SecurityContextToken

Author:

[email protected]

Constructor Summary

Constructors

Constructor	Description
SecurityContextToken(XMLStreamReader reader, JAXBFilterProcessingContext pc, HashMap nsDecls)	Creates a new instance of SecurityContextToken

Method Summary

Modifier and Type	Method	Description
List	getExtElements()
String	getId()
URI	getIdentifier()
HashMap<String,String>	getInscopeNSContext()	map of all inscope namespace declarations.
String	getInstance()
String	getLocalPart()	Gets the local name of this header element.
String	getNamespaceURI()
String	getSCId()
Object	getTokenValue()	The token Value
String	getType()	The type of the Token
String	getWsuId()
XMLStreamReader	readHeader()	Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(String id)
void	setId(String id)
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

SecurityContextToken

public SecurityContextToken(XMLStreamReader reader,
 JAXBFilterProcessingContext pc,
 HashMap nsDecls)
                     throws XMLStreamException,
XWSSecurityException

Creates a new instance of SecurityContextToken

Throws:

XMLStreamException

XWSSecurityException

Method Details

getSCId

public String getSCId()

getIdentifier

public URI getIdentifier()

Specified by:

getIdentifier in interface SecurityContextToken

getInstance

public String getInstance()

Specified by:

getInstance in interface SecurityContextToken

getExtElements

public List getExtElements()

Specified by:

getExtElements in interface SecurityContextToken

refersToSecHdrWithId

public boolean refersToSecHdrWithId(String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

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

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.

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.

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,
 HashMap props)

Specified by:

writeTo in interface SecurityElementWriter

getWsuId

public String getWsuId()

Specified by:

getWsuId in interface SecurityContextToken

getType

public String getType()

Description copied from interface: Token

The type of the Token

Specified by:

getType in interface Token

getTokenValue

public Object getTokenValue()

Description copied from interface: Token

The token Value

Specified by:

getTokenValue in interface Token