PicketLink Federation Common Server Bindings for JBoss AS 2.1.6.Final-redhat-2

org.picketlink.identity.federation.bindings.jboss.auth
Class SAMLTokenFromHttpRequestAbstractLoginModule

java.lang.Object
  extended by org.jboss.security.auth.spi.AbstractServerLoginModule
      extended by org.picketlink.identity.federation.bindings.jboss.auth.SAMLTokenFromHttpRequestAbstractLoginModule
All Implemented Interfaces:
LoginModule
Direct Known Subclasses:
SAML2STSCommonLoginModule, SAMLTokenCertValidatingCommonLoginModule

public abstract class SAMLTokenFromHttpRequestAbstractLoginModule
extends org.jboss.security.auth.spi.AbstractServerLoginModule

This is not login module with full functionality. It just adds ability to get SAML token from http header specified by module option.

Author:
Peter Skopek: pskopek at redhat dot com

Field Summary
static String BASE64_TOKEN_ENCODING
          Token encoding type: base64
static String GZIP_TOKEN_ENCODING
          Token encoding type: gzip
protected static PicketLinkLogger logger
           
static String NONE_TOKEN_ENCODING
          Token encoding type: none
static String REG_EX_GROUP_KEY
           
static String REG_EX_PATTERN_KEY
           
static String SAML_TOKEN_HTTP_HEADER_KEY
           
static String TOKEN_ENCODING_TYPE_KEY
          Key to specify token compression.
protected  String tokenEncoding
           
static String WEB_REQUEST_KEY
           
 
Fields inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule
callbackHandler, log, loginOk, options, principalClassName, sharedState, subject, unauthenticatedIdentity, useFirstPass
 
Constructor Summary
SAMLTokenFromHttpRequestAbstractLoginModule()
           
 
Method Summary
protected  SamlCredential getCredentialFromHttpRequest()
           
 String getSamlTokenHttpHeader()
           
 String getSamlTokenHttpHeaderRegEx()
           
 int getSamlTokenHttpHeaderRegExGroup()
           
 String getTokenEncoding()
           
 void initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
           
 
Methods inherited from class org.jboss.security.auth.spi.AbstractServerLoginModule
abort, addValidOptions, checkOptions, commit, createGroup, createIdentity, getCallerPrincipalGroup, getIdentity, getRoleSets, getUnauthenticatedIdentity, getUseFirstPass, login, logout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected static final PicketLinkLogger logger

tokenEncoding

protected String tokenEncoding

TOKEN_ENCODING_TYPE_KEY

public static final String TOKEN_ENCODING_TYPE_KEY
Key to specify token compression. Supported types: GZIP_TOKEN_ENCODING - gzip BASE64_TOKEN_ENCODING - base64 NONE_TOKEN_ENCODING - none

See Also:
Constant Field Values

GZIP_TOKEN_ENCODING

public static final String GZIP_TOKEN_ENCODING
Token encoding type: gzip

See Also:
Constant Field Values

NONE_TOKEN_ENCODING

public static final String NONE_TOKEN_ENCODING
Token encoding type: none

See Also:
Constant Field Values

BASE64_TOKEN_ENCODING

public static final String BASE64_TOKEN_ENCODING
Token encoding type: base64

See Also:
Constant Field Values

WEB_REQUEST_KEY

public static final String WEB_REQUEST_KEY
See Also:
Constant Field Values

REG_EX_PATTERN_KEY

public static final String REG_EX_PATTERN_KEY
See Also:
Constant Field Values

REG_EX_GROUP_KEY

public static final String REG_EX_GROUP_KEY
See Also:
Constant Field Values

SAML_TOKEN_HTTP_HEADER_KEY

public static final String SAML_TOKEN_HTTP_HEADER_KEY
See Also:
Constant Field Values
Constructor Detail

SAMLTokenFromHttpRequestAbstractLoginModule

public SAMLTokenFromHttpRequestAbstractLoginModule()
Method Detail

getCredentialFromHttpRequest

protected SamlCredential getCredentialFromHttpRequest()
                                               throws Exception
Throws:
Exception

getTokenEncoding

public String getTokenEncoding()
Returns:
the tokenEncoding

getSamlTokenHttpHeader

public String getSamlTokenHttpHeader()
Returns:
the samlTokenHttpHeader

getSamlTokenHttpHeaderRegEx

public String getSamlTokenHttpHeaderRegEx()
Returns:
the samlTokenHttpHeaderRegEx

getSamlTokenHttpHeaderRegExGroup

public int getSamlTokenHttpHeaderRegExGroup()
Returns:
the samlTokenHttpHeaderRegExGroup

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map<String,?> sharedState,
                       Map<String,?> options)
Specified by:
initialize in interface LoginModule
Overrides:
initialize in class org.jboss.security.auth.spi.AbstractServerLoginModule

PicketLink Federation Common Server Bindings for JBoss AS 2.1.6.Final-redhat-2

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