DirectoryService (ApacheDS)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.directory.server.sar
Class DirectoryService

java.lang.Object
  ServiceMBeanSupport
      org.apache.directory.server.sar.DirectoryService

All Implemented Interfaces:: DirectoryServiceMBean

public class DirectoryService
extends ServiceMBeanSupport
implements DirectoryServiceMBean

JBoss 3.x Mbean for embedded and remote directory server support

Version:: $Rev: 434428 $, $Date: 2006-08-24 18:45:34 +0200 (Thu, 24 Aug 2006) $
Author:: Apache Directory Project
See Also:: Serialized Form

Field Summary
`static int`	`DEFAULT_LDAP_PORT` Default LDAP Listen Port
`static int`	`DEFAULT_LDAPS_PORT` Default LDAPS (SSL) Port

Constructor Summary
`DirectoryService()`

Method Summary
`java.lang.String`	`changedEmbeddedAdminPassword(java.lang.String oldPassword, java.lang.String newPassword)` Embedded server only - Changes the current password of the uid=admin user
`boolean`	`flushEmbeddedServerData()` Embedded server only - Flushes out any I/O buffer or write cache
`java.lang.String`	`getContextFactory()` Gets the name-to-object binding for Context INITIAL_CONTEXT_FACTORY
`java.lang.String`	`getContextProviderURL()` Gets the name-to-object binding for Context PROVIDER_URL
`java.lang.String`	`getContextSecurityAuthentication()` Gets the name-to-object binding for Context SECURITY_AUTHENTICATION
`java.lang.String`	`getContextSecurityCredentials()` Gets the name-to-object binding for Context SECURITY_CREDENTIALS
`java.lang.String`	`getContextSecurityPrincipal()` Gets the name-to-object binding for Context SECURITY_PRINCIPAL
`org.w3c.dom.Element`	`getEmbeddedAdditionalEnvProperties()` Gets the root element of the XML properties list of additional environment properties
`org.w3c.dom.Element`	`getEmbeddedCustomBootstrapSchema()` Gets the root element of the XML properties list of custom bootstrap schema properties
`java.lang.String`	`getEmbeddedCustomRootPartitionName()` Embedded server only - Gets the name of the root partion which was automatically created on server startup
`int`	`getEmbeddedLDAPPort()` Embedded server only - gets the LDAP listen port
`int`	`getEmbeddedLDAPSPort()` Embedded server only - gets the LDAPSSL) listen port (!NOT YET SUPPORTED!)
`java.lang.String`	`getEmbeddedLDIFdir()` Embedded server only - Gets the name of the LDIF import folder used by the server
`org.w3c.dom.Element`	`getEmbeddedLDIFFilters()` Gets the root element of the XML properties list of defined LDIF filters
`java.lang.String`	`getEmbeddedWkdir()` Embedded server only - Gets the name of the workfile folder used by the server
`boolean`	`isEmbeddedAccessControlEnabled()` Embedded server only - test if access control is enabled
`boolean`	`isEmbeddedAnonymousAccess()` Embedded server only - tests if anonymous access is permitted
`boolean`	`isEmbeddedEnableChangePassword()` Embedded server only - test if Change Password wire protocol is enabled
`boolean`	`isEmbeddedEnableKerberos()` Embedded server only - test if Kerberos wire protocol is enabled
`boolean`	`isEmbeddedEnableNtp()` Embedded server only - test if NTP wire protocol is enabled
`boolean`	`isEmbeddedLDAPNetworkingSupport()` Embedded server only - tests if LDAP wire protocol handler is to be started
`boolean`	`isEmbeddedServerEnabled()` Test to see if the directory service to use is embedded in this VM
`javax.naming.directory.DirContext`	`openDirContext()` Opens a directory context based on the currently assigned name-to-object bindings
`void`	`setContextFactory(java.lang.String factoryClass)` Sets the name-to-object binding for Context INITIAL_CONTEXT_FACTORY
`void`	`setContextProviderURL(java.lang.String providerURL)` Sets the name-to-object binding for Context PROVIDER_URL
`void`	`setContextSecurityAuthentication(java.lang.String securityAuthentication)` Sets the name-to-object binding for Context SECURITY_AUTHENTICATION
`void`	`setContextSecurityCredentials(java.lang.String securityCredentials)` Sets the name-to-object binding for Context SECURITY_CREDENTIALS
`void`	`setContextSecurityPrincipal(java.lang.String securityPrincipal)` Sets the name-to-object binding for Context SECURITY_PRINCIPAL
`void`	`setEmbeddedAccessControlEnabled(boolean enabled)` Embedded server only - Set if access control is enabled
`void`	`setEmbeddedAdditionalEnvProperties(org.w3c.dom.Element env)` Sets the root element of the XML properties list of additional environment properties
`void`	`setEmbeddedAnonymousAccess(boolean anonymousAccess)` Embedded server only - sests if anonymous access is permitted
`void`	`setEmbeddedCustomBootstrapSchema(org.w3c.dom.Element cfg)` Sets the root element of the XML properties list of custom bootstrap schema properties
`void`	`setEmbeddedCustomRootPartitionName(java.lang.String rootPartitianName)` Embedded server only - Sets the name of the root partion which is automatically created on server startup
`void`	`setEmbeddedEnableChangePassword(boolean enabled)` Embedded server only - set if Change Password wire protocol is enabled
`void`	`setEmbeddedEnableKerberos(boolean enabled)` Embedded server only - set if Kerberos wire protocol is enabled
`void`	`setEmbeddedEnableNtp(boolean enabled)` Embedded server only - set if NTP wire protocol is enabled
`void`	`setEmbeddedLDAPNetworkingSupport(boolean ldapNetworkingSupport)` Embedded server only - sests if LDAP wire protocol handler is to be started
`void`	`setEmbeddedLDAPPort(int ldapPort)` Embedded server only - sets the LDAP listen port
`void`	`setEmbeddedLDAPSPort(int ldapsPort)` Embedded server only - sets the LDAPS (SSL) listen port (!NOT YET SUPPORTED!)
`void`	`setEmbeddedLDIFdir(java.lang.String LDIFdir)` Embedded server only - Sets the name of the LDIF import folder used by the server
`void`	`setEmbeddedLDIFFilters(org.w3c.dom.Element fil)` Sets the root element of the XML properties list of defined LDIF filters
`void`	`setEmbeddedServerEnabled(boolean enabled)` Set if the directory service to use is embedded in this VM
`void`	`setEmbeddedWkdir(java.lang.String wkdir)` Embedded server only - Sets the name of the workfile folder used by the server
`protected void`	`startService()`
`protected void`	`stopService()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LDAP_PORT

public static final int DEFAULT_LDAP_PORT

Default LDAP Listen Port

See Also:: Constant Field Values

DEFAULT_LDAPS_PORT

public static final int DEFAULT_LDAPS_PORT

Default LDAPS (SSL) Port

See Also:: Constant Field Values

Constructor Detail

DirectoryService

public DirectoryService()

Method Detail

startService

protected void startService()
                     throws java.lang.Exception

Throws:: java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception

Throws:: java.lang.Exception