org.aselect.authspserver.authsp.ldap
Class LDAPProtocolHandlerFactory

java.lang.Object
  extended by org.aselect.authspserver.authsp.ldap.LDAPProtocolHandlerFactory

public class LDAPProtocolHandlerFactory
extends java.lang.Object

A factory to create ILDAPProtocolHandler implementations.

Description:
The LDAPProtocolHandlerFactory can be used to instantiate different types of LDAPProtocolHandlers.

Concurrency issues:
The created ILDAPProtocolHandler can be used for one request.

Author:
Alfa & Ariss

Field Summary
static java.lang.String MODULE
          The module name.
 
Constructor Summary
LDAPProtocolHandlerFactory()
           
 
Method Summary
static java.util.Hashtable getContext(java.lang.Object oConfig, java.lang.String sUid, SystemLogger oSystemLogger)
          retrieve the context attributes of the user.
static ILDAPProtocolHandler instantiateProtocolHandler(java.lang.Object oConfig, java.lang.String sUid, AuthSPSystemLogger systemLogger)
          Instantiate a new ILDAPProtocolHandler implementation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE

public static final java.lang.String MODULE
The module name.

See Also:
Constant Field Values
Constructor Detail

LDAPProtocolHandlerFactory

public LDAPProtocolHandlerFactory()
Method Detail

instantiateProtocolHandler

public static ILDAPProtocolHandler instantiateProtocolHandler(java.lang.Object oConfig,
                                                              java.lang.String sUid,
                                                              AuthSPSystemLogger systemLogger)
                                                       throws ASelectException
Instantiate a new ILDAPProtocolHandler implementation.

Description:
Reads the context by calling getContext(Object, String, SystemLogger) and determin the type of ILDAPProtocolHandler. This class is instantiated and returned.

Concurrency issues:
-

Preconditions:
-

Postconditions:
-

Parameters:
oConfig - The configuration to be used.
sUid - the LDAP user ID.
systemLogger - The logger for system entries.
Returns:
An initialized ILDAPProtocolHandler.
Throws:
ASelectException - If instantiation or initialisation fails.

getContext

public static java.util.Hashtable getContext(java.lang.Object oConfig,
                                             java.lang.String sUid,
                                             SystemLogger oSystemLogger)
                                      throws ASelectException
retrieve the context attributes of the user.

Description:
Retrieve context attributes of the given user which are read from the configuration.

Concurrency issues:
-

Preconditions:
-

Postconditions:
-

Parameters:
oConfig - the configuration to be used.
sUid - The LDAp user ID.
oSystemLogger - The logger for system entries.
Returns:
A Hashtable with the context.
Throws:
ASelectException - If retrieving fails.


Copyright © 2008 SURFnet BV. All Rights Reserved.