PicketLink Federation Core 2.1.6.Final-redhat-2

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

java.lang.Object
  extended by 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
protected  STSCoreConfig configuration
           
static RuntimePermission rte
           
 
Constructor Summary
protected PicketLinkCoreSTS()
           
 
Method Summary
 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 ProcessingException
Issue a security token

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

renewToken

public void renewToken(ProtocolContext protocolContext)
                throws 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:
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 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:
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 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:
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 ConfigurationException

Obtains the STS configuration options.

Returns:
an instance of STSConfiguration containing the STS configuration properties.
Throws:
ConfigurationException

getConfiguration

public STSCoreConfig getConfiguration()

PicketLink Federation Core 2.1.6.Final-redhat-2

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.