org.kepler.authentication

Class AuthenticationService

java.lang.Object

org.kepler.authentication.AuthenticationService

Direct Known Subclasses:

GAMAAuthenticationService, LDAPAuthenticationService

public abstract class AuthenticationService
extends java.lang.Object

AuthenticationService is responsible for contact the GAMA service and get back the credential for the user

Author:

Zhijie Guan guan@sdsc.edu

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationListener	authListener
protected java.lang.String	credential
protected java.lang.String	operationName
protected java.lang.String	password
protected java.lang.String	serviceURL
protected java.lang.String	userName

Constructor Summary

Constructors

Constructor and Description
AuthenticationService()

Method Summary

Modifier and Type	Method and Description
abstract ProxyEntity	authenticate(Domain domain) Authenticate a user
java.lang.String	getCredential()
boolean	isAuthenticated() Note, currently unused, and authenticate(null) will cause NPE.
void	setAuthenticationListener(AuthenticationListener listener) Set the authentication listener
void	setOperationName(java.lang.String operationName)
void	setPassword(java.lang.String password)
void	setServiceURL(java.lang.String serviceURL)
void	setUserName(java.lang.String userName)
abstract void	unauthenticate(ProxyEntity proxy) Unauthenticate a user

Methods inherited from class java.lang.Object

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

Field Detail

serviceURL

protected java.lang.String serviceURL

operationName

protected java.lang.String operationName

userName

protected java.lang.String userName

password

protected java.lang.String password

credential

protected java.lang.String credential

authListener

protected AuthenticationListener authListener

Constructor Detail

AuthenticationService

public AuthenticationService()

Method Detail

setOperationName

public void setOperationName(java.lang.String operationName)

Parameters:

operationName - The operationName to set.

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - The password to set.

setServiceURL

public void setServiceURL(java.lang.String serviceURL)

Parameters:

serviceURL - The serviceURL to set.

setUserName

public void setUserName(java.lang.String userName)

Parameters:

userName - The userName to set.

isAuthenticated

public boolean isAuthenticated()
                        throws AuthenticationException

Note, currently unused, and authenticate(null) will cause NPE. Function: to check if the user can get authentication correctly. Note: need to talk with GAMA group to see what will be returned if something is wrong

Returns:

True/False to state if the user get authenticated or not

Throws:

AuthenticationException

getCredential

public java.lang.String getCredential()

Returns:

Credential to the user

setAuthenticationListener

public void setAuthenticationListener(AuthenticationListener listener)

Set the authentication listener

Parameters:

listener -

authenticate

public abstract ProxyEntity authenticate(Domain domain)
                                  throws AuthenticationException

Authenticate a user

Throws:

AuthenticationException

unauthenticate

public abstract void unauthenticate(ProxyEntity proxy)
                             throws AuthenticationException

Unauthenticate a user

Throws:

AuthenticationException