Package com.sun.identity.wss.sts

Class STSClientUserToken

java.lang.Object

com.sun.identity.wss.sts.STSClientUserToken

All Implemented Interfaces:

ClientUserToken, com.sun.xml.ws.security.Token

public class STSClientUserToken
extends Object
implements ClientUserToken

This class implements ClientUserToken for on behalf of token that will be used to pass end user OpenAM SSO Token to the STS service.

Constructor Summary

Constructors

Constructor	Description
STSClientUserToken()	Creates a new instance of STSClientUserToken
STSClientUserToken(Element element)

Method Summary

Modifier and Type	Method	Description
String	getAppTokenID()	Returns the Application/Client token value.
String	getPrincipalName()	Returns the principal name that the client user token carries.
String	getTokenId()
Element	getTokenValue()
String	getType()
void	init(Object credential)	Initializes client user token.
void	parse(Element element)	Parses the custom token element.
String	toString()	Returns the java.lang.String representation of this client user token.

Methods inherited from class java.lang.Object

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

Constructor Detail

STSClientUserToken

public STSClientUserToken()

Creates a new instance of STSClientUserToken

STSClientUserToken

public STSClientUserToken(Element element)
                   throws FAMSTSException

Throws:

FAMSTSException

Method Detail

init

public void init(Object credential)
          throws FAMSTSException

Description copied from interface: ClientUserToken

Initializes client user token.

Specified by:

init in interface ClientUserToken

Parameters:

credential - credential object to initialize the user token

Throws:

FAMSTSException - if the user token cannot be initialized.

parse

public void parse(Element element)
           throws FAMSTSException

Description copied from interface: ClientUserToken

Parses the custom token element. This method is used at the receiving end (STS server side).

Specified by:

parse in interface ClientUserToken

Parameters:

element - the custom token element

Throws:

FAMSTSException - if the token element cannot be parsed.

getTokenValue

public Element getTokenValue()

Specified by:

getTokenValue in interface com.sun.xml.ws.security.Token

getTokenId

public String getTokenId()

getPrincipalName

public String getPrincipalName()
                        throws FAMSTSException

Description copied from interface: ClientUserToken

Returns the principal name that the client user token carries.

Specified by:

getPrincipalName in interface ClientUserToken

Returns:

the principal name that the client user token carries

Throws:

FAMSTSException - if the principal name cannot be retrieved.

toString

public String toString()

Description copied from interface: ClientUserToken

Returns the java.lang.String representation of this client user token.

Specified by:

toString in interface ClientUserToken

Overrides:

toString in class Object

Returns:

the string format for this client user token.

getType

public String getType()

Specified by:

getType in interface com.sun.xml.ws.security.Token

getAppTokenID

public String getAppTokenID()

Returns the Application/Client token value.

Returns:

the Application/Client token value.