com.novell.emframe.dev

Class AuthBrokerAuthenticator

java.lang.Object

com.novell.emframe.dev.AuthBrokerAuthenticator

Direct Known Subclasses:

LazyAuthBrokerAuthenticator

public abstract class AuthBrokerAuthenticator
extends java.lang.Object

Abstract class to implement to be an AuthBrokerAuthenticator.

Constructor Summary

Constructors

Constructor and Description
AuthBrokerAuthenticator()

Method Summary

Modifier and Type	Method and Description
static void	destroy() Overwritable method if the AuthBrokerAuthenticator wants to some cleanup.
static boolean	init() Overwritable method if the AuthBrokerAuthenticator wants to do some initialization.
abstract java.lang.Object	login(java.lang.String name, java.lang.String password, java.lang.String accessDomain, ManagementServiceSet manageSS) Abstract method called when the AuthBrokerAuthenticator should login.
abstract void	logout(java.lang.Object apiObject) Abstract method called when the AuthBrokerAuthenticator should logout.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthBrokerAuthenticator

public AuthBrokerAuthenticator()

Method Detail

init

public static boolean init()
                    throws AuthBrokerException

Overwritable method if the AuthBrokerAuthenticator wants to do some initialization.

Returns:

boolean true if init was successful, false if otherwise

Throws:

AuthBrokerException

destroy

public static void destroy()

Overwritable method if the AuthBrokerAuthenticator wants to some cleanup.

login

public abstract java.lang.Object login(java.lang.String name,
                                       java.lang.String password,
                                       java.lang.String accessDomain,
                                       ManagementServiceSet manageSS)
                                throws AuthBrokerException

Abstract method called when the AuthBrokerAuthenticator should login. This method should return a non-null object or throw an error.

Parameters:

name - Username to use to login

password - Password to use to login

accessDomain - Location to use to login (tree, server, etc...)

manageSS - ManagementServiceSet to use to login

Returns:

Object containing extra login object information

Throws:

AuthBrokerException - if login was unsuccessful

logout

public abstract void logout(java.lang.Object apiObject)

Abstract method called when the AuthBrokerAuthenticator should logout.

Parameters:

apiObject - containing the Object returned from the login method