This site is in the process of being reviewed and updated.
5.2 Common Parameters for Configuration
Parameters common to all protocol providers
Since all protocol provider Configuration beans inherit from the same ServiceConfiguration, they share many of the same configuration parameters.
Parameter |
Default value |
Description |
---|---|---|
enabled |
false |
Whether this service is enabled. |
ipPort |
No default. |
The IP port for this service. |
ipAddress |
No default. |
The IP address for this service. |
searchBaseDn |
"ou=users,dc=example,dc=com" |
The single location where entries are stored. The definition of "entries" depends on the protocol. For example, for LDAP, Kerberos, and Change Password, entries are users for purposes of authentication. For DNS, entries are resource records. If this property is not set the store will search the system partition configuration for catalog entries. Catalog support is highly experimental and is only tested in the OSGi build of ApacheDS using the Config Admin service. |
initialContextFactory |
"org.apache.directory.server.core.jndi.CoreContextFactory" |
The JNDI initial context factory to use. |
securityAuthentication |
"simple" |
The authentication mechanism to use for establishing a JNDI context. |
securityPrincipal |
"uid=admin,ou=system" |
The principal to use for establishing a JNDI context. |
securityCredentials |
"secret" |
The credentials to use for establishing a JNDI context. |
serviceName |
No default. |
The friendly name of this service. |
servicePid |
No default. |
The PID for this service. A PID is a unique identifier for an instance of a service. PID's are used by OSGi's Config Admin service to dynamically inject configuration into a service when the service is started. |
bufferSize |
No default. |
The MINA buffer size for this service. |
catalogBaseDn |
No default. |
The single location where catalog entries are stored. A catalog entry is a mapping of a realm (or zone for DNS) to a search base DN. If this property is not set the store will expect a single search base DN to be set. Catalog support is highly experimental and is only tested in the OSGi build of ApacheDS using the Config Admin service. |
More Information
For help with more advanced configurations, check out our Interoperability Guide .