public class PicketLinkCoreSTS extends Object
Generic STS Core.
This is a Singleton Class.
#instance()}
Modifier and Type | Field and Description |
---|---|
protected STSCoreConfig |
configuration |
static RuntimePermission |
rte |
Modifier | Constructor and Description |
---|---|
protected |
PicketLinkCoreSTS() |
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.
|
public static final RuntimePermission rte
protected STSCoreConfig configuration
public static PicketLinkCoreSTS instance()
public void initialize(STSCoreConfig config)
public void installDefaultConfiguration(String... configFileName)
public void issueToken(ProtocolContext protocolContext) throws ProcessingException
protocolContext
- ProcessingException
{@link
- SecurityException} if the caller does not have a runtime permission for "org.picketlink.sts"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.
protocolContext
- the ProtocolContext
that contains the token to be renewed.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"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.
protocolContext
- the ProtocolContext
that contains the token to be canceled.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"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.
protocolContext
- the ProtocolContext
that contains the token to be validated.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"protected STSConfiguration getConfiguration(String fileName) throws ConfigurationException
Obtains the STS configuration options.
STSConfiguration
containing the STS configuration properties.ConfigurationException
public STSCoreConfig getConfiguration()
Copyright © 2020 JBoss by Red Hat. All rights reserved.