com.novell.emframe.dev.authenticator

Interface iMgrAuthenticator

public interface iMgrAuthenticator

Genenric authenticator interface

Since:

2.6

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.Object key) Get an attribute that has been added to the authenticator's AuthContext (Hashtable) object.
AuthContext	getAuthContext() Returns the AuthContext object that was passed in to the Authenticator's init method.
java.lang.String	getUserId(MContext context)
boolean	handleLogin(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Login using information available in the HttpServletRequest.
boolean	isAuthenticated(javax.servlet.http.HttpServletRequest req) Returns whether authentication has successfully occurred.
void	logout() Called by the framework when it determines that the authenticator must logout.
void	removeAttribute(java.lang.Object key) Removes the attribute key and associated value if present.
void	setAttribute(java.lang.Object key, java.lang.Object value) Sets an attribute in the authenticator's AuthContext (Hashtable) object.

Method Detail

isAuthenticated

boolean isAuthenticated(javax.servlet.http.HttpServletRequest req)

Returns whether authentication has successfully occurred.

Parameters:

req -

Returns:

boolean: true if authentication has successfully occurred, false if otherwise

handleLogin

boolean handleLogin(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)

Login using information available in the HttpServletRequest. If this method returns false. This means the authentication process is not complete. This method then must provide the response, which is normally a page to continue the login process (a login page). If the this method returns true, this method must NOT handle the response.

Parameters:

req - The HttpServletRequest object

res - The HttpServletResponse object

Returns:

boolean: true if login was successful, false if otherwise

setAttribute

void setAttribute(java.lang.Object key,
                  java.lang.Object value)

Sets an attribute in the authenticator's AuthContext (Hashtable) object.

Parameters:

key - Object key to use to identify the object

value - Object to save in the Hashtable

See Also:

getAttribute(java.lang.Object)

getAttribute

java.lang.Object getAttribute(java.lang.Object key)

Get an attribute that has been added to the authenticator's AuthContext (Hashtable) object.

Parameters:

key - Object key to retrieve the value. This is the key that was set when the attribute was added.

Returns:

Object value of the key

See Also:

setAttribute(java.lang.Object, java.lang.Object)

removeAttribute

void removeAttribute(java.lang.Object key)

Removes the attribute key and associated value if present. Attribute keys should be prefixed with the module id to avoid collisions.

Parameters:

Key - Object containing the attribute key whose associated value is to be removed This may not be null.

getAuthContext

AuthContext getAuthContext()

Returns the AuthContext object that was passed in to the Authenticator's init method. Implementing classes should save the AuthContext in a member variable.

Returns:

AuthContext object passed to the init method

See Also:

#init

logout

void logout()

Called by the framework when it determines that the authenticator must logout. If you call the logout method, the authenticator will still be held in the session until destroy is called.

See Also:

#destroy

getUserId

java.lang.String getUserId(MContext context)

Parameters:

context -

Returns:

String See specific