Runtime components : Service components : LDAP Access Service : Tasks : Configuring the LDAP Access Service
  
Configuring the LDAP Access Service
Configuration of the LDAP Access Service can be done either at initialization, by using an LDAPService definition externalized in the services definition file; or at runtime, by calling one of the following methods on an instance of the LDAPService class:
▪ setAuthenticationMethod(String) - Sets the method used for authentication. It should be one of the values "none", "simple", or "strong".
▪ setAuthenticationCredentials(Object) - Sets the security credentials for this service: for example, the password. These credentials are used in conjunction with the security principal to determine the access levels to resources in the directory service.
▪ setAuthenticationPrincipal(Object) - Sets the authenticating principal, or identity of the user of this service; for example, Administrator. The principal is used in conjunction with the authentication credentials to determine access levels to the directory service.
▪ setProviderFactory(String) - Sets the service provider factory. The service provider factory is specific to the use of JNDI and is basically the name of a class identifying which specific set of classes, among many possible sets, will be used to provide concrete service for client requests. See the JDK 1.5 documentation on JNDI for more details.
▪ setProviderUrl(String) - Sets the URL of the LDAP server.
▪ addToEnvironment(String, Object) - Sets various environment properties that affect the behavior of JNDI (and thus this service). Consult the documentation on javax.naming.Context in JDK1.5 for a list of values recognized by JNDI.
A summary of the core attributes for initialization of the LDAP service is shown below. It includes the name of the attribute in the LDAPService class, the externalized name, and the Java accessor method.
LDAP Access Service attributes
 
Attribute Name
Externalized Name
Java Access Method
Mandatory
authenticationMethod
authMethod
setAuthenticationMethod(String)
No
authenticationCredentials
authCredentials
setAuthenticationCredentials( Object)
No
authenticationPrincipal
authPrincipal
setAuthenticationPrincipal(Object)
No
provideUrl factory
providerUrl
setProviderUrl(String)
Yes
factory
factory
setProviderFactory(String)
Yes
See LDAP service definitions for an example of an externalized definition for the LDAP service.
See also
Tasks