com.highqsoft.avalon

Interface LDAPCheckInterface

All Known Implementing Classes:

LDAPCheck, LDAPCheckBase, LDAPCheckImpl

public interface LDAPCheckInterface

The LDAPCheck interface.

Implementors can use RuntimeException at every point to signal internal problems.

If the implementation allows a default constructor, AoFactory will use it to get an instance. If the implementation doesn't allow the default constructor, AoFactory tries to get the instance by passing an options string to the constructor.

Once an instance is created by the AoFactory, it will be used before a session is created to convert the options string of session.

Since:

$Date: 2017/04/06 13:28:33 $

Version:

$Revision: 1.16 $

Author:

karst

See Also:

AoFactory, LDAPCheckImpl

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	checkAuth(java.lang.String auth, java.lang.String factory) Check the authentication string at the LDAP Server.
NameValue[]	checkAuthNameValue(NameValue[] nvauth, java.lang.String factory) Check the authentication namevalue array at the LDAP Server.
void	close() Close the connections that are necessary to made the checks.
void	init(java.lang.String factory) Initialize the LDAP communication.

Method Detail

init

void init(java.lang.String factory)

Initialize the LDAP communication.
This method is called once directly after the instance was created.

Parameters:

factory - the name of the factory or service

checkAuth

java.lang.String checkAuth(java.lang.String auth,
                         java.lang.String factory)
                           throws AoException

Check the authentication string at the LDAP Server. This method is called by AoFactory at every time a new session should be created. The implementation can use the authentication string coming from client and the name of the factory to return an authentication string that will be used to create a new session.

Parameters:

auth - the authentication string

factory - the name of the factory or service

Returns:

the new authentication string from the LDAP server

Throws:

the - ASAM ODS Exception whit the error code AO_CONNECT_REFUSED.

AoException

checkAuthNameValue

NameValue[] checkAuthNameValue(NameValue[] nvauth,
                             java.lang.String factory)
                               throws AoException

Check the authentication namevalue array at the LDAP Server. This method is called by AoFactory at every time a new session should be created. The implementation can use the authentication name value array coming from client and the name of the factory to return an authentication name value array that will be used to create a new session.

Parameters:

nvauth - the authentication namevalue array

factory - the name of the factory or service

Returns:

the new authentication name value array from the LDAP server

Throws:

the - ASAM ODS Exception whit the error code AO_CONNECT_REFUSED.

AoException

close

void close()

Close the connections that are necessary to made the checks.
This method will be called when the AoFactory finalize method is started.