com.novell.admin.ns

Interface AuthenticationNamespace

All Known Subinterfaces:

AdminNamespace, LDAPNamespace, NDSNamespace

public interface AuthenticationNamespace

This interface describes an authentication service for a namespace.

Method Summary

Modifier and Type	Method and Description
void	authenticate(ObjectEntry obj) Authenticates an object.
void	authenticate(java.lang.String obj, java.lang.String authenticateObject, java.lang.String password) Authenticates an object.
void	authenticateServer(java.lang.String serverName) Authenticates to a particular server.
void	changePassword(ObjectEntry obj) Changes a password for an object.
void	changePassword(ObjectEntry obj, java.lang.String oldPassword, java.lang.String newPassword) Changes a password for an object.
ObjectEntry	getAuthenticatedIdentity(ObjectEntry obj) Returns the identity for the current logged in user.
NScache	getLoginCache() This method is to get the Cache in form of a HashTable to be used in framework to write to the filesystem.
void	setPassword(ObjectEntry obj) Sets the password for an object.
void	setPassword(ObjectEntry obj, boolean showSetException)
void	setPassword(ObjectEntry obj, java.lang.String password) Sets the password for an object.
void	unAuthenticate(ObjectEntry obj) UnAuthenticates the object.
void	unAuthenticate(ObjectEntry obj, java.lang.String password) UnAuthenticates the object.

Method Detail

getAuthenticatedIdentity

ObjectEntry getAuthenticatedIdentity(ObjectEntry obj)
                              throws SPIException

Returns the identity for the current logged in user.

Parameters:

obj - Any ObjectEntry in the namespace. Note: For NDS, an ObjectEntry is used to obtain the tree name for which the user is logged in to.

Returns:

The ObjectEntry representing the user.

Throws:

SPIException - Thrown when the service provider returns an error.

changePassword

void changePassword(ObjectEntry obj)
             throws SPIException

Changes a password for an object. The user will be prompted for the old and new passwords.

Parameters:

obj - The object whose password will be changed.

Throws:

SPIException - Thrown when the service provider returns an error.

changePassword

void changePassword(ObjectEntry obj,
                    java.lang.String oldPassword,
                    java.lang.String newPassword)
             throws SPIException

Changes a password for an object.

Parameters:

obj - The object whose password will be changed.

oldPassword - The old password.

newPassword - The new password.

Throws:

SPIException - Thrown when the service provider returns an error.

setPassword

void setPassword(ObjectEntry obj)
          throws SPIException

Sets the password for an object. The user will be prompted for the new password. This typically can only be invoked by a privileged object.

Parameters:

obj - The object whose password will be changed.

Throws:

SPIException - Thrown when the service provider returns an error.

setPassword

void setPassword(ObjectEntry obj,
                 boolean showSetException)
          throws SPIException

Throws:

SPIException

setPassword

void setPassword(ObjectEntry obj,
                 java.lang.String password)
          throws SPIException

Sets the password for an object. This typically can only be invoked by a privileged object.

Parameters:

obj - The object whose password will be changed.

password - The new password.

Throws:

SPIException - Thrown when the service provider returns an error.

authenticate

void authenticate(ObjectEntry obj)
           throws SPIException

Authenticates an object. The user will be prompted for the password.

Parameters:

obj - The object to authenticate.

Throws:

SPIException - Thrown when the service provider returns an error.

authenticate

void authenticate(java.lang.String obj,
                  java.lang.String authenticateObject,
                  java.lang.String password)
           throws SPIException

Authenticates an object.

Parameters:

obj - The object to authenticate.

authenticateObject - The object to authenticate to. In NDS, this would be the tree.

password - The password.

Throws:

SPIException - Thrown when the service provider returns an error.

authenticateServer

void authenticateServer(java.lang.String serverName)
                 throws SPIException

Authenticates to a particular server. The user will be prompted for a password.

Parameters:

serverName - The server to authenticate to.

Throws:

SPIException - Thrown when the service provider returns an error.

unAuthenticate

void unAuthenticate(ObjectEntry obj)
             throws SPIException

UnAuthenticates the object. This is similar to logging out. The user will be prompted for the password.

Parameters:

obj - The object to unauthenticate.

Throws:

SPIException - Thrown when the service provider returns an error.

unAuthenticate

void unAuthenticate(ObjectEntry obj,
                    java.lang.String password)
             throws SPIException

UnAuthenticates the object. This is similar to logging out.

Parameters:

obj - The object to unauthenticate.

password - The password.

Throws:

SPIException - Thrown when the service provider returns an error.

getLoginCache

NScache getLoginCache()

This method is to get the Cache in form of a HashTable to be used in framework to write to the filesystem. This Cache is created to cache the Tree name and the respective ip address for the tree name.