org.kepler.authentication

Class AuthenticationManager

java.lang.Object

org.kepler.authentication.AuthenticationManager

public class AuthenticationManager
extends java.lang.Object

AuthenticationManager manages all the authentication issue for the user. It helps the user to get the proxy from the GAMA server. For details: http://kepler-project.org/Wiki.jsp?page=KeplerAuthenticationFramework Note: all of the get Proxy methods are synchronized to avoid multiple entries (which may cause multiple user login dialogs appear) from the actors.

Author:

Zhijie Guan guan@sdsc.edu

Method Summary

Modifier and Type	Method and Description
void	addProxyEntity(ProxyEntity pentity) adds a proxyEntity to the entity repository if it was authenticated outside of the AuthManager.
static AuthenticationService	getAuthenticationService(Domain domain) returns an instantiation of the correct AuthenticationService based on the serviceClass listed for the domain.
AuthenticationService	getAuthenticationService(java.lang.String domainName) return an AuthenticationService for the given domain name
static Domain	getDomain(java.lang.String domainName) returns a Domain for a given domainName
static AuthenticationManager	getManager() Part of singleton template, the only way to get an instance of AuthenticationManager
ProxyEntity	getProxy(java.lang.String domainName) This function retrieves back the user proxy within specified domain, adding ProxyEntity to AuthenticationManager's proxyRepository in the process.
ProxyEntity	peekProxy(java.lang.String domainName)
boolean	proxyExists(java.lang.String proxyCredential, java.lang.String domainName) Check if a credential with the given domain exists in this manager
void	revokeProxy(ProxyEntity entity)
void	setAuthenticationListener(AuthenticationListener listener) Set the authentication listener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getManager

public static AuthenticationManager getManager()

Part of singleton template, the only way to get an instance of AuthenticationManager

Returns:

The unique AuthenticationManager instance

getProxy

public ProxyEntity getProxy(java.lang.String domainName)
                     throws AuthenticationException

This function retrieves back the user proxy within specified domain, adding ProxyEntity to AuthenticationManager's proxyRepository in the process.

Parameters:

domain - Specified domain

Returns:

The requested proxy

Throws:

AuthenticationException

revokeProxy

public void revokeProxy(ProxyEntity entity)
                 throws AuthenticationException

Throws:

AuthenticationException

peekProxy

public ProxyEntity peekProxy(java.lang.String domainName)
                      throws AuthenticationException

Throws:

AuthenticationException

addProxyEntity

public void addProxyEntity(ProxyEntity pentity)
                    throws AuthenticationException

adds a proxyEntity to the entity repository if it was authenticated outside of the AuthManager.

Throws:

AuthenticationException

getAuthenticationService

public AuthenticationService getAuthenticationService(java.lang.String domainName)
                                               throws AuthenticationException

return an AuthenticationService for the given domain name

Throws:

AuthenticationException

getDomain

public static Domain getDomain(java.lang.String domainName)
                        throws AuthenticationException

returns a Domain for a given domainName

Throws:

AuthenticationException

getAuthenticationService

public static AuthenticationService getAuthenticationService(Domain domain)
                                                      throws java.lang.ClassNotFoundException,
                                                             java.lang.InstantiationException,
                                                             java.lang.IllegalAccessException

returns an instantiation of the correct AuthenticationService based on the serviceClass listed for the domain. This is set in the authServicesBundle.properties file

Throws:

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

proxyExists

public boolean proxyExists(java.lang.String proxyCredential,
                           java.lang.String domainName)

Check if a credential with the given domain exists in this manager

Parameters:

proxyCredential - the string of the credential

domaim - the given domain

Returns:

true if the credential with the given domain exists

setAuthenticationListener

public void setAuthenticationListener(AuthenticationListener listener)

Set the authentication listener

Parameters:

listener -