RootCfgClient (OpenDJ 3.0.0 Documentation)

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

Methods
Modifier and Type	Method and Description
`<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 AttributeSyntaxCfgClient> C`	`createAttributeSyntax(ManagedObjectDefinition<C,? extends AttributeSyntaxCfg> d, String name, Collection<PropertyException> exceptions)` Creates a new Attribute Syntax.
`<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 GroupImplementationCfgClient> C`	`createGroupImplementation(ManagedObjectDefinition<C,? extends GroupImplementationCfg> d, String name, Collection<PropertyException> exceptions)` Creates a new Group Implementation.
`<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 MatchingRuleCfgClient> C`	`createMatchingRule(ManagedObjectDefinition<C,? extends MatchingRuleCfg> d, String name, Collection<PropertyException> exceptions)` Creates a new Matching Rule.
`<C extends MonitorProviderCfgClient> C`	`createMonitorProvider(ManagedObjectDefinition<C,? extends MonitorProviderCfg> d, String name, Collection<PropertyException> exceptions)` Creates a new Monitor Provider.
`<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 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.
`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.
`AttributeSyntaxCfgClient`	`getAttributeSyntax(String name)` Gets the named Attribute Syntax.
`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.
`GroupImplementationCfgClient`	`getGroupImplementation(String name)` Gets the named Group Implementation.
`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.
`MatchingRuleCfgClient`	`getMatchingRule(String name)` Gets the named Matching Rule.
`MonitorProviderCfgClient`	`getMonitorProvider(String name)` Gets the named Monitor Provider.
`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.
`RootDNCfgClient`	`getRootDN()` Gets the Root DN.
`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.
`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.
`String[]`	`listAccountStatusNotificationHandlers()` Lists the Account Status Notification Handlers.
`String[]`	`listAlertHandlers()` Lists the Alert Handlers.
`String[]`	`listAttributeSyntaxes()` Lists the Attribute Syntaxes.
`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[]`	`listGroupImplementations()` Lists the Group Implementations.
`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[]`	`listMatchingRules()` Lists the Matching Rules.
`String[]`	`listMonitorProviders()` Lists the Monitor Providers.
`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[]`	`listSynchronizationProviders()` Lists the Synchronization Providers.
`String[]`	`listTrustManagerProviders()` Lists the Trust Manager Providers.
`String[]`	`listVirtualAttributes()` Lists the Virtual Attributes.
`void`	`removeAccountStatusNotificationHandler(String name)` Removes the named Account Status Notification Handler.
`void`	`removeAlertHandler(String name)` Removes the named Alert Handler.
`void`	`removeAttributeSyntax(String name)` Removes the named Attribute Syntax.
`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`	`removeGroupImplementation(String name)` Removes the named Group Implementation.
`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`	`removeMatchingRule(String name)` Removes the named Matching Rule.
`void`	`removeMonitorProvider(String name)` Removes the named Monitor Provider.
`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`	`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.opends.server.admin.ConfigurationClient
commit, properties

- Method Detail
  - 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.
  - getAccessControlHandler
```
AccessControlHandlerCfgClient getAccessControlHandler()
                                                      throws DefinitionDecodingException,
                                                             ManagedObjectDecodingException,
                                                             ManagedObjectNotFoundException,
                                                             ConcurrentModificationException,
                                                             AuthorizationException,
                                                             CommunicationException
```
    Gets the Access Control Handler.
    
    Returns:
    Returns the Access Control Handler.
    
    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 could not be found on the server.
    
    ConcurrentModificationException - If this Root has been removed from the server by another client.
    
    AuthorizationException - If the server refuses to retrieve the Access Control Handler because the client does not have the correct privileges.
    
    CommunicationException - If the client cannot contact the server due to an underlying communication problem.
  - listAccountStatusNotificationHandlers
```
String[] listAccountStatusNotificationHandlers()
                                               throws ConcurrentModificationException,
                                                      AuthorizationException,
                                                      CommunicationException
```
    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.
    
    AuthorizationException - If the server refuses to list the Account Status Notification Handlers because the client does not have the correct privileges.
    
    CommunicationException - If the client cannot contact the server due to an underlying communication problem.
  - getAccountStatusNotificationHandler
```
AccountStatusNotificationHandlerCfgClient getAccountStatusNotificationHandler(String name)
                                                                              throws DefinitionDecodingException,
                                                                                     ManagedObjectDecodingException,
                                                                                     ManagedObjectNotFoundException,
                                                                                     ConcurrentModificationException,
                                                                                     AuthorizationException,
                                                                                     CommunicationException
```
    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.
    
    AuthorizationException - If the server refuses to retrieve the named Account Status Notification Handler because the client does not have the correct privileges.
    
    CommunicationException - If the client cannot contact the server due to an underlying communication problem.
  - 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Account Status Notification Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getAdministrationConnector AdministrationConnectorCfgClient getAdministrationConnector() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Administration Connector because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listAlertHandlers String[] listAlertHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Alert Handlers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getAlertHandler AlertHandlerCfgClient getAlertHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Alert Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Alert Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listAttributeSyntaxes String[] listAttributeSyntaxes() throws ConcurrentModificationException, AuthorizationException, CommunicationException Lists the Attribute Syntaxes. Returns: Returns an array containing the names of the Attribute Syntaxes. Throws: ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to list the Attribute Syntaxes because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getAttributeSyntax AttributeSyntaxCfgClient getAttributeSyntax(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException Gets the named Attribute Syntax. Parameters: name - The name of the Attribute Syntax to retrieve. Returns: Returns the named Attribute Syntax. Throws: DefinitionDecodingException - If the named Attribute Syntax was found but its type could not be determined. ManagedObjectDecodingException - If the named Attribute Syntax was found but one or more of its properties could not be decoded. ManagedObjectNotFoundException - If the named Attribute Syntax was not found on the server. ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to retrieve the named Attribute Syntax because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. createAttributeSyntax <C extends AttributeSyntaxCfgClient> C createAttributeSyntax(ManagedObjectDefinition<C,? extends AttributeSyntaxCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException Creates a new Attribute Syntax. The new Attribute Syntax will initially not contain any property values (including mandatory properties). Once the Attribute Syntax has been configured it can be added to the server using the ConfigurationClient.commit() method. Type Parameters: C - The type of the Attribute Syntax being created. Parameters: d - The definition of the Attribute Syntax to be created. name - The name of the new Attribute Syntax. exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Attribute Syntax. This argument can be null. Returns: Returns a new Attribute Syntax configuration instance. Throws: IllegalManagedObjectNameException - If the name of the new Attribute Syntax is invalid. removeAttributeSyntax void removeAttributeSyntax(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException Removes the named Attribute Syntax. Parameters: name - The name of the Attribute Syntax to remove. Throws: ManagedObjectNotFoundException - If the Attribute Syntax does not exist. OperationRejectedException - If the server refuses to remove the Attribute Syntax 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. AuthorizationException - If the server refuses to remove the Attribute Syntax because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listBackends String[] listBackends() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Backends because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getBackend BackendCfgClient getBackend(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Backend because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Backend because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listCertificateMappers String[] listCertificateMappers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Certificate Mappers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getCertificateMapper CertificateMapperCfgClient getCertificateMapper(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Certificate Mapper because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Certificate Mapper because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listConnectionHandlers String[] listConnectionHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Connection Handlers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getConnectionHandler ConnectionHandlerCfgClient getConnectionHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Connection Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Connection Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getCryptoManager CryptoManagerCfgClient getCryptoManager() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Crypto Manager because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listEntryCaches String[] listEntryCaches() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Entry Caches because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getEntryCache EntryCacheCfgClient getEntryCache(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Entry Cache because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Entry Cache because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listExtendedOperationHandlers String[] listExtendedOperationHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Extended Operation Handlers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getExtendedOperationHandler ExtendedOperationHandlerCfgClient getExtendedOperationHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Extended Operation Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Extended Operation Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getGlobalConfiguration GlobalCfgClient getGlobalConfiguration() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Global Configuration because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listGroupImplementations String[] listGroupImplementations() throws ConcurrentModificationException, AuthorizationException, CommunicationException Lists the Group Implementations. Returns: Returns an array containing the names of the Group Implementations. Throws: ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to list the Group Implementations because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getGroupImplementation GroupImplementationCfgClient getGroupImplementation(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException Gets the named Group Implementation. Parameters: name - The name of the Group Implementation to retrieve. Returns: Returns the named Group Implementation. Throws: DefinitionDecodingException - If the named Group Implementation was found but its type could not be determined. ManagedObjectDecodingException - If the named Group Implementation was found but one or more of its properties could not be decoded. ManagedObjectNotFoundException - If the named Group Implementation was not found on the server. ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to retrieve the named Group Implementation because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. createGroupImplementation <C extends GroupImplementationCfgClient> C createGroupImplementation(ManagedObjectDefinition<C,? extends GroupImplementationCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException Creates a new Group Implementation. The new Group Implementation will initially not contain any property values (including mandatory properties). Once the Group Implementation has been configured it can be added to the server using the ConfigurationClient.commit() method. Type Parameters: C - The type of the Group Implementation being created. Parameters: d - The definition of the Group Implementation to be created. name - The name of the new Group Implementation. exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Group Implementation. This argument can be null. Returns: Returns a new Group Implementation configuration instance. Throws: IllegalManagedObjectNameException - If the name of the new Group Implementation is invalid. removeGroupImplementation void removeGroupImplementation(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException Removes the named Group Implementation. Parameters: name - The name of the Group Implementation to remove. Throws: ManagedObjectNotFoundException - If the Group Implementation does not exist. OperationRejectedException - If the server refuses to remove the Group Implementation 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. AuthorizationException - If the server refuses to remove the Group Implementation because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listIdentityMappers String[] listIdentityMappers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Identity Mappers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getIdentityMapper IdentityMapperCfgClient getIdentityMapper(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Identity Mapper because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Identity Mapper because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listKeyManagerProviders String[] listKeyManagerProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Key Manager Providers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getKeyManagerProvider KeyManagerProviderCfgClient getKeyManagerProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Key Manager Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Key Manager Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listLogPublishers String[] listLogPublishers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Log Publishers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getLogPublisher LogPublisherCfgClient getLogPublisher(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Log Publisher because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Log Publisher because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listLogRetentionPolicies String[] listLogRetentionPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Log Retention Policies because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getLogRetentionPolicy LogRetentionPolicyCfgClient getLogRetentionPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Log Retention Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Log Retention Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listLogRotationPolicies String[] listLogRotationPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Log Rotation Policies because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getLogRotationPolicy LogRotationPolicyCfgClient getLogRotationPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Log Rotation Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Log Rotation Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listMatchingRules String[] listMatchingRules() throws ConcurrentModificationException, AuthorizationException, CommunicationException Lists the Matching Rules. Returns: Returns an array containing the names of the Matching Rules. Throws: ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to list the Matching Rules because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getMatchingRule MatchingRuleCfgClient getMatchingRule(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException Gets the named Matching Rule. Parameters: name - The name of the Matching Rule to retrieve. Returns: Returns the named Matching Rule. Throws: DefinitionDecodingException - If the named Matching Rule was found but its type could not be determined. ManagedObjectDecodingException - If the named Matching Rule was found but one or more of its properties could not be decoded. ManagedObjectNotFoundException - If the named Matching Rule was not found on the server. ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to retrieve the named Matching Rule because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. createMatchingRule <C extends MatchingRuleCfgClient> C createMatchingRule(ManagedObjectDefinition<C,? extends MatchingRuleCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException Creates a new Matching Rule. The new Matching Rule will initially not contain any property values (including mandatory properties). Once the Matching Rule has been configured it can be added to the server using the ConfigurationClient.commit() method. Type Parameters: C - The type of the Matching Rule being created. Parameters: d - The definition of the Matching Rule to be created. name - The name of the new Matching Rule. exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Matching Rule. This argument can be null. Returns: Returns a new Matching Rule configuration instance. Throws: IllegalManagedObjectNameException - If the name of the new Matching Rule is invalid. removeMatchingRule void removeMatchingRule(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException Removes the named Matching Rule. Parameters: name - The name of the Matching Rule to remove. Throws: ManagedObjectNotFoundException - If the Matching Rule does not exist. OperationRejectedException - If the server refuses to remove the Matching Rule 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. AuthorizationException - If the server refuses to remove the Matching Rule because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listMonitorProviders String[] listMonitorProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException Lists the Monitor Providers. Returns: Returns an array containing the names of the Monitor Providers. Throws: ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to list the Monitor Providers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getMonitorProvider MonitorProviderCfgClient getMonitorProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException Gets the named Monitor Provider. Parameters: name - The name of the Monitor Provider to retrieve. Returns: Returns the named Monitor Provider. Throws: DefinitionDecodingException - If the named Monitor Provider was found but its type could not be determined. ManagedObjectDecodingException - If the named Monitor Provider was found but one or more of its properties could not be decoded. ManagedObjectNotFoundException - If the named Monitor Provider was not found on the server. ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to retrieve the named Monitor Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. createMonitorProvider <C extends MonitorProviderCfgClient> C createMonitorProvider(ManagedObjectDefinition<C,? extends MonitorProviderCfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException Creates a new Monitor Provider. The new Monitor Provider will initially not contain any property values (including mandatory properties). Once the Monitor Provider has been configured it can be added to the server using the ConfigurationClient.commit() method. Type Parameters: C - The type of the Monitor Provider being created. Parameters: d - The definition of the Monitor Provider to be created. name - The name of the new Monitor Provider. exceptions - An optional collection in which to place any PropertyExceptions that occurred whilst attempting to determine the default values of the Monitor Provider. This argument can be null. Returns: Returns a new Monitor Provider configuration instance. Throws: IllegalManagedObjectNameException - If the name of the new Monitor Provider is invalid. removeMonitorProvider void removeMonitorProvider(String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException Removes the named Monitor Provider. Parameters: name - The name of the Monitor Provider to remove. Throws: ManagedObjectNotFoundException - If the Monitor Provider does not exist. OperationRejectedException - If the server refuses to remove the Monitor 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. AuthorizationException - If the server refuses to remove the Monitor Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listPasswordGenerators String[] listPasswordGenerators() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Password Generators because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getPasswordGenerator PasswordGeneratorCfgClient getPasswordGenerator(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Password Generator because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Password Generator because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listPasswordPolicies String[] listPasswordPolicies() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Password Policies because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getPasswordPolicy AuthenticationPolicyCfgClient getPasswordPolicy(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Password Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Password Policy because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listPasswordStorageSchemes String[] listPasswordStorageSchemes() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Password Storage Schemes because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getPasswordStorageScheme PasswordStorageSchemeCfgClient getPasswordStorageScheme(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Password Storage Scheme because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Password Storage Scheme because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listPasswordValidators String[] listPasswordValidators() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Password Validators because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getPasswordValidator PasswordValidatorCfgClient getPasswordValidator(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Password Validator because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Password Validator because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getPluginRoot PluginRootCfgClient getPluginRoot() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Plugin Root because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getRootDN RootDNCfgClient getRootDN() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException Gets the Root DN. Returns: Returns the Root DN. Throws: DefinitionDecodingException - If the Root DN was found but its type could not be determined. ManagedObjectDecodingException - If the Root DN was found but one or more of its properties could not be decoded. ManagedObjectNotFoundException - If the Root DN could not be found on the server. ConcurrentModificationException - If this Root has been removed from the server by another client. AuthorizationException - If the server refuses to retrieve the Root DN because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getRootDSEBackend RootDSEBackendCfgClient getRootDSEBackend() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Root DSE Backend because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listSASLMechanismHandlers String[] listSASLMechanismHandlers() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the SASL Mechanism Handlers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getSASLMechanismHandler SASLMechanismHandlerCfgClient getSASLMechanismHandler(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named SASL Mechanism Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the SASL Mechanism Handler because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listSchemaProviders String[] listSchemaProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Schema Providers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getSchemaProvider SchemaProviderCfgClient getSchemaProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Schema Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Schema Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listSynchronizationProviders String[] listSynchronizationProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Synchronization Providers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getSynchronizationProvider SynchronizationProviderCfgClient getSynchronizationProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Synchronization Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Synchronization Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listTrustManagerProviders String[] listTrustManagerProviders() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Trust Manager Providers because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getTrustManagerProvider TrustManagerProviderCfgClient getTrustManagerProvider(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Trust Manager Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Trust Manager Provider because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. listVirtualAttributes String[] listVirtualAttributes() throws ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to list the Virtual Attributes because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getVirtualAttribute VirtualAttributeCfgClient getVirtualAttribute(String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the named Virtual Attribute because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. 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, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to remove the Virtual Attribute because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem. getWorkQueue WorkQueueCfgClient getWorkQueue() throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException 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. AuthorizationException - If the server refuses to retrieve the Work Queue because the client does not have the correct privileges. CommunicationException - If the client cannot contact the server due to an underlying communication problem.

Interface RootCfgClient

Method Summary

Methods inherited from interface org.opends.server.admin.ConfigurationClient

Method Detail

definition

getAccessControlHandler

listAccountStatusNotificationHandlers

getAccountStatusNotificationHandler

createAccountStatusNotificationHandler

removeAccountStatusNotificationHandler

getAdministrationConnector

listAlertHandlers

getAlertHandler

createAlertHandler

removeAlertHandler

listAttributeSyntaxes

getAttributeSyntax

createAttributeSyntax

removeAttributeSyntax

listBackends

getBackend

createBackend

removeBackend

listCertificateMappers

getCertificateMapper

createCertificateMapper

removeCertificateMapper

listConnectionHandlers

getConnectionHandler

createConnectionHandler

removeConnectionHandler

getCryptoManager

listEntryCaches

getEntryCache

createEntryCache

removeEntryCache

listExtendedOperationHandlers

getExtendedOperationHandler

createExtendedOperationHandler

removeExtendedOperationHandler

getGlobalConfiguration

listGroupImplementations

getGroupImplementation

createGroupImplementation

removeGroupImplementation

listIdentityMappers

getIdentityMapper

createIdentityMapper

removeIdentityMapper

listKeyManagerProviders

getKeyManagerProvider

createKeyManagerProvider

removeKeyManagerProvider

listLogPublishers

getLogPublisher

createLogPublisher

removeLogPublisher

listLogRetentionPolicies

getLogRetentionPolicy

createLogRetentionPolicy

removeLogRetentionPolicy

listLogRotationPolicies

getLogRotationPolicy

createLogRotationPolicy

removeLogRotationPolicy

listMatchingRules

getMatchingRule

createMatchingRule

removeMatchingRule

listMonitorProviders

getMonitorProvider

createMonitorProvider

removeMonitorProvider

listPasswordGenerators

getPasswordGenerator

createPasswordGenerator

removePasswordGenerator

listPasswordPolicies

getPasswordPolicy

createPasswordPolicy