All Superinterfaces:: ConfigurationClient

public interface RootCfgClient extends ConfigurationClient

A client-side interface for reading and modifying Root settings.

The root configuration provides an entry point to the rest of the OpenDJ configuration.

Method Summary

Modifier and Type

Method

Description

<C extends AccessControlHandlerCfgClient> C

createAccessControlHandler(ManagedObjectDefinition<C,? extends AccessControlHandlerCfg> d, Collection<PropertyException> exceptions)

Creates a new Access Control Handler.

<C extends AccountStatusNotificationHandlerCfgClient> C

createAccountStatusNotificationHandler(ManagedObjectDefinition<C,? extends AccountStatusNotificationHandlerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Account Status Notification Handler.

<C extends AlertHandlerCfgClient> C

createAlertHandler(ManagedObjectDefinition<C,? extends AlertHandlerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Alert Handler.

<C extends BackendCfgClient> C

createBackend(ManagedObjectDefinition<C,? extends BackendCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Backend.

<C extends CertificateMapperCfgClient> C

createCertificateMapper(ManagedObjectDefinition<C,? extends CertificateMapperCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Certificate Mapper.

<C extends ConnectionHandlerCfgClient> C

createConnectionHandler(ManagedObjectDefinition<C,? extends ConnectionHandlerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Connection Handler.

<C extends EntryCacheCfgClient> C

createEntryCache(ManagedObjectDefinition<C,? extends EntryCacheCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Entry Cache.

<C extends ExtendedOperationHandlerCfgClient> C

createExtendedOperationHandler(ManagedObjectDefinition<C,? extends ExtendedOperationHandlerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Extended Operation Handler.

<C extends HttpAuthorizationMechanismCfgClient> C

createHttpAuthorizationMechanism(ManagedObjectDefinition<C,? extends HttpAuthorizationMechanismCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Http Authorization Mechanism.

<C extends HttpEndpointCfgClient> C

createHttpEndpoint(ManagedObjectDefinition<C,? extends HttpEndpointCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Http Endpoint.

<C extends IdentityMapperCfgClient> C

createIdentityMapper(ManagedObjectDefinition<C,? extends IdentityMapperCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Identity Mapper.

<C extends KeyManagerProviderCfgClient> C

createKeyManagerProvider(ManagedObjectDefinition<C,? extends KeyManagerProviderCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Key Manager Provider.

<C extends LogPublisherCfgClient> C

createLogPublisher(ManagedObjectDefinition<C,? extends LogPublisherCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Log Publisher.

<C extends LogRetentionPolicyCfgClient> C

createLogRetentionPolicy(ManagedObjectDefinition<C,? extends LogRetentionPolicyCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Log Retention Policy.

<C extends LogRotationPolicyCfgClient> C

createLogRotationPolicy(ManagedObjectDefinition<C,? extends LogRotationPolicyCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Log Rotation Policy.

<C extends MailServerCfgClient> C

createMailServer(ManagedObjectDefinition<C,? extends MailServerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Mail Server.

<C extends PasswordGeneratorCfgClient> C

createPasswordGenerator(ManagedObjectDefinition<C,? extends PasswordGeneratorCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Password Generator.

<C extends AuthenticationPolicyCfgClient> C

createPasswordPolicy(ManagedObjectDefinition<C,? extends AuthenticationPolicyCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Password Policy.

<C extends PasswordStorageSchemeCfgClient> C

createPasswordStorageScheme(ManagedObjectDefinition<C,? extends PasswordStorageSchemeCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Password Storage Scheme.

<C extends PasswordValidatorCfgClient> C

createPasswordValidator(ManagedObjectDefinition<C,? extends PasswordValidatorCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Password Validator.

<C extends SaslMechanismHandlerCfgClient> C

createSaslMechanismHandler(ManagedObjectDefinition<C,? extends SaslMechanismHandlerCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Sasl Mechanism Handler.

<C extends SchemaProviderCfgClient> C

createSchemaProvider(ManagedObjectDefinition<C,? extends SchemaProviderCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Schema Provider.

<C extends ServiceDiscoveryMechanismCfgClient> C

createServiceDiscoveryMechanism(ManagedObjectDefinition<C,? extends ServiceDiscoveryMechanismCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Service Discovery Mechanism.

<C extends SynchronizationProviderCfgClient> C

createSynchronizationProvider(ManagedObjectDefinition<C,? extends SynchronizationProviderCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Synchronization Provider.

<C extends TrustManagerProviderCfgClient> C

createTrustManagerProvider(ManagedObjectDefinition<C,? extends TrustManagerProviderCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Trust Manager Provider.

<C extends VirtualAttributeCfgClient> C

createVirtualAttribute(ManagedObjectDefinition<C,? extends VirtualAttributeCfg> d, String name, Collection<PropertyException> exceptions)

Creates a new Virtual Attribute.

ManagedObjectDefinition<? extends RootCfgClient,? extends RootCfg>

definition()

Get the configuration definition associated with this Root.

AccessControlHandlerCfgClient

getAccessControlHandler()

Gets the Access Control Handler if it is present.

AccountStatusNotificationHandlerCfgClient

getAccountStatusNotificationHandler(String name)

Gets the named Account Status Notification Handler.

AdministrationConnectorCfgClient

getAdministrationConnector()

Gets the Administration Connector.

AlertHandlerCfgClient

getAlertHandler(String name)

Gets the named Alert Handler.

BackendCfgClient

getBackend(String name)

Gets the named Backend.

CertificateMapperCfgClient

getCertificateMapper(String name)

Gets the named Certificate Mapper.

ConnectionHandlerCfgClient

getConnectionHandler(String name)

Gets the named Connection Handler.

CryptoManagerCfgClient

getCryptoManager()

Gets the Crypto Manager.

EntryCacheCfgClient

getEntryCache(String name)

Gets the named Entry Cache.

ExtendedOperationHandlerCfgClient

getExtendedOperationHandler(String name)

Gets the named Extended Operation Handler.

GlobalCfgClient

getGlobalConfiguration()

Gets the Global Configuration.

HttpAuthorizationMechanismCfgClient

getHttpAuthorizationMechanism(String name)

Gets the named Http Authorization Mechanism.

HttpEndpointCfgClient

getHttpEndpoint(String name)

Gets the named Http Endpoint.

IdentityMapperCfgClient

getIdentityMapper(String name)

Gets the named Identity Mapper.

KeyManagerProviderCfgClient

getKeyManagerProvider(String name)

Gets the named Key Manager Provider.

LogPublisherCfgClient

getLogPublisher(String name)

Gets the named Log Publisher.

LogRetentionPolicyCfgClient

getLogRetentionPolicy(String name)

Gets the named Log Retention Policy.

LogRotationPolicyCfgClient

getLogRotationPolicy(String name)

Gets the named Log Rotation Policy.

MailServerCfgClient

getMailServer(String name)

Gets the named Mail Server.

PasswordGeneratorCfgClient

getPasswordGenerator(String name)

Gets the named Password Generator.

AuthenticationPolicyCfgClient

getPasswordPolicy(String name)

Gets the named Password Policy.

PasswordStorageSchemeCfgClient

getPasswordStorageScheme(String name)

Gets the named Password Storage Scheme.

PasswordValidatorCfgClient

getPasswordValidator(String name)

Gets the named Password Validator.

PluginRootCfgClient

getPluginRoot()

Gets the Plugin Root.

RootDseBackendCfgClient

getRootDseBackend()

Gets the Root Dse Backend.

SaslMechanismHandlerCfgClient

getSaslMechanismHandler(String name)

Gets the named Sasl Mechanism Handler.

SchemaProviderCfgClient

getSchemaProvider(String name)

Gets the named Schema Provider.

ServiceDiscoveryMechanismCfgClient

getServiceDiscoveryMechanism(String name)

Gets the named Service Discovery Mechanism.

SynchronizationProviderCfgClient

getSynchronizationProvider(String name)

Gets the named Synchronization Provider.

TrustManagerProviderCfgClient

getTrustManagerProvider(String name)

Gets the named Trust Manager Provider.

VirtualAttributeCfgClient

getVirtualAttribute(String name)

Gets the named Virtual Attribute.

WorkQueueCfgClient

getWorkQueue()

Gets the Work Queue.

boolean

hasAccessControlHandler()

Determines whether the Access Control Handler exists.

String[]

listAccountStatusNotificationHandlers()

Lists the Account Status Notification Handlers.

String[]

listAlertHandlers()

Lists the Alert Handlers.

String[]

listBackends()

Lists the Backends.

String[]

listCertificateMappers()

Lists the Certificate Mappers.

String[]

listConnectionHandlers()

Lists the Connection Handlers.

String[]

listEntryCaches()

Lists the Entry Caches.

String[]

listExtendedOperationHandlers()

Lists the Extended Operation Handlers.

String[]

listHttpAuthorizationMechanisms()

Lists the Http Authorization Mechanisms.

String[]

listHttpEndpoints()

Lists the Http Endpoints.

String[]

listIdentityMappers()

Lists the Identity Mappers.

String[]

listKeyManagerProviders()

Lists the Key Manager Providers.

String[]

listLogPublishers()

Lists the Log Publishers.

String[]

listLogRetentionPolicies()

Lists the Log Retention Policies.

String[]

listLogRotationPolicies()

Lists the Log Rotation Policies.

String[]

listMailServers()

Lists the Mail Servers.

String[]

listPasswordGenerators()

Lists the Password Generators.

String[]

listPasswordPolicies()

Lists the Password Policies.

String[]

listPasswordStorageSchemes()

Lists the Password Storage Schemes.

String[]

listPasswordValidators()

Lists the Password Validators.

String[]

listSaslMechanismHandlers()

Lists the Sasl Mechanism Handlers.

String[]

listSchemaProviders()

Lists the Schema Providers.

String[]

listServiceDiscoveryMechanisms()

Lists the Service Discovery Mechanisms.

String[]

listSynchronizationProviders()

Lists the Synchronization Providers.

String[]

listTrustManagerProviders()

Lists the Trust Manager Providers.

String[]

listVirtualAttributes()

Lists the Virtual Attributes.

void

removeAccessControlHandler()

Removes the Access Control Handler if it exists.

void

removeAccountStatusNotificationHandler(String name)

Removes the named Account Status Notification Handler.

void

removeAlertHandler(String name)

Removes the named Alert Handler.

void

removeBackend(String name)

Removes the named Backend.

void

removeCertificateMapper(String name)

Removes the named Certificate Mapper.

void

removeConnectionHandler(String name)

Removes the named Connection Handler.

void

removeEntryCache(String name)

Removes the named Entry Cache.

void

removeExtendedOperationHandler(String name)

Removes the named Extended Operation Handler.

void

removeHttpAuthorizationMechanism(String name)

Removes the named Http Authorization Mechanism.

void

removeHttpEndpoint(String name)

Removes the named Http Endpoint.

void

removeIdentityMapper(String name)

Removes the named Identity Mapper.

void

removeKeyManagerProvider(String name)

Removes the named Key Manager Provider.

void

removeLogPublisher(String name)

Removes the named Log Publisher.

void

removeLogRetentionPolicy(String name)

Removes the named Log Retention Policy.

void

removeLogRotationPolicy(String name)

Removes the named Log Rotation Policy.

void

removeMailServer(String name)

Removes the named Mail Server.

void

removePasswordGenerator(String name)

Removes the named Password Generator.

void

removePasswordPolicy(String name)

Removes the named Password Policy.

void

removePasswordStorageScheme(String name)

Removes the named Password Storage Scheme.

void

removePasswordValidator(String name)

Removes the named Password Validator.

void

removeSaslMechanismHandler(String name)

Removes the named Sasl Mechanism Handler.

void

removeSchemaProvider(String name)

Removes the named Schema Provider.

void

removeServiceDiscoveryMechanism(String name)

Removes the named Service Discovery Mechanism.

void

removeSynchronizationProvider(String name)

Removes the named Synchronization Provider.

void

removeTrustManagerProvider(String name)

Removes the named Trust Manager Provider.

void

removeVirtualAttribute(String name)

Removes the named Virtual Attribute.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties

Method Details
- definition
  
  ManagedObjectDefinition<? extends RootCfgClient,? extends RootCfg> definition()
  
  Get the configuration definition associated with this Root.
  
  Specified by:
  
  definition in interface ConfigurationClient
  
  Returns:
  
  Returns the configuration definition associated with this Root.
- hasAccessControlHandler
  
  boolean hasAccessControlHandler() throws ConcurrentModificationException, LdapException
  
  Determines whether the Access Control Handler exists.
  
  Returns:
  
  Returns true if the Access Control Handler exists.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getAccessControlHandler
  
  AccessControlHandlerCfgClient getAccessControlHandler() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Access Control Handler if it is present.
  
  Returns:
  
  Returns the Access Control Handler if it is present.
  
  Throws:
  
  DefinitionDecodingException - If the Access Control Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Access Control Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Access Control Handler is not present.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createAccessControlHandler
  
  <C extends AccessControlHandlerCfgClient> C createAccessControlHandler(ManagedObjectDefinition<C,? extends AccessControlHandlerCfg> d, Collection<PropertyException> exceptions)
  
  Creates a new Access Control Handler. The new Access Control Handler will initially not contain any property values (including mandatory properties). Once the Access Control Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Access Control Handler being created.
  
  Parameters:
  
  d - The definition of the Access Control Handler to be created.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Access Control Handler. This argument can be null.
  
  Returns:
  
  Returns a new Access Control Handler configuration instance.
- removeAccessControlHandler
  
  void removeAccessControlHandler() throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the Access Control Handler if it exists.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Access Control Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Access Control Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listAccountStatusNotificationHandlers
  
  String[] listAccountStatusNotificationHandlers() throws ConcurrentModificationException, LdapException
  
  Lists the Account Status Notification Handlers.
  
  Returns:
  
  Returns an array containing the names of the Account Status Notification Handlers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getAccountStatusNotificationHandler
  
  AccountStatusNotificationHandlerCfgClient getAccountStatusNotificationHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Account Status Notification Handler.
  
  Parameters:
  
  name - The name of the Account Status Notification Handler to retrieve.
  
  Returns:
  
  Returns the named Account Status Notification Handler.
  
  Throws:
  
  DefinitionDecodingException - If the named Account Status Notification Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Account Status Notification Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Account Status Notification Handler was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createAccountStatusNotificationHandler
  
  <C extends AccountStatusNotificationHandlerCfgClient> C createAccountStatusNotificationHandler(ManagedObjectDefinition<C,? extends AccountStatusNotificationHandlerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Account Status Notification Handler. The new Account Status Notification Handler will initially not contain any property values (including mandatory properties). Once the Account Status Notification Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Account Status Notification Handler being created.
  
  Parameters:
  
  d - The definition of the Account Status Notification Handler to be created.
  
  name - The name of the new Account Status Notification Handler.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Account Status Notification Handler. This argument can be null.
  
  Returns:
  
  Returns a new Account Status Notification Handler configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Account Status Notification Handler is invalid.
- removeAccountStatusNotificationHandler
  
  void removeAccountStatusNotificationHandler(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Account Status Notification Handler.
  
  Parameters:
  
  name - The name of the Account Status Notification Handler to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Account Status Notification Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Account Status Notification Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getAdministrationConnector
  
  AdministrationConnectorCfgClient getAdministrationConnector() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Administration Connector.
  
  Returns:
  
  Returns the Administration Connector.
  
  Throws:
  
  DefinitionDecodingException - If the Administration Connector was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Administration Connector was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Administration Connector could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listAlertHandlers
  
  String[] listAlertHandlers() throws ConcurrentModificationException, LdapException
  
  Lists the Alert Handlers.
  
  Returns:
  
  Returns an array containing the names of the Alert Handlers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getAlertHandler
  
  AlertHandlerCfgClient getAlertHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Alert Handler.
  
  Parameters:
  
  name - The name of the Alert Handler to retrieve.
  
  Returns:
  
  Returns the named Alert Handler.
  
  Throws:
  
  DefinitionDecodingException - If the named Alert Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Alert Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Alert Handler was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createAlertHandler
  
  <C extends AlertHandlerCfgClient> C createAlertHandler(ManagedObjectDefinition<C,? extends AlertHandlerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Alert Handler. The new Alert Handler will initially not contain any property values (including mandatory properties). Once the Alert Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Alert Handler being created.
  
  Parameters:
  
  d - The definition of the Alert Handler to be created.
  
  name - The name of the new Alert Handler.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Alert Handler. This argument can be null.
  
  Returns:
  
  Returns a new Alert Handler configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Alert Handler is invalid.
- removeAlertHandler
  
  void removeAlertHandler(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Alert Handler.
  
  Parameters:
  
  name - The name of the Alert Handler to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Alert Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Alert Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listBackends
  
  String[] listBackends() throws ConcurrentModificationException, LdapException
  
  Lists the Backends.
  
  Returns:
  
  Returns an array containing the names of the Backends.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getBackend
  
  BackendCfgClient getBackend(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Backend.
  
  Parameters:
  
  name - The name of the Backend to retrieve.
  
  Returns:
  
  Returns the named Backend.
  
  Throws:
  
  DefinitionDecodingException - If the named Backend was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Backend was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Backend was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createBackend
  
  <C extends BackendCfgClient> C createBackend(ManagedObjectDefinition<C,? extends BackendCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Backend. The new Backend will initially not contain any property values (including mandatory properties). Once the Backend has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Backend being created.
  
  Parameters:
  
  d - The definition of the Backend to be created.
  
  name - The name of the new Backend.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Backend. This argument can be null.
  
  Returns:
  
  Returns a new Backend configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Backend is invalid.
- removeBackend
  
  void removeBackend(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Backend.
  
  Parameters:
  
  name - The name of the Backend to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Backend does not exist.
  
  OperationRejectedException - If the server refuses to remove the Backend due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listCertificateMappers
  
  String[] listCertificateMappers() throws ConcurrentModificationException, LdapException
  
  Lists the Certificate Mappers.
  
  Returns:
  
  Returns an array containing the names of the Certificate Mappers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getCertificateMapper
  
  CertificateMapperCfgClient getCertificateMapper(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Certificate Mapper.
  
  Parameters:
  
  name - The name of the Certificate Mapper to retrieve.
  
  Returns:
  
  Returns the named Certificate Mapper.
  
  Throws:
  
  DefinitionDecodingException - If the named Certificate Mapper was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Certificate Mapper was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Certificate Mapper was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createCertificateMapper
  
  <C extends CertificateMapperCfgClient> C createCertificateMapper(ManagedObjectDefinition<C,? extends CertificateMapperCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Certificate Mapper. The new Certificate Mapper will initially not contain any property values (including mandatory properties). Once the Certificate Mapper has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Certificate Mapper being created.
  
  Parameters:
  
  d - The definition of the Certificate Mapper to be created.
  
  name - The name of the new Certificate Mapper.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Certificate Mapper. This argument can be null.
  
  Returns:
  
  Returns a new Certificate Mapper configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Certificate Mapper is invalid.
- removeCertificateMapper
  
  void removeCertificateMapper(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Certificate Mapper.
  
  Parameters:
  
  name - The name of the Certificate Mapper to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Certificate Mapper does not exist.
  
  OperationRejectedException - If the server refuses to remove the Certificate Mapper due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listConnectionHandlers
  
  String[] listConnectionHandlers() throws ConcurrentModificationException, LdapException
  
  Lists the Connection Handlers.
  
  Returns:
  
  Returns an array containing the names of the Connection Handlers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getConnectionHandler
  
  ConnectionHandlerCfgClient getConnectionHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Connection Handler.
  
  Parameters:
  
  name - The name of the Connection Handler to retrieve.
  
  Returns:
  
  Returns the named Connection Handler.
  
  Throws:
  
  DefinitionDecodingException - If the named Connection Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Connection Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Connection Handler was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createConnectionHandler
  
  <C extends ConnectionHandlerCfgClient> C createConnectionHandler(ManagedObjectDefinition<C,? extends ConnectionHandlerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Connection Handler. The new Connection Handler will initially not contain any property values (including mandatory properties). Once the Connection Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Connection Handler being created.
  
  Parameters:
  
  d - The definition of the Connection Handler to be created.
  
  name - The name of the new Connection Handler.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Connection Handler. This argument can be null.
  
  Returns:
  
  Returns a new Connection Handler configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Connection Handler is invalid.
- removeConnectionHandler
  
  void removeConnectionHandler(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Connection Handler.
  
  Parameters:
  
  name - The name of the Connection Handler to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Connection Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Connection Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getCryptoManager
  
  CryptoManagerCfgClient getCryptoManager() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Crypto Manager.
  
  Returns:
  
  Returns the Crypto Manager.
  
  Throws:
  
  DefinitionDecodingException - If the Crypto Manager was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Crypto Manager was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Crypto Manager could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listEntryCaches
  
  String[] listEntryCaches() throws ConcurrentModificationException, LdapException
  
  Lists the Entry Caches.
  
  Returns:
  
  Returns an array containing the names of the Entry Caches.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getEntryCache
  
  EntryCacheCfgClient getEntryCache(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Entry Cache.
  
  Parameters:
  
  name - The name of the Entry Cache to retrieve.
  
  Returns:
  
  Returns the named Entry Cache.
  
  Throws:
  
  DefinitionDecodingException - If the named Entry Cache was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Entry Cache was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Entry Cache was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createEntryCache
  
  <C extends EntryCacheCfgClient> C createEntryCache(ManagedObjectDefinition<C,? extends EntryCacheCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Entry Cache. The new Entry Cache will initially not contain any property values (including mandatory properties). Once the Entry Cache has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Entry Cache being created.
  
  Parameters:
  
  d - The definition of the Entry Cache to be created.
  
  name - The name of the new Entry Cache.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Entry Cache. This argument can be null.
  
  Returns:
  
  Returns a new Entry Cache configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Entry Cache is invalid.
- removeEntryCache
  
  void removeEntryCache(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Entry Cache.
  
  Parameters:
  
  name - The name of the Entry Cache to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Entry Cache does not exist.
  
  OperationRejectedException - If the server refuses to remove the Entry Cache due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listExtendedOperationHandlers
  
  String[] listExtendedOperationHandlers() throws ConcurrentModificationException, LdapException
  
  Lists the Extended Operation Handlers.
  
  Returns:
  
  Returns an array containing the names of the Extended Operation Handlers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getExtendedOperationHandler
  
  ExtendedOperationHandlerCfgClient getExtendedOperationHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Extended Operation Handler.
  
  Parameters:
  
  name - The name of the Extended Operation Handler to retrieve.
  
  Returns:
  
  Returns the named Extended Operation Handler.
  
  Throws:
  
  DefinitionDecodingException - If the named Extended Operation Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Extended Operation Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Extended Operation Handler was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createExtendedOperationHandler
  
  <C extends ExtendedOperationHandlerCfgClient> C createExtendedOperationHandler(ManagedObjectDefinition<C,? extends ExtendedOperationHandlerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Extended Operation Handler. The new Extended Operation Handler will initially not contain any property values (including mandatory properties). Once the Extended Operation Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Extended Operation Handler being created.
  
  Parameters:
  
  d - The definition of the Extended Operation Handler to be created.
  
  name - The name of the new Extended Operation Handler.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Extended Operation Handler. This argument can be null.
  
  Returns:
  
  Returns a new Extended Operation Handler configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Extended Operation Handler is invalid.
- removeExtendedOperationHandler
  
  void removeExtendedOperationHandler(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Extended Operation Handler.
  
  Parameters:
  
  name - The name of the Extended Operation Handler to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Extended Operation Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Extended Operation Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getGlobalConfiguration
  
  GlobalCfgClient getGlobalConfiguration() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Global Configuration.
  
  Returns:
  
  Returns the Global Configuration.
  
  Throws:
  
  DefinitionDecodingException - If the Global Configuration was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Global Configuration was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Global Configuration could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listHttpAuthorizationMechanisms
  
  String[] listHttpAuthorizationMechanisms() throws ConcurrentModificationException, LdapException
  
  Lists the Http Authorization Mechanisms.
  
  Returns:
  
  Returns an array containing the names of the Http Authorization Mechanisms.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getHttpAuthorizationMechanism
  
  HttpAuthorizationMechanismCfgClient getHttpAuthorizationMechanism(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Http Authorization Mechanism.
  
  Parameters:
  
  name - The name of the Http Authorization Mechanism to retrieve.
  
  Returns:
  
  Returns the named Http Authorization Mechanism.
  
  Throws:
  
  DefinitionDecodingException - If the named Http Authorization Mechanism was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Http Authorization Mechanism was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Http Authorization Mechanism was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createHttpAuthorizationMechanism
  
  <C extends HttpAuthorizationMechanismCfgClient> C createHttpAuthorizationMechanism(ManagedObjectDefinition<C,? extends HttpAuthorizationMechanismCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Http Authorization Mechanism. The new Http Authorization Mechanism will initially not contain any property values (including mandatory properties). Once the Http Authorization Mechanism has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Http Authorization Mechanism being created.
  
  Parameters:
  
  d - The definition of the Http Authorization Mechanism to be created.
  
  name - The name of the new Http Authorization Mechanism.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Http Authorization Mechanism. This argument can be null.
  
  Returns:
  
  Returns a new Http Authorization Mechanism configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Http Authorization Mechanism is invalid.
- removeHttpAuthorizationMechanism
  
  void removeHttpAuthorizationMechanism(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Http Authorization Mechanism.
  
  Parameters:
  
  name - The name of the Http Authorization Mechanism to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Http Authorization Mechanism does not exist.
  
  OperationRejectedException - If the server refuses to remove the Http Authorization Mechanism due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listHttpEndpoints
  
  String[] listHttpEndpoints() throws ConcurrentModificationException, LdapException
  
  Lists the Http Endpoints.
  
  Returns:
  
  Returns an array containing the names of the Http Endpoints.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getHttpEndpoint
  
  HttpEndpointCfgClient getHttpEndpoint(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Http Endpoint.
  
  Parameters:
  
  name - The name of the Http Endpoint to retrieve.
  
  Returns:
  
  Returns the named Http Endpoint.
  
  Throws:
  
  DefinitionDecodingException - If the named Http Endpoint was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Http Endpoint was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Http Endpoint was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createHttpEndpoint
  
  <C extends HttpEndpointCfgClient> C createHttpEndpoint(ManagedObjectDefinition<C,? extends HttpEndpointCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Http Endpoint. The new Http Endpoint will initially not contain any property values (including mandatory properties). Once the Http Endpoint has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Http Endpoint being created.
  
  Parameters:
  
  d - The definition of the Http Endpoint to be created.
  
  name - The name of the new Http Endpoint.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Http Endpoint. This argument can be null.
  
  Returns:
  
  Returns a new Http Endpoint configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Http Endpoint is invalid.
- removeHttpEndpoint
  
  void removeHttpEndpoint(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Http Endpoint.
  
  Parameters:
  
  name - The name of the Http Endpoint to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Http Endpoint does not exist.
  
  OperationRejectedException - If the server refuses to remove the Http Endpoint due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listIdentityMappers
  
  String[] listIdentityMappers() throws ConcurrentModificationException, LdapException
  
  Lists the Identity Mappers.
  
  Returns:
  
  Returns an array containing the names of the Identity Mappers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getIdentityMapper
  
  IdentityMapperCfgClient getIdentityMapper(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Identity Mapper.
  
  Parameters:
  
  name - The name of the Identity Mapper to retrieve.
  
  Returns:
  
  Returns the named Identity Mapper.
  
  Throws:
  
  DefinitionDecodingException - If the named Identity Mapper was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Identity Mapper was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Identity Mapper was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createIdentityMapper
  
  <C extends IdentityMapperCfgClient> C createIdentityMapper(ManagedObjectDefinition<C,? extends IdentityMapperCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Identity Mapper. The new Identity Mapper will initially not contain any property values (including mandatory properties). Once the Identity Mapper has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Identity Mapper being created.
  
  Parameters:
  
  d - The definition of the Identity Mapper to be created.
  
  name - The name of the new Identity Mapper.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Identity Mapper. This argument can be null.
  
  Returns:
  
  Returns a new Identity Mapper configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Identity Mapper is invalid.
- removeIdentityMapper
  
  void removeIdentityMapper(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Identity Mapper.
  
  Parameters:
  
  name - The name of the Identity Mapper to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Identity Mapper does not exist.
  
  OperationRejectedException - If the server refuses to remove the Identity Mapper due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listKeyManagerProviders
  
  String[] listKeyManagerProviders() throws ConcurrentModificationException, LdapException
  
  Lists the Key Manager Providers.
  
  Returns:
  
  Returns an array containing the names of the Key Manager Providers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getKeyManagerProvider
  
  KeyManagerProviderCfgClient getKeyManagerProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Key Manager Provider.
  
  Parameters:
  
  name - The name of the Key Manager Provider to retrieve.
  
  Returns:
  
  Returns the named Key Manager Provider.
  
  Throws:
  
  DefinitionDecodingException - If the named Key Manager Provider was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Key Manager Provider was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Key Manager Provider was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createKeyManagerProvider
  
  <C extends KeyManagerProviderCfgClient> C createKeyManagerProvider(ManagedObjectDefinition<C,? extends KeyManagerProviderCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Key Manager Provider. The new Key Manager Provider will initially not contain any property values (including mandatory properties). Once the Key Manager Provider has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Key Manager Provider being created.
  
  Parameters:
  
  d - The definition of the Key Manager Provider to be created.
  
  name - The name of the new Key Manager Provider.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Key Manager Provider. This argument can be null.
  
  Returns:
  
  Returns a new Key Manager Provider configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Key Manager Provider is invalid.
- removeKeyManagerProvider
  
  void removeKeyManagerProvider(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Key Manager Provider.
  
  Parameters:
  
  name - The name of the Key Manager Provider to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Key Manager Provider does not exist.
  
  OperationRejectedException - If the server refuses to remove the Key Manager Provider due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listLogPublishers
  
  String[] listLogPublishers() throws ConcurrentModificationException, LdapException
  
  Lists the Log Publishers.
  
  Returns:
  
  Returns an array containing the names of the Log Publishers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getLogPublisher
  
  LogPublisherCfgClient getLogPublisher(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Log Publisher.
  
  Parameters:
  
  name - The name of the Log Publisher to retrieve.
  
  Returns:
  
  Returns the named Log Publisher.
  
  Throws:
  
  DefinitionDecodingException - If the named Log Publisher was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Log Publisher was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Log Publisher was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createLogPublisher
  
  <C extends LogPublisherCfgClient> C createLogPublisher(ManagedObjectDefinition<C,? extends LogPublisherCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Log Publisher. The new Log Publisher will initially not contain any property values (including mandatory properties). Once the Log Publisher has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Log Publisher being created.
  
  Parameters:
  
  d - The definition of the Log Publisher to be created.
  
  name - The name of the new Log Publisher.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Log Publisher. This argument can be null.
  
  Returns:
  
  Returns a new Log Publisher configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Log Publisher is invalid.
- removeLogPublisher
  
  void removeLogPublisher(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Log Publisher.
  
  Parameters:
  
  name - The name of the Log Publisher to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Log Publisher does not exist.
  
  OperationRejectedException - If the server refuses to remove the Log Publisher due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listLogRetentionPolicies
  
  String[] listLogRetentionPolicies() throws ConcurrentModificationException, LdapException
  
  Lists the Log Retention Policies.
  
  Returns:
  
  Returns an array containing the names of the Log Retention Policies.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getLogRetentionPolicy
  
  LogRetentionPolicyCfgClient getLogRetentionPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Log Retention Policy.
  
  Parameters:
  
  name - The name of the Log Retention Policy to retrieve.
  
  Returns:
  
  Returns the named Log Retention Policy.
  
  Throws:
  
  DefinitionDecodingException - If the named Log Retention Policy was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Log Retention Policy was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Log Retention Policy was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createLogRetentionPolicy
  
  <C extends LogRetentionPolicyCfgClient> C createLogRetentionPolicy(ManagedObjectDefinition<C,? extends LogRetentionPolicyCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Log Retention Policy. The new Log Retention Policy will initially not contain any property values (including mandatory properties). Once the Log Retention Policy has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Log Retention Policy being created.
  
  Parameters:
  
  d - The definition of the Log Retention Policy to be created.
  
  name - The name of the new Log Retention Policy.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Log Retention Policy. This argument can be null.
  
  Returns:
  
  Returns a new Log Retention Policy configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Log Retention Policy is invalid.
- removeLogRetentionPolicy
  
  void removeLogRetentionPolicy(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Log Retention Policy.
  
  Parameters:
  
  name - The name of the Log Retention Policy to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Log Retention Policy does not exist.
  
  OperationRejectedException - If the server refuses to remove the Log Retention Policy due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listLogRotationPolicies
  
  String[] listLogRotationPolicies() throws ConcurrentModificationException, LdapException
  
  Lists the Log Rotation Policies.
  
  Returns:
  
  Returns an array containing the names of the Log Rotation Policies.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getLogRotationPolicy
  
  LogRotationPolicyCfgClient getLogRotationPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Log Rotation Policy.
  
  Parameters:
  
  name - The name of the Log Rotation Policy to retrieve.
  
  Returns:
  
  Returns the named Log Rotation Policy.
  
  Throws:
  
  DefinitionDecodingException - If the named Log Rotation Policy was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Log Rotation Policy was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Log Rotation Policy was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createLogRotationPolicy
  
  <C extends LogRotationPolicyCfgClient> C createLogRotationPolicy(ManagedObjectDefinition<C,? extends LogRotationPolicyCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Log Rotation Policy. The new Log Rotation Policy will initially not contain any property values (including mandatory properties). Once the Log Rotation Policy has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Log Rotation Policy being created.
  
  Parameters:
  
  d - The definition of the Log Rotation Policy to be created.
  
  name - The name of the new Log Rotation Policy.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Log Rotation Policy. This argument can be null.
  
  Returns:
  
  Returns a new Log Rotation Policy configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Log Rotation Policy is invalid.
- removeLogRotationPolicy
  
  void removeLogRotationPolicy(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Log Rotation Policy.
  
  Parameters:
  
  name - The name of the Log Rotation Policy to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Log Rotation Policy does not exist.
  
  OperationRejectedException - If the server refuses to remove the Log Rotation Policy due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listMailServers
  
  String[] listMailServers() throws ConcurrentModificationException, LdapException
  
  Lists the Mail Servers.
  
  Returns:
  
  Returns an array containing the names of the Mail Servers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getMailServer
  
  MailServerCfgClient getMailServer(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Mail Server.
  
  Parameters:
  
  name - The name of the Mail Server to retrieve.
  
  Returns:
  
  Returns the named Mail Server.
  
  Throws:
  
  DefinitionDecodingException - If the named Mail Server was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Mail Server was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Mail Server was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createMailServer
  
  <C extends MailServerCfgClient> C createMailServer(ManagedObjectDefinition<C,? extends MailServerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Mail Server. The new Mail Server will initially not contain any property values (including mandatory properties). Once the Mail Server has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Mail Server being created.
  
  Parameters:
  
  d - The definition of the Mail Server to be created.
  
  name - The name of the new Mail Server.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Mail Server. This argument can be null.
  
  Returns:
  
  Returns a new Mail Server configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Mail Server is invalid.
- removeMailServer
  
  void removeMailServer(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Mail Server.
  
  Parameters:
  
  name - The name of the Mail Server to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Mail Server does not exist.
  
  OperationRejectedException - If the server refuses to remove the Mail Server due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listPasswordGenerators
  
  String[] listPasswordGenerators() throws ConcurrentModificationException, LdapException
  
  Lists the Password Generators.
  
  Returns:
  
  Returns an array containing the names of the Password Generators.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getPasswordGenerator
  
  PasswordGeneratorCfgClient getPasswordGenerator(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Password Generator.
  
  Parameters:
  
  name - The name of the Password Generator to retrieve.
  
  Returns:
  
  Returns the named Password Generator.
  
  Throws:
  
  DefinitionDecodingException - If the named Password Generator was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Password Generator was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Password Generator was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createPasswordGenerator
  
  <C extends PasswordGeneratorCfgClient> C createPasswordGenerator(ManagedObjectDefinition<C,? extends PasswordGeneratorCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Password Generator. The new Password Generator will initially not contain any property values (including mandatory properties). Once the Password Generator has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Password Generator being created.
  
  Parameters:
  
  d - The definition of the Password Generator to be created.
  
  name - The name of the new Password Generator.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Password Generator. This argument can be null.
  
  Returns:
  
  Returns a new Password Generator configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Password Generator is invalid.
- removePasswordGenerator
  
  void removePasswordGenerator(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Password Generator.
  
  Parameters:
  
  name - The name of the Password Generator to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Password Generator does not exist.
  
  OperationRejectedException - If the server refuses to remove the Password Generator due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listPasswordPolicies
  
  String[] listPasswordPolicies() throws ConcurrentModificationException, LdapException
  
  Lists the Password Policies.
  
  Returns:
  
  Returns an array containing the names of the Password Policies.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getPasswordPolicy
  
  AuthenticationPolicyCfgClient getPasswordPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Password Policy.
  
  Parameters:
  
  name - The name of the Password Policy to retrieve.
  
  Returns:
  
  Returns the named Password Policy.
  
  Throws:
  
  DefinitionDecodingException - If the named Password Policy was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Password Policy was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Password Policy was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createPasswordPolicy
  
  <C extends AuthenticationPolicyCfgClient> C createPasswordPolicy(ManagedObjectDefinition<C,? extends AuthenticationPolicyCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Password Policy. The new Password Policy will initially not contain any property values (including mandatory properties). Once the Password Policy has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Password Policy being created.
  
  Parameters:
  
  d - The definition of the Password Policy to be created.
  
  name - The name of the new Password Policy.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Password Policy. This argument can be null.
  
  Returns:
  
  Returns a new Password Policy configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Password Policy is invalid.
- removePasswordPolicy
  
  void removePasswordPolicy(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Password Policy.
  
  Parameters:
  
  name - The name of the Password Policy to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Password Policy does not exist.
  
  OperationRejectedException - If the server refuses to remove the Password Policy due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listPasswordStorageSchemes
  
  String[] listPasswordStorageSchemes() throws ConcurrentModificationException, LdapException
  
  Lists the Password Storage Schemes.
  
  Returns:
  
  Returns an array containing the names of the Password Storage Schemes.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getPasswordStorageScheme
  
  PasswordStorageSchemeCfgClient getPasswordStorageScheme(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Password Storage Scheme.
  
  Parameters:
  
  name - The name of the Password Storage Scheme to retrieve.
  
  Returns:
  
  Returns the named Password Storage Scheme.
  
  Throws:
  
  DefinitionDecodingException - If the named Password Storage Scheme was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Password Storage Scheme was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Password Storage Scheme was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createPasswordStorageScheme
  
  <C extends PasswordStorageSchemeCfgClient> C createPasswordStorageScheme(ManagedObjectDefinition<C,? extends PasswordStorageSchemeCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Password Storage Scheme. The new Password Storage Scheme will initially not contain any property values (including mandatory properties). Once the Password Storage Scheme has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Password Storage Scheme being created.
  
  Parameters:
  
  d - The definition of the Password Storage Scheme to be created.
  
  name - The name of the new Password Storage Scheme.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Password Storage Scheme. This argument can be null.
  
  Returns:
  
  Returns a new Password Storage Scheme configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Password Storage Scheme is invalid.
- removePasswordStorageScheme
  
  void removePasswordStorageScheme(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Password Storage Scheme.
  
  Parameters:
  
  name - The name of the Password Storage Scheme to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Password Storage Scheme does not exist.
  
  OperationRejectedException - If the server refuses to remove the Password Storage Scheme due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listPasswordValidators
  
  String[] listPasswordValidators() throws ConcurrentModificationException, LdapException
  
  Lists the Password Validators.
  
  Returns:
  
  Returns an array containing the names of the Password Validators.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getPasswordValidator
  
  PasswordValidatorCfgClient getPasswordValidator(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Password Validator.
  
  Parameters:
  
  name - The name of the Password Validator to retrieve.
  
  Returns:
  
  Returns the named Password Validator.
  
  Throws:
  
  DefinitionDecodingException - If the named Password Validator was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Password Validator was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Password Validator was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createPasswordValidator
  
  <C extends PasswordValidatorCfgClient> C createPasswordValidator(ManagedObjectDefinition<C,? extends PasswordValidatorCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Password Validator. The new Password Validator will initially not contain any property values (including mandatory properties). Once the Password Validator has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Password Validator being created.
  
  Parameters:
  
  d - The definition of the Password Validator to be created.
  
  name - The name of the new Password Validator.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Password Validator. This argument can be null.
  
  Returns:
  
  Returns a new Password Validator configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Password Validator is invalid.
- removePasswordValidator
  
  void removePasswordValidator(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Password Validator.
  
  Parameters:
  
  name - The name of the Password Validator to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Password Validator does not exist.
  
  OperationRejectedException - If the server refuses to remove the Password Validator due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getPluginRoot
  
  PluginRootCfgClient getPluginRoot() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Plugin Root.
  
  Returns:
  
  Returns the Plugin Root.
  
  Throws:
  
  DefinitionDecodingException - If the Plugin Root was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Plugin Root was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Plugin Root could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getRootDseBackend
  
  RootDseBackendCfgClient getRootDseBackend() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Root Dse Backend.
  
  Returns:
  
  Returns the Root Dse Backend.
  
  Throws:
  
  DefinitionDecodingException - If the Root Dse Backend was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Root Dse Backend was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Root Dse Backend could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listSaslMechanismHandlers
  
  String[] listSaslMechanismHandlers() throws ConcurrentModificationException, LdapException
  
  Lists the Sasl Mechanism Handlers.
  
  Returns:
  
  Returns an array containing the names of the Sasl Mechanism Handlers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getSaslMechanismHandler
  
  SaslMechanismHandlerCfgClient getSaslMechanismHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Sasl Mechanism Handler.
  
  Parameters:
  
  name - The name of the Sasl Mechanism Handler to retrieve.
  
  Returns:
  
  Returns the named Sasl Mechanism Handler.
  
  Throws:
  
  DefinitionDecodingException - If the named Sasl Mechanism Handler was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Sasl Mechanism Handler was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Sasl Mechanism Handler was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createSaslMechanismHandler
  
  <C extends SaslMechanismHandlerCfgClient> C createSaslMechanismHandler(ManagedObjectDefinition<C,? extends SaslMechanismHandlerCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Sasl Mechanism Handler. The new Sasl Mechanism Handler will initially not contain any property values (including mandatory properties). Once the Sasl Mechanism Handler has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Sasl Mechanism Handler being created.
  
  Parameters:
  
  d - The definition of the Sasl Mechanism Handler to be created.
  
  name - The name of the new Sasl Mechanism Handler.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Sasl Mechanism Handler. This argument can be null.
  
  Returns:
  
  Returns a new Sasl Mechanism Handler configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Sasl Mechanism Handler is invalid.
- removeSaslMechanismHandler
  
  void removeSaslMechanismHandler(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Sasl Mechanism Handler.
  
  Parameters:
  
  name - The name of the Sasl Mechanism Handler to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Sasl Mechanism Handler does not exist.
  
  OperationRejectedException - If the server refuses to remove the Sasl Mechanism Handler due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listSchemaProviders
  
  String[] listSchemaProviders() throws ConcurrentModificationException, LdapException
  
  Lists the Schema Providers.
  
  Returns:
  
  Returns an array containing the names of the Schema Providers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getSchemaProvider
  
  SchemaProviderCfgClient getSchemaProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Schema Provider.
  
  Parameters:
  
  name - The name of the Schema Provider to retrieve.
  
  Returns:
  
  Returns the named Schema Provider.
  
  Throws:
  
  DefinitionDecodingException - If the named Schema Provider was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Schema Provider was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Schema Provider was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createSchemaProvider
  
  <C extends SchemaProviderCfgClient> C createSchemaProvider(ManagedObjectDefinition<C,? extends SchemaProviderCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Schema Provider. The new Schema Provider will initially not contain any property values (including mandatory properties). Once the Schema Provider has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Schema Provider being created.
  
  Parameters:
  
  d - The definition of the Schema Provider to be created.
  
  name - The name of the new Schema Provider.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Schema Provider. This argument can be null.
  
  Returns:
  
  Returns a new Schema Provider configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Schema Provider is invalid.
- removeSchemaProvider
  
  void removeSchemaProvider(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Schema Provider.
  
  Parameters:
  
  name - The name of the Schema Provider to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Schema Provider does not exist.
  
  OperationRejectedException - If the server refuses to remove the Schema Provider due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listServiceDiscoveryMechanisms
  
  String[] listServiceDiscoveryMechanisms() throws ConcurrentModificationException, LdapException
  
  Lists the Service Discovery Mechanisms.
  
  Returns:
  
  Returns an array containing the names of the Service Discovery Mechanisms.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getServiceDiscoveryMechanism
  
  ServiceDiscoveryMechanismCfgClient getServiceDiscoveryMechanism(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Service Discovery Mechanism.
  
  Parameters:
  
  name - The name of the Service Discovery Mechanism to retrieve.
  
  Returns:
  
  Returns the named Service Discovery Mechanism.
  
  Throws:
  
  DefinitionDecodingException - If the named Service Discovery Mechanism was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Service Discovery Mechanism was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Service Discovery Mechanism was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createServiceDiscoveryMechanism
  
  <C extends ServiceDiscoveryMechanismCfgClient> C createServiceDiscoveryMechanism(ManagedObjectDefinition<C,? extends ServiceDiscoveryMechanismCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Service Discovery Mechanism. The new Service Discovery Mechanism will initially not contain any property values (including mandatory properties). Once the Service Discovery Mechanism has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Service Discovery Mechanism being created.
  
  Parameters:
  
  d - The definition of the Service Discovery Mechanism to be created.
  
  name - The name of the new Service Discovery Mechanism.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Service Discovery Mechanism. This argument can be null.
  
  Returns:
  
  Returns a new Service Discovery Mechanism configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Service Discovery Mechanism is invalid.
- removeServiceDiscoveryMechanism
  
  void removeServiceDiscoveryMechanism(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Service Discovery Mechanism.
  
  Parameters:
  
  name - The name of the Service Discovery Mechanism to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Service Discovery Mechanism does not exist.
  
  OperationRejectedException - If the server refuses to remove the Service Discovery Mechanism due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listSynchronizationProviders
  
  String[] listSynchronizationProviders() throws ConcurrentModificationException, LdapException
  
  Lists the Synchronization Providers.
  
  Returns:
  
  Returns an array containing the names of the Synchronization Providers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getSynchronizationProvider
  
  SynchronizationProviderCfgClient getSynchronizationProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Synchronization Provider.
  
  Parameters:
  
  name - The name of the Synchronization Provider to retrieve.
  
  Returns:
  
  Returns the named Synchronization Provider.
  
  Throws:
  
  DefinitionDecodingException - If the named Synchronization Provider was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Synchronization Provider was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Synchronization Provider was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createSynchronizationProvider
  
  <C extends SynchronizationProviderCfgClient> C createSynchronizationProvider(ManagedObjectDefinition<C,? extends SynchronizationProviderCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Synchronization Provider. The new Synchronization Provider will initially not contain any property values (including mandatory properties). Once the Synchronization Provider has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Synchronization Provider being created.
  
  Parameters:
  
  d - The definition of the Synchronization Provider to be created.
  
  name - The name of the new Synchronization Provider.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Synchronization Provider. This argument can be null.
  
  Returns:
  
  Returns a new Synchronization Provider configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Synchronization Provider is invalid.
- removeSynchronizationProvider
  
  void removeSynchronizationProvider(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Synchronization Provider.
  
  Parameters:
  
  name - The name of the Synchronization Provider to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Synchronization Provider does not exist.
  
  OperationRejectedException - If the server refuses to remove the Synchronization Provider due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listTrustManagerProviders
  
  String[] listTrustManagerProviders() throws ConcurrentModificationException, LdapException
  
  Lists the Trust Manager Providers.
  
  Returns:
  
  Returns an array containing the names of the Trust Manager Providers.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getTrustManagerProvider
  
  TrustManagerProviderCfgClient getTrustManagerProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Trust Manager Provider.
  
  Parameters:
  
  name - The name of the Trust Manager Provider to retrieve.
  
  Returns:
  
  Returns the named Trust Manager Provider.
  
  Throws:
  
  DefinitionDecodingException - If the named Trust Manager Provider was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Trust Manager Provider was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Trust Manager Provider was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createTrustManagerProvider
  
  <C extends TrustManagerProviderCfgClient> C createTrustManagerProvider(ManagedObjectDefinition<C,? extends TrustManagerProviderCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Trust Manager Provider. The new Trust Manager Provider will initially not contain any property values (including mandatory properties). Once the Trust Manager Provider has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Trust Manager Provider being created.
  
  Parameters:
  
  d - The definition of the Trust Manager Provider to be created.
  
  name - The name of the new Trust Manager Provider.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Trust Manager Provider. This argument can be null.
  
  Returns:
  
  Returns a new Trust Manager Provider configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Trust Manager Provider is invalid.
- removeTrustManagerProvider
  
  void removeTrustManagerProvider(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Trust Manager Provider.
  
  Parameters:
  
  name - The name of the Trust Manager Provider to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Trust Manager Provider does not exist.
  
  OperationRejectedException - If the server refuses to remove the Trust Manager Provider due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- listVirtualAttributes
  
  String[] listVirtualAttributes() throws ConcurrentModificationException, LdapException
  
  Lists the Virtual Attributes.
  
  Returns:
  
  Returns an array containing the names of the Virtual Attributes.
  
  Throws:
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getVirtualAttribute
  
  VirtualAttributeCfgClient getVirtualAttribute(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the named Virtual Attribute.
  
  Parameters:
  
  name - The name of the Virtual Attribute to retrieve.
  
  Returns:
  
  Returns the named Virtual Attribute.
  
  Throws:
  
  DefinitionDecodingException - If the named Virtual Attribute was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the named Virtual Attribute was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the named Virtual Attribute was not found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- createVirtualAttribute
  
  <C extends VirtualAttributeCfgClient> C createVirtualAttribute(ManagedObjectDefinition<C,? extends VirtualAttributeCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException
  
  Creates a new Virtual Attribute. The new Virtual Attribute will initially not contain any property values (including mandatory properties). Once the Virtual Attribute has been configured it can be added to the server using the ConfigurationClient.commit() method.
  
  Type Parameters:
  
  C - The type of the Virtual Attribute being created.
  
  Parameters:
  
  d - The definition of the Virtual Attribute to be created.
  
  name - The name of the new Virtual Attribute.
  
  exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Virtual Attribute. This argument can be null.
  
  Returns:
  
  Returns a new Virtual Attribute configuration instance.
  
  Throws:
  
  IllegalManagedObjectNameException - If the name of the new Virtual Attribute is invalid.
- removeVirtualAttribute
  
  void removeVirtualAttribute(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, LdapException
  
  Removes the named Virtual Attribute.
  
  Parameters:
  
  name - The name of the Virtual Attribute to remove.
  
  Throws:
  
  ManagedObjectNotFoundException - If the Virtual Attribute does not exist.
  
  OperationRejectedException - If the server refuses to remove the Virtual Attribute due to some server-side constraint which cannot be satisfied (for example, if it is referenced by another managed object).
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.
- getWorkQueue
  
  WorkQueueCfgClient getWorkQueue() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, LdapException
  
  Gets the Work Queue.
  
  Returns:
  
  Returns the Work Queue.
  
  Throws:
  
  DefinitionDecodingException - If the Work Queue was found but its type could not be determined.
  
  ManagedObjectDecodingException - If the Work Queue was found but one or more of its properties could not be decoded.
  
  ManagedObjectNotFoundException - If the Work Queue could not be found on the server.
  
  ConcurrentModificationException - If this Root has been removed from the server by another client.
  
  LdapException - If any other error occurs.

Interface RootCfgClient

Method Summary

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

Method Details

definition

hasAccessControlHandler

getAccessControlHandler

createAccessControlHandler

removeAccessControlHandler

listAccountStatusNotificationHandlers

getAccountStatusNotificationHandler

createAccountStatusNotificationHandler

removeAccountStatusNotificationHandler

getAdministrationConnector

listAlertHandlers

getAlertHandler

createAlertHandler

removeAlertHandler

listBackends

getBackend

createBackend

removeBackend

listCertificateMappers

getCertificateMapper

createCertificateMapper

removeCertificateMapper

listConnectionHandlers

getConnectionHandler

createConnectionHandler

removeConnectionHandler

getCryptoManager

listEntryCaches

getEntryCache

createEntryCache

removeEntryCache

listExtendedOperationHandlers

getExtendedOperationHandler

createExtendedOperationHandler

removeExtendedOperationHandler

getGlobalConfiguration

listHttpAuthorizationMechanisms

getHttpAuthorizationMechanism

createHttpAuthorizationMechanism

removeHttpAuthorizationMechanism

listHttpEndpoints

getHttpEndpoint

createHttpEndpoint

removeHttpEndpoint

listIdentityMappers

getIdentityMapper

createIdentityMapper

removeIdentityMapper

listKeyManagerProviders

getKeyManagerProvider

createKeyManagerProvider

removeKeyManagerProvider

listLogPublishers

getLogPublisher

createLogPublisher

removeLogPublisher

listLogRetentionPolicies

getLogRetentionPolicy

createLogRetentionPolicy

removeLogRetentionPolicy

listLogRotationPolicies

getLogRotationPolicy

createLogRotationPolicy

removeLogRotationPolicy

listMailServers

getMailServer

createMailServer

removeMailServer

listPasswordGenerators

getPasswordGenerator

createPasswordGenerator

removePasswordGenerator

listPasswordPolicies

getPasswordPolicy

createPasswordPolicy

removePasswordPolicy