org.jboss.security.saml
Class SSOManager

java.lang.Object
  extended by org.jboss.security.saml.SSOManager
All Implemented Interfaces:
SSOManagerService

public class SSOManager
extends java.lang.Object
implements SSOManagerService

SSOManager is an implementation of the SSOManagerService that can be managed via a jmx-console

Author:
Sohil Shah - sohil.shah@jboss.com

Constructor Summary
SSOManager()
          Initializer
 
Method Summary
static java.lang.String cleanToken(java.lang.String ssoToken)
          A utility method used to cleanup the SSO token when received as a http cookie
static SingleSignOn findProcessor()
          A utility method used to find the SingleSignOn Processor
 SingleSignOn getProcessor()
          Returns the SingleSignOn implementation registered with the SSO system
static java.security.Principal getUserPrincipal(javax.servlet.http.HttpServletRequest request)
          This is method is used by the application to extract the Principal of the user authenticated into the system by the Single Sign On Engine.
static void processManualLoginNotification(javax.servlet.http.HttpServletRequest request, java.lang.String user)
          This method is used by the application to notify the SSOEngine that a particular user was manually authenticated by its authentication system.
 void setConf(java.lang.String confLocation)
          Sets the location of the configuration file for this service
 void start()
          Starts the JMX service
 void stop()
          Stops the JMX service
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SSOManager

public SSOManager()
Initializer

Method Detail

start

public void start()
Starts the JMX service


stop

public void stop()
Stops the JMX service


setConf

public void setConf(java.lang.String confLocation)
Sets the location of the configuration file for this service

Specified by:
setConf in interface SSOManagerService
Parameters:
confLocation -

getProcessor

public SingleSignOn getProcessor()
Returns the SingleSignOn implementation registered with the SSO system

Specified by:
getProcessor in interface SSOManagerService
Returns:

findProcessor

public static SingleSignOn findProcessor()
                                  throws SSOException
A utility method used to find the SingleSignOn Processor

Returns:
Throws:
SSOException

cleanToken

public static java.lang.String cleanToken(java.lang.String ssoToken)
A utility method used to cleanup the SSO token when received as a http cookie

Parameters:
ssoToken -
Returns:

processManualLoginNotification

public static void processManualLoginNotification(javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String user)
This method is used by the application to notify the SSOEngine that a particular user was manually authenticated by its authentication system. This will be typically used by applications using non-JAAS (non-container) based authentication mechanisms. This API call is not needed by applications that used container provided mechanisms like JAAS

Parameters:
request -
user -
Throws:
java.lang.IllegalArgumentException

getUserPrincipal

public static java.security.Principal getUserPrincipal(javax.servlet.http.HttpServletRequest request)
This is method is used by the application to extract the Principal of the user authenticated into the system by the Single Sign On Engine. This will be typically used by applications using non-JAAS (non-container) based authentication mechanisms. For applications using container managed authentication mechanisms like JAAS, the recommended approach is using a HttpServletRequest.getUserPrincipal call.

Parameters:
request -
Returns: