org.picketlink.identity.federation.core.sts

Class PicketLinkCoreSTS

java.lang.Object

org.picketlink.identity.federation.core.sts.PicketLinkCoreSTS

public class PicketLinkCoreSTS
extends Object

Generic STS Core.

This is a Singleton Class.

Since:

Dec 27, 2010

Author:

Anil.Saldhana@redhat.com

See Also:

#instance()}

Field Summary

Fields

Modifier and Type	Field and Description
protected STSCoreConfig	configuration
static RuntimePermission	rte

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PicketLinkCoreSTS()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelToken(ProtocolContext protocolContext) Cancels the token contained in the specified request context.
STSCoreConfig	getConfiguration()
protected STSConfiguration	getConfiguration(String fileName) Obtains the STS configuration options.
void	initialize(STSCoreConfig config)
void	installDefaultConfiguration(String... configFileName)
static PicketLinkCoreSTS	instance()
void	issueToken(ProtocolContext protocolContext) Issue a security token
void	renewToken(ProtocolContext protocolContext) Renews the security token contained in the specified request context.
void	validateToken(ProtocolContext protocolContext) Evaluates the validity of the token contained in the specified request context and sets the result in the context itself.

Methods inherited from class java.lang.Object

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

Field Detail

rte

public static final RuntimePermission rte

configuration

protected STSCoreConfig configuration

Constructor Detail

PicketLinkCoreSTS

protected PicketLinkCoreSTS()

Method Detail

instance

public static PicketLinkCoreSTS instance()

initialize

public void initialize(STSCoreConfig config)

installDefaultConfiguration

public void installDefaultConfiguration(String... configFileName)

issueToken

public void issueToken(ProtocolContext protocolContext)
                throws org.picketlink.common.exceptions.ProcessingException

Issue a security token

Parameters:

protocolContext -

Throws:

org.picketlink.common.exceptions.ProcessingException

{@link - SecurityException} if the caller does not have a runtime permission for "org.picketlink.sts"

renewToken

public void renewToken(ProtocolContext protocolContext)
                throws org.picketlink.common.exceptions.ProcessingException

Renews the security token contained in the specified request context. This method is used when a previously generated token has expired, generating a new version of the same token with different expiration semantics.

Parameters:

protocolContext - the ProtocolContext that contains the token to be renewed.

Throws:

org.picketlink.common.exceptions.ProcessingException - if an error occurs while renewing the security token.

{@link - SecurityException} if the caller does not have a runtime permission for "org.picketlink.sts"

cancelToken

public void cancelToken(ProtocolContext protocolContext)
                 throws org.picketlink.common.exceptions.ProcessingException

Cancels the token contained in the specified request context. A security token is usually canceled when one wants to make sure that the token will not be used anymore. A security token can't be renewed once it has been canceled.

Parameters:

protocolContext - the ProtocolContext that contains the token to be canceled.

Throws:

org.picketlink.common.exceptions.ProcessingException - if an error occurs while canceling the security token.

{@link - SecurityException} if the caller does not have a runtime permission for "org.picketlink.sts"

validateToken

public void validateToken(ProtocolContext protocolContext)
                   throws org.picketlink.common.exceptions.ProcessingException

Evaluates the validity of the token contained in the specified request context and sets the result in the context itself. The result can be a status, a new token, or both.

Parameters:

protocolContext - the ProtocolContext that contains the token to be validated.

Throws:

org.picketlink.common.exceptions.ProcessingException - if an error occurs while validating the security token.

{@link - SecurityException} if the caller does not have a runtime permission for "org.picketlink.sts"

getConfiguration

protected STSConfiguration getConfiguration(String fileName)
                                     throws org.picketlink.common.exceptions.ConfigurationException

Obtains the STS configuration options.

Returns:

an instance of STSConfiguration containing the STS configuration properties.

Throws:

org.picketlink.common.exceptions.ConfigurationException

getConfiguration

public STSCoreConfig getConfiguration()