com.novell.admin.ns.ldap

Interface LDAPAuthenticationNamespace

All Known Subinterfaces:

LDAPNamespace

public interface LDAPAuthenticationNamespace

The LDAPAuthenticationNamespace extends the AuthenticationNamespace by adding methods which will authenticate an LDAP object using an SSL connection.

Method Summary

Modifier and Type	Method and Description
void	authenticate(java.lang.Object authenticatedObject) Authenticates an object.
void	authenticate(ObjectEntry obj, boolean ssl) Authenticates an LDAP object using SSL.
void	authenticate(java.lang.String obj, java.lang.String authenticateObject, java.lang.String password, boolean ssl) Authenticates an object.
void	authenticateServer(java.lang.String serverName, boolean ssl) Authenticates to a particular server.

Method Detail

authenticate

void authenticate(ObjectEntry obj,
                  boolean ssl)
           throws SPIException

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

Parameters:

obj - The object to authenticate.

ssl - boolean indicating whether or not to use SSL.

Throws:

SPIException - Thrown when the service providerk returns an error.

authenticate

void authenticate(java.lang.String obj,
                  java.lang.String authenticateObject,
                  java.lang.String password,
                  boolean ssl)
           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.

ssl - boolean indicating whether or not to use SSL.

Throws:

SPIException - Thrown when the service provider returns an error.

authenticate

void authenticate(java.lang.Object authenticatedObject)
           throws SPIException

Authenticates an object. This interface does not specify the object type required so that implementation specific classes do not need to be declared here. For example the JNDI implementation of LDAPNamespaceImpl requires an InitialLdapContext that has been authenticated to the Directory with a providerURL using the IP Address form.

Parameters:

authenticatedObject - - An authenticated object of the correct type. If the authenticatedObject is not the correct type for the implemenation, then an exception will be thrown.

Throws:

SPIException - Thrown if the authenticated object is not a valid type for this implementation or when the service provider returns an error.

authenticateServer

void authenticateServer(java.lang.String serverName,
                        boolean ssl)
                 throws SPIException

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

Parameters:

serverName - The server to authenticate to.

ssl - boolean indicating whether or not to use SSL.

Throws:

SPIException - Thrown when the service provider returns an error.