|
PicketLink Federation Core 2.1.6.Final-redhat-2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.picketlink.identity.federation.core.sts.AbstractSecurityTokenProvider
org.picketlink.identity.federation.core.wstrust.plugins.saml.SAML20TokenProvider
public class SAML20TokenProvider
A SecurityTokenProvider
implementation that handles WS-Trust SAML 2.0 token requests.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.picketlink.identity.federation.core.interfaces.SecurityTokenProvider |
---|
SecurityTokenProvider.FAMILY_TYPE |
Field Summary |
---|
Fields inherited from class org.picketlink.identity.federation.core.sts.AbstractSecurityTokenProvider |
---|
ATTRIBUTE_PROVIDER, properties, REVOCATION_REGISTRY, REVOCATION_REGISTRY_FILE, REVOCATION_REGISTRY_JPA_CONFIG, revocationRegistry, TOKEN_REGISTRY, TOKEN_REGISTRY_FILE, tokenRegistry |
Constructor Summary | |
---|---|
SAML20TokenProvider()
|
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SAML20TokenProvider()
Method Detail |
---|
public void initialize(Map<String,String> properties)
SecurityTokenProvider
Initializes the SecurityTokenProvider
using the specified properties map.
initialize
in interface SecurityTokenProvider
initialize
in class AbstractSecurityTokenProvider
properties
- a Map<String, String>
that contains the properties that have been configured for this
SecurityTokenProvider
.public void cancelToken(ProtocolContext protoContext) throws ProcessingException
SecurityTokenProvider
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.
cancelToken
in interface SecurityTokenProvider
protoContext
- the ProtocolContext
that contains the token to be canceled.
ProcessingException
public void issueToken(ProtocolContext protoContext) throws ProcessingException
SecurityTokenProvider
Generates 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 SecurityTokenProvider
protoContext
- the ProtocolContext
to be used when generating the token.
ProcessingException
public void renewToken(ProtocolContext protoContext) throws ProcessingException
SecurityTokenProvider
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.
renewToken
in interface SecurityTokenProvider
protoContext
- the ProtocolContext
that contains the token to be renewed.
ProcessingException
public void validateToken(ProtocolContext protoContext) throws ProcessingException
SecurityTokenProvider
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.
validateToken
in interface SecurityTokenProvider
protoContext
- the ProtocolContext
that contains the token to be validated.
ProcessingException
public boolean supports(String namespace)
SecurityTokenProvider
supports
in interface SecurityTokenProvider
namespace
- a string value representing a namespace
SecurityTokenProvider#supports(String)}
public String tokenType()
SecurityTokenProvider
tokenType
in interface SecurityTokenProvider
SecurityTokenProvider.tokenType()
public QName getSupportedQName()
SecurityTokenProvider
QName
for configuration
getSupportedQName
in interface SecurityTokenProvider
SecurityTokenProvider.getSupportedQName()
public String family()
SecurityTokenProvider
family
in interface SecurityTokenProvider
SecurityTokenProvider.family()
|
PicketLink Federation Core 2.1.6.Final-redhat-2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |