com.sun.identity.wss.sts
インタフェース ClientUserToken


public interface ClientUserToken

This class extends XWSS Security Token and enables the STS Clients to use any custom tokens that can be used in WS-Trust protocol element OnBehalfOf. This element is used by the OpenSSO STS Service to allow any custom changes to the issued tokens by the STS. This is also known as End user token conversion interface (SPI) that can be implemented by any custom token implementation to convert any custom end user token to the token issued by Security Token Service. In this case, the identity or the owner of the token generated by STS, would be same as the End user token. The implementation of this interface can be configured at global Security Token Service configuration (via Admin Console) for server side and in client's AMConfig.properties for client side.


メソッドの概要
 String getPrincipalName()
          Returns the principal name that the client user token carries.
 void init(Object obj)
          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.
 

メソッドの詳細

init

void init(Object obj)
          throws FAMSTSException
Initializes client user token.

パラメータ:
obj - credential object to initialize the user token
例外:
FAMSTSException

parse

void parse(Element element)
           throws FAMSTSException
Parses the custom token element. This method is used at the receiving end (STS server side).

パラメータ:
element - the custom token element
例外:
FAMSTSException

getPrincipalName

String getPrincipalName()
                        throws FAMSTSException
Returns the principal name that the client user token carries.

戻り値:
the principal name that the client user token carries
例外:
FAMSTSException

toString

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

オーバーライド:
クラス Object 内の toString
戻り値:
the string format for this client user token.