com.novell.emframe.dev

Class NPSFileAuthenticator

java.lang.Object

com.novell.emframe.dev.AuthBrokerAuthenticator

com.novell.emframe.dev.LazyAuthBrokerAuthenticator

com.novell.emframe.dev.NPSFileAuthenticator

Deprecated.

public class NPSFileAuthenticator
extends LazyAuthBrokerAuthenticator

iManager establishs a new NPSFile object every time the developer makes a request to the AuthenticationBroker. The developer is then responsible for any cleanup that may be required. At this time there is no cleanup required for the NPSFile object.

iManager is implemented as a LazyAuthBrokerAuthenticator and can therefore use a Properties parameter to pass in a specific URI when the getAPIObject is called. If the URI is not provided at the getAPIObject call the default ldap ip address and sys volume on Netware machines will be used.

This is not being used. Do we want to keep it. If so we should rename it.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NPSFILE_PASSWORD Deprecated. NPSFILE_PASSWORD = "NPSFILEAUTH_PASSWORD".
static java.lang.String	NPSFILE_URI Deprecated. NPSFILE_URI = "NPSFILEAUTH_URI".
static java.lang.String	NPSFILE_USERNAME Deprecated. NPSFILE_USERNAME = "NPSFILEAUTH_USERNAME".
static java.lang.String	NPSFILETYPE_LOCALACCESS Deprecated. NPSFILETYPE_LOCALACCESS = "NPSFILEAUTH_USELOCALACCESS".

Constructor Summary

Constructors

Constructor and Description
NPSFileAuthenticator() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	authenticate(java.lang.String ndapName, java.lang.String password, java.lang.String ndapAccessDomain, java.util.Properties properties) Deprecated. The getAPIObject(id, prop) call on the AuthenticationBroker will return this NPSFile object.
java.lang.Object	login(java.lang.String name, java.lang.String password, java.lang.String accessDomain, ManagementServiceSet manageSS) Deprecated. The implementation of AuthBrokerAuthenticator's login() method.
void	logout(java.lang.Object apiObject) Deprecated. The implementation of AuthBrokerAuthenticator's logout method.

Methods inherited from class com.novell.emframe.dev.AuthBrokerAuthenticator

destroy, init

Methods inherited from class java.lang.Object

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

Field Detail

NPSFILE_USERNAME

public static final java.lang.String NPSFILE_USERNAME

Deprecated.

NPSFILE_USERNAME = "NPSFILEAUTH_USERNAME".

See Also:

Constant Field Values

NPSFILE_PASSWORD

public static final java.lang.String NPSFILE_PASSWORD

Deprecated.

NPSFILE_PASSWORD = "NPSFILEAUTH_PASSWORD".

See Also:

Constant Field Values

NPSFILE_URI

public static final java.lang.String NPSFILE_URI

Deprecated.

NPSFILE_URI = "NPSFILEAUTH_URI".

See Also:

Constant Field Values

NPSFILETYPE_LOCALACCESS

public static final java.lang.String NPSFILETYPE_LOCALACCESS

Deprecated.

NPSFILETYPE_LOCALACCESS = "NPSFILEAUTH_USELOCALACCESS".

See Also:

Constant Field Values

Constructor Detail

NPSFileAuthenticator

public NPSFileAuthenticator()

Deprecated.

Method Detail

login

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

Deprecated.

The implementation of AuthBrokerAuthenticator's login() method. Called when the AuthBrokerAuthenticator should login. This method should return a non-null object or throw an error.

Specified by:

login in class AuthBrokerAuthenticator

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 void logout(java.lang.Object apiObject)

Deprecated.

The implementation of AuthBrokerAuthenticator's logout method. Called when the AuthBrokerAuthenticator should logout.

Specified by:

logout in class AuthBrokerAuthenticator

Parameters:

apiObject - containing the Object returned from the login method

authenticate

public java.lang.Object authenticate(java.lang.String ndapName,
                                     java.lang.String password,
                                     java.lang.String ndapAccessDomain,
                                     java.util.Properties properties)
                              throws AuthBrokerException

Deprecated.

The getAPIObject(id, prop) call on the AuthenticationBroker will return this NPSFile object. The NPSFile object emulates the Java File object calls for CIFS file access and local Java File access. Which type of NPSFile object created is determined by the parameters passed in. The calling user will then be responsible for the cleanup of the NPSFile object. The correct way to do this is to null out any variables that contain a reference to this object and let the finalizer be called during garbage collection.

The passed in properties object to the authbroker.getAPIOBject() call may or may not be null. If null, the default values of the logged in user, logged in password, and logged in address/sys volume will be used. The caller can override any or all of these values by setting up key value pairs in the passed in property object. Any/all of these values are optional.
NPSFileAuthenticator.NPSFILE_USERNAME - username to authenticate as, passed on to the NPSFILE. If the username and password are set to NPSFileAuthenticator.NPSFILETYPE_LOCALACCESS, local Java File access within the running JVM will be used, otherwise CIFS file access is used.
NPSFileAuthenticator.NPSFILE_PASSWORD - password to use for authentication
NPSFileAuthenticator.String NPSFILE_URI - URI address to connect to

Specified by:

authenticate in class LazyAuthBrokerAuthenticator

Parameters:

ndapName - String containing the user name in NDAP format

password - String containing the password

ndapAccessDomain - String containing the tree to login to

properties - Properties object to use to authenticate

Returns:

Object containing extra login object information

Throws:

AuthBrokerException - if login was unsuccessful