com.sun.xml.ws.security.opt.impl.incoming
Class X509BinarySecurityToken

java.lang.Object
  com.sun.xml.ws.security.opt.impl.incoming.X509BinarySecurityToken

All Implemented Interfaces:

BinarySecurityToken, Token, X509BinarySecurityToken, NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, TokenValidator

public class X509BinarySecurityToken
extends java.lang.Object
implements X509BinarySecurityToken, SecurityHeaderElement, PolicyBuilder, TokenValidator, NamespaceContextInfo, SecurityElementWriter

Author:

K.Venugopal@sun.com

Constructor Summary

X509BinarySecurityToken(javax.xml.stream.XMLStreamReader reader, StreamReaderBufferCreator creator, java.util.HashMap nsDecl, javax.xml.stream.XMLInputFactory staxIF)

Method Summary

java.security.cert.X509Certificate	getCertificate()
java.lang.String	getEncodingType()
java.lang.String	getId()
java.util.HashMap<java.lang.String,java.lang.String>	getInscopeNSContext() map of all inscope namespace declarations.
java.lang.String	getLocalPart() Gets the local name of this header element.
java.lang.String	getNamespaceURI()
WSSPolicy	getPolicy() returns the WSSPolicy that was created for the SecurityHeaderElement
byte[]	getTokenValue()
java.lang.String	getValueType()
javax.xml.stream.XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(java.lang.String id)
void	setId(java.lang.String id)
void	validate(ProcessingContext context) Peforms token validation , eg: In case BinarySecurityToken checks if the token is valid.
void	writeTo(java.io.OutputStream os)
void	writeTo(javax.xml.stream.XMLStreamWriter streamWriter) Writes out the header.
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

X509BinarySecurityToken

public X509BinarySecurityToken(javax.xml.stream.XMLStreamReader reader,
                               StreamReaderBufferCreator creator,
                               java.util.HashMap nsDecl,
                               javax.xml.stream.XMLInputFactory staxIF)
                        throws javax.xml.stream.XMLStreamException,
                               XMLStreamBufferException

Throws:

javax.xml.stream.XMLStreamException

XMLStreamBufferException

Method Detail

getValueType

public java.lang.String getValueType()

Specified by:

getValueType in interface BinarySecurityToken

getEncodingType

public java.lang.String getEncodingType()

Specified by:

getEncodingType in interface BinarySecurityToken

getTokenValue

public byte[] getTokenValue()

Specified by:

getTokenValue in interface BinarySecurityToken

getId

public java.lang.String getId()

Specified by:

getId in interface Token

Specified by:

getId in interface SecurityElement

Returns:

id

refersToSecHdrWithId

public boolean refersToSecHdrWithId(java.lang.String id)

Specified by:

refersToSecHdrWithId in interface SecurityHeaderElement

Returns:

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(java.io.OutputStream os)

Specified by:

writeTo in interface SecurityElementWriter

writeTo

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

Description copied from interface: SecurityElementWriter

Writes out the header.

Specified by:

writeTo in interface SecurityElementWriter

Throws:

javax.xml.stream.XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

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 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:

XWSSecurityException

getInscopeNSContext

public java.util.HashMap<java.lang.String,java.lang.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.

getCertificate

public java.security.cert.X509Certificate getCertificate()

Specified by:

getCertificate in interface X509BinarySecurityToken

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