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

java.lang.Object
  extended by com.sun.xml.ws.security.opt.impl.incoming.UsernameTokenHeader
All Implemented Interfaces:
NamespaceContextInfo, PolicyBuilder, SecurityElement, SecurityElementWriter, SecurityHeaderElement, UsernameToken, TokenValidator

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

Author:
Ashutosh.Shahi@sun.com

Constructor Summary
UsernameTokenHeader(XMLStreamReader reader, StreamReaderBufferCreator creator, HashMap nsDecls, XMLInputFactory staxIF)
          Creates a new instance of UsernameTokenHeader
 
Method Summary
 String getId()
           
 HashMap<String,String> getInscopeNSContext()
          map of all inscope namespace declarations.
 String getIterations()
           
 String getLocalPart()
          Gets the local name of this header element.
 String getNamespaceURI()
           
 String getPasswordValue()
           
 WSSPolicy getPolicy()
          returns the WSSPolicy that was created for the SecurityHeaderElement
 String getSalt()
           
 String getUsernameValue()
           
 XMLStreamReader readHeader()
          Reads the header as a XMLStreamReader.
 boolean refersToSecHdrWithId(String id)
           
 void setId(String id)
           
 void setIterations(int iterate)
           
 void setPasswordValue(String passwd)
          sets the password value for this token
 void setSalt(String receivedSalt)
           
 void setUsernameValue(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(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 Detail

UsernameTokenHeader

public UsernameTokenHeader(XMLStreamReader reader,
                           StreamReaderBufferCreator creator,
                           HashMap nsDecls,
                           XMLInputFactory staxIF)
                    throws XMLStreamException,
                           XMLStreamBufferException
Creates a new instance of UsernameTokenHeader

Throws:
XMLStreamException
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(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

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.

getUsernameValue

public String getUsernameValue()
Specified by:
getUsernameValue in interface UsernameToken
Returns:
the username value

setUsernameValue

public void setUsernameValue(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 String getPasswordValue()
Specified by:
getPasswordValue in interface UsernameToken
Returns:
the password for this token

setPasswordValue

public void setPasswordValue(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(String receivedSalt)

getSalt

public String getSalt()

setIterations

public void setIterations(int iterate)

getIterations

public String getIterations()

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)
             throws XMLStreamException
Specified by:
writeTo in interface SecurityElementWriter
Throws:
XMLStreamException


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.