public class SAML20TokenProvider extends AbstractSecurityTokenProvider implements SecurityTokenProvider
A SecurityTokenProvider implementation that handles WS-Trust SAML 2.0 token requests.
SecurityTokenProvider.FAMILY_TYPEATTRIBUTE_PROVIDER, properties, REVOCATION_REGISTRY, REVOCATION_REGISTRY_FILE, REVOCATION_REGISTRY_JDBC_CONFIG, REVOCATION_REGISTRY_JPA_CONFIG, revocationRegistry, TOKEN_REGISTRY, TOKEN_REGISTRY_FILE, TOKEN_REGISTRY_JDBC, TOKEN_REGISTRY_JPA, tokenRegistry, USE_ABSOLUTE_KEYIDENTIFIER| Constructor and Description |
|---|
SAML20TokenProvider() |
| Modifier and Type | Method and Description |
|---|---|
void |
cancelToken(ProtocolContext protoContext)
Cancels the token contained in the specified request context.
|
String |
family()
The family where this security token provider belongs
|
QName |
getSupportedQName()
Provide an optional
QName for configuration |
void |
initialize(Map<String,String> properties)
Initializes the
SecurityTokenProvider using the specified properties map. |
void |
issueToken(ProtocolContext protoContext)
Generates a security token using the information contained in the specified request context and stores the newly-created
token in the context itself.
|
void |
renewToken(ProtocolContext protoContext)
Renews the security token contained in the specified request context.
|
boolean |
supports(String namespace)
Specify whether this token provider supports a particular namespace
|
String |
tokenType()
Token Type
|
void |
validateToken(ProtocolContext protoContext)
Evaluates the validity of the token contained in the specified request context and sets the result in the context itself.
|
public void initialize(Map<String,String> properties)
SecurityTokenProvider
Initializes the SecurityTokenProvider using the specified properties map.
initialize in interface SecurityTokenProviderinitialize in class AbstractSecurityTokenProviderproperties - a Map<String, String> that contains the properties that have been configured for this
SecurityTokenProvider.public void cancelToken(ProtocolContext protoContext) throws org.picketlink.common.exceptions.ProcessingException
SecurityTokenProviderCancels 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.
cancelToken in interface SecurityTokenProviderprotoContext - the ProtocolContext that contains the token to be canceled.org.picketlink.common.exceptions.ProcessingExceptionpublic void issueToken(ProtocolContext protoContext) throws org.picketlink.common.exceptions.ProcessingException
SecurityTokenProviderGenerates a security token using the information contained in the specified request context and stores the newly-created token in the context itself.
issueToken in interface SecurityTokenProviderprotoContext - the ProtocolContext to be used when generating the token.org.picketlink.common.exceptions.ProcessingExceptionpublic void renewToken(ProtocolContext protoContext) throws org.picketlink.common.exceptions.ProcessingException
SecurityTokenProviderRenews 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.
renewToken in interface SecurityTokenProviderprotoContext - the ProtocolContext that contains the token to be renewed.org.picketlink.common.exceptions.ProcessingExceptionpublic void validateToken(ProtocolContext protoContext) throws org.picketlink.common.exceptions.ProcessingException
SecurityTokenProviderEvaluates 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.
validateToken in interface SecurityTokenProviderprotoContext - the ProtocolContext that contains the token to be validated.org.picketlink.common.exceptions.ProcessingExceptionpublic boolean supports(String namespace)
SecurityTokenProvidersupports in interface SecurityTokenProvidernamespace - a string value representing a namespaceSecurityTokenProvider#supports(String)}public String tokenType()
SecurityTokenProvidertokenType in interface SecurityTokenProviderSecurityTokenProvider.tokenType()public QName getSupportedQName()
SecurityTokenProviderQName for configurationgetSupportedQName in interface SecurityTokenProviderSecurityTokenProvider.getSupportedQName()public String family()
SecurityTokenProviderfamily in interface SecurityTokenProviderSecurityTokenProvider.family()Copyright © 2013 JBoss Inc.. All Rights Reserved.