org.apache.ldap.server.jndi
Class EnvKeys

java.lang.Object
  extended byorg.apache.ldap.server.jndi.EnvKeys

public class EnvKeys
extends java.lang.Object

JNDI environment property key constants.

Version:
$Rev$
Author:
Apache Directory Project

Field Summary
static java.lang.String ATTRIBUTES
          the envprop key base to the Attributes for the context nexus entry
static java.lang.String AUTHENTICATOR_CLASS
          the envprop key base to the authenticator implementation class
static java.lang.String AUTHENTICATOR_PROPERTIES
          the envprop key base to the properties of an authenticator
static java.lang.String AUTHENTICATORS
          a comma separated list of authenticator names
static java.lang.String DISABLE_ANONYMOUS
          bootstrap prop: if key is present it enables anonymous users
static java.lang.String DISABLE_PROTOCOL
          key used to disable the networking layer (wire protocol)
static java.lang.String ENABLE_KERBEROS
          Switch used to start up the kerberos server.
static java.lang.String INDICES
          the envprop key base to the space separated list of indices for a partition
static java.lang.String INTERCEPTORS
          Bootstrap property: Interceptor or InterceptorChain that will intercept directory operations when they are invoked.
static java.lang.String LDAP_PORT
          key for port setting for ldap requests beside default 389
static java.lang.String LDAPS_PORT
          key for port setting for secure ldap requests besides default 636
static java.lang.String PARTITION_CLASS
          the envprop key base to the implementation of a partition
static java.lang.String PARTITION_PROPERTIES
          the envprop key base to the properties of a partition
static java.lang.String PARTITIONS
          a comma separated list of partition names
static java.lang.String PASSTHRU
          key used to hold the MINA registry instance to use rather than creating one
static java.lang.String SCHEMAS
          a comma separated list of schema class files to load
static java.lang.String SHUTDOWN
          property used to shutdown the system
static java.lang.String SUFFIX
          the envprop key base to the suffix of a partition
static java.lang.String SYNC
          property used to sync the system with disk
static java.lang.String TEST_ENTRIES
          Unfortunately to test non-root user startup of the core and make sure all the appropriate functionality is there we need to load more user entries at startup due to a chicken and egg like problem.
static java.lang.String WKDIR
          bootstrap prop: path to eve's working directory - relative or absolute
 
Constructor Summary
EnvKeys()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SHUTDOWN

public static final java.lang.String SHUTDOWN
property used to shutdown the system

See Also:
Constant Field Values

SYNC

public static final java.lang.String SYNC
property used to sync the system with disk

See Also:
Constant Field Values

WKDIR

public static final java.lang.String WKDIR
bootstrap prop: path to eve's working directory - relative or absolute

See Also:
Constant Field Values

SCHEMAS

public static final java.lang.String SCHEMAS
a comma separated list of schema class files to load

See Also:
Constant Field Values

DISABLE_ANONYMOUS

public static final java.lang.String DISABLE_ANONYMOUS
bootstrap prop: if key is present it enables anonymous users

See Also:
Constant Field Values

AUTHENTICATORS

public static final java.lang.String AUTHENTICATORS
a comma separated list of authenticator names

See Also:
Constant Field Values

AUTHENTICATOR_CLASS

public static final java.lang.String AUTHENTICATOR_CLASS
the envprop key base to the authenticator implementation class

See Also:
Constant Field Values

AUTHENTICATOR_PROPERTIES

public static final java.lang.String AUTHENTICATOR_PROPERTIES
the envprop key base to the properties of an authenticator

See Also:
Constant Field Values

INTERCEPTORS

public static final java.lang.String INTERCEPTORS
Bootstrap property: Interceptor or InterceptorChain that will intercept directory operations when they are invoked. You don't need to specify this property if you want to use the default interceptor chain. If you specify this property, you might have to add some default interceptors in org.apache.ldap.server.jndi.invocation.interceptor package in your custom interceptor chain.

Here is an example of how to pass configuration values to interceptor:

 # Passes property 'propA=3' to the root interceptor chain.
 server.interceptors#propA=3
 # Passes property 'propB=7' to the interceptor whose name is 'myinterceptor'.
 server.interceptors.myinterceptor#propB=7
 # Passes property 'propC=9' to an interceptor 'yourinterceptor' whose
 # parent is an interceptor chain 'childChain' which is a child of the
 # root interceptor chain. 
 server.interceptors.childChain.yourinterceptor#propC=9
 

See Also:
Constant Field Values

DISABLE_PROTOCOL

public static final java.lang.String DISABLE_PROTOCOL
key used to disable the networking layer (wire protocol)

See Also:
Constant Field Values

PASSTHRU

public static final java.lang.String PASSTHRU
key used to hold the MINA registry instance to use rather than creating one

See Also:
Constant Field Values

LDAP_PORT

public static final java.lang.String LDAP_PORT
key for port setting for ldap requests beside default 389

See Also:
Constant Field Values

LDAPS_PORT

public static final java.lang.String LDAPS_PORT
key for port setting for secure ldap requests besides default 636

See Also:
Constant Field Values

PARTITIONS

public static final java.lang.String PARTITIONS
a comma separated list of partition names

See Also:
Constant Field Values

SUFFIX

public static final java.lang.String SUFFIX
the envprop key base to the suffix of a partition

See Also:
Constant Field Values

PARTITION_CLASS

public static final java.lang.String PARTITION_CLASS
the envprop key base to the implementation of a partition

See Also:
Constant Field Values

PARTITION_PROPERTIES

public static final java.lang.String PARTITION_PROPERTIES
the envprop key base to the properties of a partition

See Also:
Constant Field Values

INDICES

public static final java.lang.String INDICES
the envprop key base to the space separated list of indices for a partition

See Also:
Constant Field Values

ATTRIBUTES

public static final java.lang.String ATTRIBUTES
the envprop key base to the Attributes for the context nexus entry

See Also:
Constant Field Values

TEST_ENTRIES

public static final java.lang.String TEST_ENTRIES
Unfortunately to test non-root user startup of the core and make sure all the appropriate functionality is there we need to load more user entries at startup due to a chicken and egg like problem. The value of this property is a list of attributes to be added. It should only be used to test the server and not as a feature since it may go away.

See Also:
Constant Field Values

ENABLE_KERBEROS

public static final java.lang.String ENABLE_KERBEROS
Switch used to start up the kerberos server. This should be used when firing up the server for the first time. This is used with the ServerContextFactory which means the property should probably not be here.

See Also:
Constant Field Values
Constructor Detail

EnvKeys

public EnvKeys()


Copyright © 2002-2005 . All Rights Reserved.