org.apache.ws.security.message.token
Class UsernameToken

java.lang.Object
  org.apache.ws.security.message.token.UsernameToken

public class UsernameToken

extends java.lang.Object

UsernameToken according to WS Security specifications, UsernameToken profile.

Author:

Davanum Srinivas (dims@yahoo.com), Werner Dittmann (Werner.Dittmann@siemens.com)

Field Summary

protected org.w3c.dom.Element	element
protected org.w3c.dom.Element	elementCreated
protected org.w3c.dom.Element	elementNonce
protected org.w3c.dom.Element	elementPassword
protected org.w3c.dom.Element	elementUsername
protected boolean	hashed
static java.lang.String	PASSWORD_TYPE
protected java.lang.String	passwordType
javax.xml.namespace.QName	token
static java.lang.String	TOKEN
protected WSSConfig	wssConfig

Constructor Summary

UsernameToken(WSSConfig wssConfig, org.w3c.dom.Document doc)
Constructs a UsernameToken object according to the defined parameters.

UsernameToken(WSSConfig wssConfig, org.w3c.dom.Document doc, java.lang.String pwType)
Constructs a UsernameToken object according to the defined parameters.

UsernameToken(WSSConfig wssConfig, org.w3c.dom.Element elem)
Constructs a UsernameToken object and parses the wsse:UsernameToken element to initialize it.

Method Summary

void	addCreated(org.w3c.dom.Document doc) Creates and adds a Created element to this UsernameToken
void	addNonce(org.w3c.dom.Document doc) Creates and adds a Nonce element to this UsernameToken
static java.lang.String	doPasswordDigest(java.lang.String nonce, java.lang.String created, java.lang.String password)
java.lang.String	getCreated() Get the created timestamp.
org.w3c.dom.Element	getElement() Returns the dom element of this UsernameToken object.
java.lang.String	getID() Gets the id.
java.lang.String	getName() Get the user name.
java.lang.String	getNonce() Get the nonce.
java.lang.String	getPassword() Gets the password string.
java.lang.String	getPasswordType()
byte[]	getSecretKey() Gets the secret key as per WS-Trust spec.
byte[]	getSecretKey(int keylen, java.lang.String labelString) Gets the secret key as per WS-Trust spec.
boolean	isHashed() Get the hashed inidicator.
void	setID(java.lang.String id) Set the id of this username token.
void	setName(java.lang.String name) Set the user name.
void	setPassword(java.lang.String pwd) Sets the password string.
java.lang.String	toString() Returns the string representation of the token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

token

public javax.xml.namespace.QName token

PASSWORD_TYPE

public static final java.lang.String PASSWORD_TYPE

See Also:

Constant Field Values

element

protected org.w3c.dom.Element element

elementUsername

protected org.w3c.dom.Element elementUsername

elementPassword

protected org.w3c.dom.Element elementPassword

elementNonce

protected org.w3c.dom.Element elementNonce

elementCreated

protected org.w3c.dom.Element elementCreated

passwordType

protected java.lang.String passwordType

hashed

protected boolean hashed

wssConfig

protected WSSConfig wssConfig

TOKEN

public static java.lang.String TOKEN

Constructor Detail

UsernameToken

public UsernameToken(WSSConfig wssConfig,
                     org.w3c.dom.Element elem)
              throws WSSecurityException

Constructs a UsernameToken object and parses the wsse:UsernameToken element to initialize it.

Parameters:

wssConfig - Configuration options for processing and building the wsse:Security header

elem - the wsse:UsernameToken element that contains the UsernameToken data

Throws:

WSSecurityException

UsernameToken

public UsernameToken(WSSConfig wssConfig,
                     org.w3c.dom.Document doc)

Constructs a UsernameToken object according to the defined parameters.

This constructes set the password encoding to WSConstants.PASSWORD_DIGEST

Parameters:

wssConfig - Configuration options for processing and building the wsse:Security header

doc - the SOAP envelope as Document

UsernameToken

public UsernameToken(WSSConfig wssConfig,
                     org.w3c.dom.Document doc,
                     java.lang.String pwType)

Constructs a UsernameToken object according to the defined parameters.

Parameters:

wssConfig - Configuration options for processing and building the wsse:Security header

doc - the SOAP envelope as Document

Method Detail

addNonce

public void addNonce(org.w3c.dom.Document doc)

Creates and adds a Nonce element to this UsernameToken

addCreated

public void addCreated(org.w3c.dom.Document doc)

Creates and adds a Created element to this UsernameToken

getName

public java.lang.String getName()

Get the user name.

Returns:

the data from the user name element.

setName

public void setName(java.lang.String name)

Set the user name.

Parameters:

name - sets a text node containing the use name into the user name element.

getNonce

public java.lang.String getNonce()

Get the nonce.

Returns:

the data from the nonce element.

getCreated

public java.lang.String getCreated()

Get the created timestamp.

Returns:

the data from the created time element.

getPassword

public java.lang.String getPassword()

Gets the password string. This is the password as it is in the password element of a username, token. Thus it can be either plain text or the password digest value.

Returns:

the password string or null if no such node exists.

isHashed

public boolean isHashed()

Get the hashed inidicator. If the indicator is true> the password of the UsernameToken was encoded using WSConstants.PASSWORD_DIGEST

Returns:

the hashed indicator.

getPasswordType

public java.lang.String getPasswordType()

Returns:

Returns the passwordType.

setPassword

public void setPassword(java.lang.String pwd)

Sets the password string. This function sets the password in the UsernameToken either as plain text or encodes the password according to the WS Security specifications, UsernameToken profile, into a password digest.

Parameters:

pwd - the password to use

doPasswordDigest

public static java.lang.String doPasswordDigest(java.lang.String nonce,
                                                java.lang.String created,
                                                java.lang.String password)

getElement

public org.w3c.dom.Element getElement()

Returns the dom element of this UsernameToken object.

Returns:

the wsse:UsernameToken element

toString

public java.lang.String toString()

Returns the string representation of the token.

Returns:

a XML string representation

getID

public java.lang.String getID()

Gets the id.

Returns:

the value of the wsu:Id attribute of this username token

setID

public void setID(java.lang.String id)

Set the id of this username token.

Parameters:

id - the value for the wsu:Id attribute of this username token

getSecretKey

public byte[] getSecretKey()

Gets the secret key as per WS-Trust spec. This mthod uses default setting to generate the secret key. These default values are suitable for .NET WSE.

Returns:

a secret key constructed from information conatined in this username token

getSecretKey

public byte[] getSecretKey(int keylen,
                           java.lang.String labelString)

Gets the secret key as per WS-Trust spec.

Parameters:

keylen - How many bytes to generate for the key

labelString - the label used to generate the seed

Returns:

a secret key constructed from information conatined in this username token