PicketLink Federation Core 2.1.6.Final-redhat-2

org.picketlink.identity.federation.core.wstrust.plugins.saml
Class SAML20TokenProvider

java.lang.Object
  extended by org.picketlink.identity.federation.core.sts.AbstractSecurityTokenProvider
      extended by org.picketlink.identity.federation.core.wstrust.plugins.saml.SAML20TokenProvider
All Implemented Interfaces:
SecurityTokenProvider

public class SAML20TokenProvider
extends AbstractSecurityTokenProvider
implements SecurityTokenProvider

A SecurityTokenProvider implementation that handles WS-Trust SAML 2.0 token requests.

Author:
Stefan Guilhen

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

SAML20TokenProvider

public SAML20TokenProvider()
Method Detail

initialize

public void initialize(Map<String,String> properties)
Description copied from interface: SecurityTokenProvider

Initializes the SecurityTokenProvider using the specified properties map.

Specified by:
initialize in interface SecurityTokenProvider
Overrides:
initialize in class AbstractSecurityTokenProvider
Parameters:
properties - a Map<String, String> that contains the properties that have been configured for this SecurityTokenProvider.

cancelToken

public void cancelToken(ProtocolContext protoContext)
                 throws ProcessingException
Description copied from interface: 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.

Specified by:
cancelToken in interface SecurityTokenProvider
Parameters:
protoContext - the ProtocolContext that contains the token to be canceled.
Throws:
ProcessingException

issueToken

public void issueToken(ProtocolContext protoContext)
                throws ProcessingException
Description copied from interface: SecurityTokenProvider

Generates a security token using the information contained in the specified request context and stores the newly-created token in the context itself.

Specified by:
issueToken in interface SecurityTokenProvider
Parameters:
protoContext - the ProtocolContext to be used when generating the token.
Throws:
ProcessingException

renewToken

public void renewToken(ProtocolContext protoContext)
                throws ProcessingException
Description copied from interface: 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.

Specified by:
renewToken in interface SecurityTokenProvider
Parameters:
protoContext - the ProtocolContext that contains the token to be renewed.
Throws:
ProcessingException

validateToken

public void validateToken(ProtocolContext protoContext)
                   throws ProcessingException
Description copied from interface: 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.

Specified by:
validateToken in interface SecurityTokenProvider
Parameters:
protoContext - the ProtocolContext that contains the token to be validated.
Throws:
ProcessingException

supports

public boolean supports(String namespace)
Description copied from interface: SecurityTokenProvider
Specify whether this token provider supports a particular namespace

Specified by:
supports in interface SecurityTokenProvider
Parameters:
namespace - a string value representing a namespace
Returns:
See Also:
SecurityTokenProvider#supports(String)}

tokenType

public String tokenType()
Description copied from interface: SecurityTokenProvider
Token Type

Specified by:
tokenType in interface SecurityTokenProvider
Returns:
See Also:
SecurityTokenProvider.tokenType()

getSupportedQName

public QName getSupportedQName()
Description copied from interface: SecurityTokenProvider
Provide an optional QName for configuration

Specified by:
getSupportedQName in interface SecurityTokenProvider
Returns:
See Also:
SecurityTokenProvider.getSupportedQName()

family

public String family()
Description copied from interface: SecurityTokenProvider
The family where this security token provider belongs

Specified by:
family in interface SecurityTokenProvider
Returns:
See Also:
SecurityTokenProvider.family()

PicketLink Federation Core 2.1.6.Final-redhat-2

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