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

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

All Implemented Interfaces:

NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, UsernameToken, TokenValidator

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

Author:

Ashutosh.Shahi@sun.com

Constructor Summary

UsernameTokenHeader(javax.xml.stream.XMLStreamReader reader, com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator, java.util.HashMap nsDecls, javax.xml.stream.XMLInputFactory staxIF)
Creates a new instance of UsernameTokenHeader

Method Summary

java.lang.String	getId()
java.util.HashMap<java.lang.String,java.lang.String>	getInscopeNSContext() map of all inscope namespace declarations.
java.lang.String	getIterations()
java.lang.String	getLocalPart() Gets the local name of this header element.
java.lang.String	getNamespaceURI()
java.lang.String	getPasswordValue()
WSSPolicy	getPolicy() returns the WSSPolicy that was created for the SecurityHeaderElement
java.lang.String	getSalt()
java.lang.String	getUsernameValue()
javax.xml.stream.XMLStreamReader	readHeader() Reads the header as a XMLStreamReader.
boolean	refersToSecHdrWithId(java.lang.String id)
void	setId(java.lang.String id)
void	setIterations(int iterate)
void	setPasswordValue(java.lang.String passwd) sets the password value for this token
void	setSalt(java.lang.String receivedSalt)
void	setUsernameValue(java.lang.String username) sets the username value for this token
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

UsernameTokenHeader

public UsernameTokenHeader(javax.xml.stream.XMLStreamReader reader,
                           com.sun.xml.stream.buffer.stax.StreamReaderBufferCreator creator,
                           java.util.HashMap nsDecls,
                           javax.xml.stream.XMLInputFactory staxIF)
                    throws javax.xml.stream.XMLStreamException,
                           com.sun.xml.stream.buffer.XMLStreamBufferException

Creates a new instance of UsernameTokenHeader

Throws:

javax.xml.stream.XMLStreamException

com.sun.xml.stream.buffer.XMLStreamBufferException

Method Detail

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

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

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

getUsernameValue

public java.lang.String getUsernameValue()

Specified by:

getUsernameValue in interface UsernameToken

Returns:

the username value

setUsernameValue

public void setUsernameValue(java.lang.String username)

Description copied from interface: UsernameToken

sets the username value for this token

Specified by:

setUsernameValue in interface UsernameToken

Parameters:

username - username value

getPasswordValue

public java.lang.String getPasswordValue()

Specified by:

getPasswordValue in interface UsernameToken

Returns:

the password for this token

setPasswordValue

public void setPasswordValue(java.lang.String passwd)

Description copied from interface: UsernameToken

sets the password value for this token

Specified by:

setPasswordValue in interface UsernameToken

Parameters:

passwd - the password value

setSalt

public void setSalt(java.lang.String receivedSalt)

getSalt

public java.lang.String getSalt()

setIterations

public void setIterations(int iterate)

getIterations

public java.lang.String getIterations()

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.

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