ClientUserToken (OpenAM Project 16.0.0-SNAPSHOT API)

All Superinterfaces:

com.sun.xml.ws.security.Token

All Known Implementing Classes:

STSClientUserToken
```
public interface ClientUserToken
extends com.sun.xml.ws.security.Token
```
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 OpenAM 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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.

Methods inherited from interface com.sun.xml.ws.security.Token
getTokenValue, getType

- Method Detail
  - init
```
void init(Object obj)
   throws FAMSTSException
```
    Initializes client user token.
    
    Parameters:
    
    obj - credential object to initialize the user token
    
    Throws:
    
    FAMSTSException
  - parse
```
void parse(Element element)
    throws FAMSTSException
```
    Parses the custom token element. This method is used at the receiving end (STS server side).
    
    Parameters:
    
    element - the custom token element
    
    Throws:
    
    FAMSTSException
  - getPrincipalName
```
String getPrincipalName()
                 throws FAMSTSException
```
    Returns the principal name that the client user token carries.
    
    Returns:
    
    the principal name that the client user token carries
    
    Throws:
    
    FAMSTSException
  - toString
```
String toString()
```
    Returns the java.lang.String representation of this client user token.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string format for this client user token.