org.jboss.identity.federation.api.wstrust
Interface STSConfiguration

public interface STSConfiguration

The STSConfiguration interface allows access to the security token service (STS) configuration attributes.

Author:

Stefan Guilhen

Method Summary

boolean	getEncryptIssuedToken() Indicates whether the issued token must be encrypted or not.
long	getIssuedTokenTimeout() Obtains the timeout value (in milliseconds) for issued tokens.
java.util.Map<java.lang.String,java.lang.Object>	getOptions() Obtains a Map that contains the non-standard configuration options.
SecurityTokenProvider	getProviderForService(java.lang.String serviceName) Given the name of a service provider, obtains the provider that must be used when issuing tokens to clients of that service.
SecurityTokenProvider	getProviderForTokenType(java.lang.String tokenType) Given a token type, obtains the token provider that should be used to handle token requests of that type.
java.lang.String	getSTSName() Obtains the unique name of the secure token service.
java.lang.String	getTokenTypeForService(java.lang.String serviceName) Given the name of a service provider, obtains the type of the token that should be used when issuing tokens to clients of that service.

Method Detail

getSTSName

java.lang.String getSTSName()

Obtains the unique name of the secure token service.

Returns:

a String representing the STS name.

getEncryptIssuedToken

boolean getEncryptIssuedToken()

Indicates whether the issued token must be encrypted or not.

Returns:

true if the issued token must be encrypted; false otherwise.

getIssuedTokenTimeout

long getIssuedTokenTimeout()

Obtains the timeout value (in milliseconds) for issued tokens.

Returns:

the token timeout value.

getTokenTypeForService

java.lang.String getTokenTypeForService(java.lang.String serviceName)

Given the name of a service provider, obtains the type of the token that should be used when issuing tokens to clients of that service.

Parameters:

serviceName - the name of the service provider that requires a token from its clients.

Returns:

a String representing the type of the token that suits the specified service.

getProviderForService

SecurityTokenProvider getProviderForService(java.lang.String serviceName)

Given the name of a service provider, obtains the provider that must be used when issuing tokens to clients of that service. When requesting a token to the STS, a client can specify the service it needs the token for using the AppliesTo element. Based on the service provider name, the STS identifies the type of the token that is to be issued and then selects the appropriate token provider to handle the request.

Parameters:

serviceName - the name of the service provider that requires a token from its clients.

Returns:

a reference to the SecurityTokenProvider that must be used in order to issue tokens to clients of the specified service.

getProviderForTokenType

SecurityTokenProvider getProviderForTokenType(java.lang.String tokenType)

Given a token type, obtains the token provider that should be used to handle token requests of that type. When a client doesn't specify the service provider name through the AppliesTo element, it must specify the token type through the TokenType element. The STS uses the supplied type to select the appropriate token provider.

Parameters:

tokenType - a String representing the type of the token.

Returns:

a reference to the SecurityTokenProvider that must be used to handle token requests of the specified type.

getOptions

java.util.Map<java.lang.String,java.lang.Object> getOptions()

Obtains a Map that contains the non-standard configuration options.

Returns:

a Map<String, Object> containing the additional configuration options.