org.apache.directory.server.sar
Interface DirectoryServiceMBean

All Known Implementing Classes:
DirectoryService

public interface DirectoryServiceMBean

JBoss 3.x Mbean interface 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

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
 

Method Detail

getEmbeddedLDIFFilters

public org.w3c.dom.Element getEmbeddedLDIFFilters()
Gets the root element of the XML properties list of defined LDIF filters

Returns:
The root DOM element

setEmbeddedLDIFFilters

public void setEmbeddedLDIFFilters(org.w3c.dom.Element fil)
Sets the root element of the XML properties list of defined LDIF filters

Parameters:
fil - The root DOM element

getEmbeddedAdditionalEnvProperties

public org.w3c.dom.Element getEmbeddedAdditionalEnvProperties()
Gets the root element of the XML properties list of additional environment properties

Returns:
The root DOM element

setEmbeddedAdditionalEnvProperties

public void setEmbeddedAdditionalEnvProperties(org.w3c.dom.Element env)
Sets the root element of the XML properties list of additional environment properties

Parameters:
env - The root DOM element

getEmbeddedCustomBootstrapSchema

public org.w3c.dom.Element getEmbeddedCustomBootstrapSchema()
Gets the root element of the XML properties list of custom bootstrap schema properties

Returns:
The root DOM element

setEmbeddedCustomBootstrapSchema

public void setEmbeddedCustomBootstrapSchema(org.w3c.dom.Element cfg)
Sets the root element of the XML properties list of custom bootstrap schema properties

Parameters:
cfg - The root DOM element

isEmbeddedServerEnabled

public boolean isEmbeddedServerEnabled()
Test to see if the directory service to use is embedded in this VM

Returns:
True if embedded else false

setEmbeddedServerEnabled

public void setEmbeddedServerEnabled(boolean enabled)
Set if the directory service to use is embedded in this VM

Parameters:
enabled - True if embedded else false

getContextFactory

public java.lang.String getContextFactory()
Gets the name-to-object binding for Context INITIAL_CONTEXT_FACTORY

Returns:
Context.INITIAL_CONTEXT_FACTORY

setContextFactory

public void setContextFactory(java.lang.String factoryClass)
Sets the name-to-object binding for Context INITIAL_CONTEXT_FACTORY

Parameters:
factoryClass - Context.INITIAL_CONTEXT_FACTORY value

getContextProviderURL

public java.lang.String getContextProviderURL()
Gets the name-to-object binding for Context PROVIDER_URL

Returns:
Context.PROVIDER_URL

setContextProviderURL

public void setContextProviderURL(java.lang.String providerURL)
Sets the name-to-object binding for Context PROVIDER_URL

Parameters:
providerURL - Context.PROVIDER_URL value

getContextSecurityAuthentication

public java.lang.String getContextSecurityAuthentication()
Gets the name-to-object binding for Context SECURITY_AUTHENTICATION

Returns:
Context.SECURITY_AUTHENTICATION

setContextSecurityAuthentication

public void setContextSecurityAuthentication(java.lang.String securityAuthentication)
Sets the name-to-object binding for Context SECURITY_AUTHENTICATION

Parameters:
securityAuthentication - Context.SECURITY_AUTHENTICATION value

getContextSecurityPrincipal

public java.lang.String getContextSecurityPrincipal()
Gets the name-to-object binding for Context SECURITY_PRINCIPAL

Returns:
Context.SECURITY_PRINCIPAL

setContextSecurityPrincipal

public void setContextSecurityPrincipal(java.lang.String securityPrincipal)
Sets the name-to-object binding for Context SECURITY_PRINCIPAL

Parameters:
securityPrincipal - Context.SECURITY_PRINCIPAL value

getContextSecurityCredentials

public java.lang.String getContextSecurityCredentials()
Gets the name-to-object binding for Context SECURITY_CREDENTIALS

Returns:
Context.SECURITY_CREDENTIALS

setContextSecurityCredentials

public void setContextSecurityCredentials(java.lang.String securityCredentials)
Sets the name-to-object binding for Context SECURITY_CREDENTIALS

Parameters:
securityCredentials - Context.SECURITY_CREDENTIALS value

openDirContext

public javax.naming.directory.DirContext openDirContext()
                                                 throws javax.naming.NamingException
Opens a directory context based on the currently assigned name-to-object bindings

Returns:
A valid directory context or null on error
Throws:
javax.naming.NamingException

flushEmbeddedServerData

public boolean flushEmbeddedServerData()
Embedded server only - Flushes out any I/O buffer or write cache

Returns:
True if flush succeeded else false

changedEmbeddedAdminPassword

public java.lang.String changedEmbeddedAdminPassword(java.lang.String oldPassword,
                                                     java.lang.String newPassword)
Embedded server only - Changes the current password of the uid=admin user

Parameters:
oldPassword - Old password for verification
newPassword - New password to use
Returns:
Confirmation message for UI display

isEmbeddedAnonymousAccess

public boolean isEmbeddedAnonymousAccess()
Embedded server only - tests if anonymous access is permitted

Returns:
True if permitted else false

setEmbeddedAnonymousAccess

public void setEmbeddedAnonymousAccess(boolean anonymousAccess)
Embedded server only - sests if anonymous access is permitted

Parameters:
anonymousAccess - True to allow else false

isEmbeddedLDAPNetworkingSupport

public boolean isEmbeddedLDAPNetworkingSupport()
Embedded server only - tests if LDAP wire protocol handler is to be started

Returns:
True if LDAP wire protocol in use else false

setEmbeddedLDAPNetworkingSupport

public void setEmbeddedLDAPNetworkingSupport(boolean ldapNetworkingSupport)
Embedded server only - sests if LDAP wire protocol handler is to be started

Parameters:
ldapNetworkingSupport - True to install LDAP support else false

getEmbeddedLDAPPort

public int getEmbeddedLDAPPort()
Embedded server only - gets the LDAP listen port

Returns:
LDAP listen port

setEmbeddedLDAPPort

public void setEmbeddedLDAPPort(int ldapPort)
Embedded server only - sets the LDAP listen port

Parameters:
ldapPort - The LDAP port listened on

getEmbeddedLDAPSPort

public int getEmbeddedLDAPSPort()
Embedded server only - gets the LDAPSSL) listen port (!NOT YET SUPPORTED!)

Returns:
LDAPS listen port

setEmbeddedLDAPSPort

public void setEmbeddedLDAPSPort(int ldapsPort)
Embedded server only - sets the LDAPS (SSL) listen port (!NOT YET SUPPORTED!)

Parameters:
ldapsPort - The LDAPS port listened on

getEmbeddedCustomRootPartitionName

public java.lang.String getEmbeddedCustomRootPartitionName()
Embedded server only - Gets the name of the root partion which was automatically created on server startup

Returns:
The name of the custom root partition (null for no custom partition)

setEmbeddedCustomRootPartitionName

public void setEmbeddedCustomRootPartitionName(java.lang.String rootPartitianName)
Embedded server only - Sets the name of the root partion which is automatically created on server startup

Parameters:
rootPartitianName - The name of the custom root partition (null for no partition)

getEmbeddedWkdir

public java.lang.String getEmbeddedWkdir()
Embedded server only - Gets the name of the workfile folder used by the server

Returns:
Folder name

setEmbeddedWkdir

public void setEmbeddedWkdir(java.lang.String wkdir)
Embedded server only - Sets the name of the workfile folder used by the server

Parameters:
wkdir - Folder name

getEmbeddedLDIFdir

public java.lang.String getEmbeddedLDIFdir()
Embedded server only - Gets the name of the LDIF import folder used by the server

Returns:
LDIF import folder

setEmbeddedLDIFdir

public void setEmbeddedLDIFdir(java.lang.String LDIFdir)
Embedded server only - Sets the name of the LDIF import folder used by the server

Parameters:
LDIFdir - LDIF import folder

isEmbeddedAccessControlEnabled

public boolean isEmbeddedAccessControlEnabled()
Embedded server only - test if access control is enabled

Returns:
True is enabled else false

setEmbeddedAccessControlEnabled

public void setEmbeddedAccessControlEnabled(boolean enabled)
Embedded server only - Set if access control is enabled

Parameters:
enabled - True to enable else false

isEmbeddedEnableNtp

public boolean isEmbeddedEnableNtp()
Embedded server only - test if NTP wire protocol is enabled

Returns:
True is enabled else false

setEmbeddedEnableNtp

public void setEmbeddedEnableNtp(boolean enabled)
Embedded server only - set if NTP wire protocol is enabled

Parameters:
enabled - True to enable else false

isEmbeddedEnableKerberos

public boolean isEmbeddedEnableKerberos()
Embedded server only - test if Kerberos wire protocol is enabled

Returns:
True is enabled else false

setEmbeddedEnableKerberos

public void setEmbeddedEnableKerberos(boolean enabled)
Embedded server only - set if Kerberos wire protocol is enabled

Parameters:
enabled - True to enable else false

isEmbeddedEnableChangePassword

public boolean isEmbeddedEnableChangePassword()
Embedded server only - test if Change Password wire protocol is enabled

Returns:
True is enabled else false

setEmbeddedEnableChangePassword

public void setEmbeddedEnableChangePassword(boolean enabled)
Embedded server only - set if Change Password wire protocol is enabled

Parameters:
enabled - True to enable else false