Interface RootCfg

  • All Superinterfaces:
    Configuration

    public interface RootCfg
    extends Configuration
    A server-side interface for querying Root settings.

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

    • Method Detail

      • configurationClass

        Class<? extends RootCfg> configurationClass()
        Gets the configuration class associated with this Root.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Root.
      • hasAccessControlHandler

        boolean hasAccessControlHandler()
        Determines whether the Access Control Handler exists.
        Returns:
        Returns true if the Access Control Handler exists.
      • getAccessControlHandler

        AccessControlHandlerCfg getAccessControlHandler()
                                                 throws ConfigException
        Gets the Access Control Handler if it is present.
        Returns:
        Returns the Access Control Handler if it is present.
        Throws:
        ConfigException - If the Access Control Handler does not exist or it could not be successfully decoded.
      • removeAccessControlHandlerAddListener

        void removeAccessControlHandlerAddListener​(ConfigurationAddListener<AccessControlHandlerCfg> listener)
        Deregisters an existing Access Control Handler configuration add listener.
        Parameters:
        listener - The Access Control Handler configuration add listener.
      • removeAccessControlHandlerDeleteListener

        void removeAccessControlHandlerDeleteListener​(ConfigurationDeleteListener<AccessControlHandlerCfg> listener)
        Deregisters an existing Access Control Handler configuration delete listener.
        Parameters:
        listener - The Access Control Handler configuration delete listener.
      • listAccountStatusNotificationHandlers

        String[] listAccountStatusNotificationHandlers()
        Lists the Account Status Notification Handlers.
        Returns:
        Returns an array containing the names of the Account Status Notification Handlers.
      • getAccountStatusNotificationHandler

        AccountStatusNotificationHandlerCfg getAccountStatusNotificationHandler​(String name)
                                                                         throws ConfigException
        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:
        ConfigException - If the Account Status Notification Handler could not be found or it could not be successfully decoded.
      • removeAccountStatusNotificationHandlerAddListener

        void removeAccountStatusNotificationHandlerAddListener​(ConfigurationAddListener<AccountStatusNotificationHandlerCfg> listener)
        Deregisters an existing Account Status Notification Handler configuration add listener.
        Parameters:
        listener - The Account Status Notification Handler configuration add listener.
      • addAccountStatusNotificationHandlerDeleteListener

        void addAccountStatusNotificationHandlerDeleteListener​(ConfigurationDeleteListener<AccountStatusNotificationHandlerCfg> listener)
                                                        throws ConfigException
        Registers to be notified when existing Account Status Notification Handlers are deleted.
        Parameters:
        listener - The Account Status Notification Handler configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeAccountStatusNotificationHandlerDeleteListener

        void removeAccountStatusNotificationHandlerDeleteListener​(ConfigurationDeleteListener<AccountStatusNotificationHandlerCfg> listener)
        Deregisters an existing Account Status Notification Handler configuration delete listener.
        Parameters:
        listener - The Account Status Notification Handler configuration delete listener.
      • getAdministrationConnector

        AdministrationConnectorCfg getAdministrationConnector()
                                                       throws ConfigException
        Gets the Administration Connector.
        Returns:
        Returns the Administration Connector.
        Throws:
        ConfigException - If the Administration Connector could not be found or it could not be successfully decoded.
      • listAlertHandlers

        String[] listAlertHandlers()
        Lists the Alert Handlers.
        Returns:
        Returns an array containing the names of the Alert Handlers.
      • getAlertHandler

        AlertHandlerCfg getAlertHandler​(String name)
                                 throws ConfigException
        Gets the named Alert Handler.
        Parameters:
        name - The name of the Alert Handler to retrieve.
        Returns:
        Returns the named Alert Handler.
        Throws:
        ConfigException - If the Alert Handler could not be found or it could not be successfully decoded.
      • removeAlertHandlerAddListener

        void removeAlertHandlerAddListener​(ConfigurationAddListener<AlertHandlerCfg> listener)
        Deregisters an existing Alert Handler configuration add listener.
        Parameters:
        listener - The Alert Handler configuration add listener.
      • addAlertHandlerDeleteListener

        void addAlertHandlerDeleteListener​(ConfigurationDeleteListener<AlertHandlerCfg> listener)
                                    throws ConfigException
        Registers to be notified when existing Alert Handlers are deleted.
        Parameters:
        listener - The Alert Handler configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeAlertHandlerDeleteListener

        void removeAlertHandlerDeleteListener​(ConfigurationDeleteListener<AlertHandlerCfg> listener)
        Deregisters an existing Alert Handler configuration delete listener.
        Parameters:
        listener - The Alert Handler configuration delete listener.
      • listBackends

        String[] listBackends()
        Lists the Backends.
        Returns:
        Returns an array containing the names of the Backends.
      • getBackend

        BackendCfg getBackend​(String name)
                       throws ConfigException
        Gets the named Backend.
        Parameters:
        name - The name of the Backend to retrieve.
        Returns:
        Returns the named Backend.
        Throws:
        ConfigException - If the Backend could not be found or it could not be successfully decoded.
      • removeBackendAddListener

        void removeBackendAddListener​(ConfigurationAddListener<BackendCfg> listener)
        Deregisters an existing Backend configuration add listener.
        Parameters:
        listener - The Backend configuration add listener.
      • addBackendDeleteListener

        void addBackendDeleteListener​(ConfigurationDeleteListener<BackendCfg> listener)
                               throws ConfigException
        Registers to be notified when existing Backends are deleted.
        Parameters:
        listener - The Backend configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeBackendDeleteListener

        void removeBackendDeleteListener​(ConfigurationDeleteListener<BackendCfg> listener)
        Deregisters an existing Backend configuration delete listener.
        Parameters:
        listener - The Backend configuration delete listener.
      • listCertificateMappers

        String[] listCertificateMappers()
        Lists the Certificate Mappers.
        Returns:
        Returns an array containing the names of the Certificate Mappers.
      • getCertificateMapper

        CertificateMapperCfg getCertificateMapper​(String name)
                                           throws ConfigException
        Gets the named Certificate Mapper.
        Parameters:
        name - The name of the Certificate Mapper to retrieve.
        Returns:
        Returns the named Certificate Mapper.
        Throws:
        ConfigException - If the Certificate Mapper could not be found or it could not be successfully decoded.
      • removeCertificateMapperAddListener

        void removeCertificateMapperAddListener​(ConfigurationAddListener<CertificateMapperCfg> listener)
        Deregisters an existing Certificate Mapper configuration add listener.
        Parameters:
        listener - The Certificate Mapper configuration add listener.
      • addCertificateMapperDeleteListener

        void addCertificateMapperDeleteListener​(ConfigurationDeleteListener<CertificateMapperCfg> listener)
                                         throws ConfigException
        Registers to be notified when existing Certificate Mappers are deleted.
        Parameters:
        listener - The Certificate Mapper configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeCertificateMapperDeleteListener

        void removeCertificateMapperDeleteListener​(ConfigurationDeleteListener<CertificateMapperCfg> listener)
        Deregisters an existing Certificate Mapper configuration delete listener.
        Parameters:
        listener - The Certificate Mapper configuration delete listener.
      • listConnectionHandlers

        String[] listConnectionHandlers()
        Lists the Connection Handlers.
        Returns:
        Returns an array containing the names of the Connection Handlers.
      • getConnectionHandler

        ConnectionHandlerCfg getConnectionHandler​(String name)
                                           throws ConfigException
        Gets the named Connection Handler.
        Parameters:
        name - The name of the Connection Handler to retrieve.
        Returns:
        Returns the named Connection Handler.
        Throws:
        ConfigException - If the Connection Handler could not be found or it could not be successfully decoded.
      • removeConnectionHandlerAddListener

        void removeConnectionHandlerAddListener​(ConfigurationAddListener<ConnectionHandlerCfg> listener)
        Deregisters an existing Connection Handler configuration add listener.
        Parameters:
        listener - The Connection Handler configuration add listener.
      • addConnectionHandlerDeleteListener

        void addConnectionHandlerDeleteListener​(ConfigurationDeleteListener<ConnectionHandlerCfg> listener)
                                         throws ConfigException
        Registers to be notified when existing Connection Handlers are deleted.
        Parameters:
        listener - The Connection Handler configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeConnectionHandlerDeleteListener

        void removeConnectionHandlerDeleteListener​(ConfigurationDeleteListener<ConnectionHandlerCfg> listener)
        Deregisters an existing Connection Handler configuration delete listener.
        Parameters:
        listener - The Connection Handler configuration delete listener.
      • getCryptoManager

        CryptoManagerCfg getCryptoManager()
                                   throws ConfigException
        Gets the Crypto Manager.
        Returns:
        Returns the Crypto Manager.
        Throws:
        ConfigException - If the Crypto Manager could not be found or it could not be successfully decoded.
      • listEntryCaches

        String[] listEntryCaches()
        Lists the Entry Caches.
        Returns:
        Returns an array containing the names of the Entry Caches.
      • getEntryCache

        EntryCacheCfg getEntryCache​(String name)
                             throws ConfigException
        Gets the named Entry Cache.
        Parameters:
        name - The name of the Entry Cache to retrieve.
        Returns:
        Returns the named Entry Cache.
        Throws:
        ConfigException - If the Entry Cache could not be found or it could not be successfully decoded.
      • removeEntryCacheAddListener

        void removeEntryCacheAddListener​(ConfigurationAddListener<EntryCacheCfg> listener)
        Deregisters an existing Entry Cache configuration add listener.
        Parameters:
        listener - The Entry Cache configuration add listener.
      • addEntryCacheDeleteListener

        void addEntryCacheDeleteListener​(ConfigurationDeleteListener<EntryCacheCfg> listener)
                                  throws ConfigException
        Registers to be notified when existing Entry Caches are deleted.
        Parameters:
        listener - The Entry Cache configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeEntryCacheDeleteListener

        void removeEntryCacheDeleteListener​(ConfigurationDeleteListener<EntryCacheCfg> listener)
        Deregisters an existing Entry Cache configuration delete listener.
        Parameters:
        listener - The Entry Cache configuration delete listener.
      • listExtendedOperationHandlers

        String[] listExtendedOperationHandlers()
        Lists the Extended Operation Handlers.
        Returns:
        Returns an array containing the names of the Extended Operation Handlers.
      • getExtendedOperationHandler

        ExtendedOperationHandlerCfg getExtendedOperationHandler​(String name)
                                                         throws ConfigException
        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:
        ConfigException - If the Extended Operation Handler could not be found or it could not be successfully decoded.
      • removeExtendedOperationHandlerAddListener

        void removeExtendedOperationHandlerAddListener​(ConfigurationAddListener<ExtendedOperationHandlerCfg> listener)
        Deregisters an existing Extended Operation Handler configuration add listener.
        Parameters:
        listener - The Extended Operation Handler configuration add listener.
      • addExtendedOperationHandlerDeleteListener

        void addExtendedOperationHandlerDeleteListener​(ConfigurationDeleteListener<ExtendedOperationHandlerCfg> listener)
                                                throws ConfigException
        Registers to be notified when existing Extended Operation Handlers are deleted.
        Parameters:
        listener - The Extended Operation Handler configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeExtendedOperationHandlerDeleteListener

        void removeExtendedOperationHandlerDeleteListener​(ConfigurationDeleteListener<ExtendedOperationHandlerCfg> listener)
        Deregisters an existing Extended Operation Handler configuration delete listener.
        Parameters:
        listener - The Extended Operation Handler configuration delete listener.
      • getGlobalConfiguration

        GlobalCfg getGlobalConfiguration()
                                  throws ConfigException
        Gets the Global Configuration.
        Returns:
        Returns the Global Configuration.
        Throws:
        ConfigException - If the Global Configuration could not be found or it could not be successfully decoded.
      • listHttpAuthorizationMechanisms

        String[] listHttpAuthorizationMechanisms()
        Lists the Http Authorization Mechanisms.
        Returns:
        Returns an array containing the names of the Http Authorization Mechanisms.
      • getHttpAuthorizationMechanism

        HttpAuthorizationMechanismCfg getHttpAuthorizationMechanism​(String name)
                                                             throws ConfigException
        Gets the named Http Authorization Mechanism.
        Parameters:
        name - The name of the Http Authorization Mechanism to retrieve.
        Returns:
        Returns the named Http Authorization Mechanism.
        Throws:
        ConfigException - If the Http Authorization Mechanism could not be found or it could not be successfully decoded.
      • removeHttpAuthorizationMechanismAddListener

        void removeHttpAuthorizationMechanismAddListener​(ConfigurationAddListener<HttpAuthorizationMechanismCfg> listener)
        Deregisters an existing Http Authorization Mechanism configuration add listener.
        Parameters:
        listener - The Http Authorization Mechanism configuration add listener.
      • addHttpAuthorizationMechanismDeleteListener

        void addHttpAuthorizationMechanismDeleteListener​(ConfigurationDeleteListener<HttpAuthorizationMechanismCfg> listener)
                                                  throws ConfigException
        Registers to be notified when existing Http Authorization Mechanisms are deleted.
        Parameters:
        listener - The Http Authorization Mechanism configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeHttpAuthorizationMechanismDeleteListener

        void removeHttpAuthorizationMechanismDeleteListener​(ConfigurationDeleteListener<HttpAuthorizationMechanismCfg> listener)
        Deregisters an existing Http Authorization Mechanism configuration delete listener.
        Parameters:
        listener - The Http Authorization Mechanism configuration delete listener.
      • listHttpEndpoints

        String[] listHttpEndpoints()
        Lists the Http Endpoints.
        Returns:
        Returns an array containing the names of the Http Endpoints.
      • getHttpEndpoint

        HttpEndpointCfg getHttpEndpoint​(String name)
                                 throws ConfigException
        Gets the named Http Endpoint.
        Parameters:
        name - The name of the Http Endpoint to retrieve.
        Returns:
        Returns the named Http Endpoint.
        Throws:
        ConfigException - If the Http Endpoint could not be found or it could not be successfully decoded.
      • removeHttpEndpointAddListener

        void removeHttpEndpointAddListener​(ConfigurationAddListener<HttpEndpointCfg> listener)
        Deregisters an existing Http Endpoint configuration add listener.
        Parameters:
        listener - The Http Endpoint configuration add listener.
      • addHttpEndpointDeleteListener

        void addHttpEndpointDeleteListener​(ConfigurationDeleteListener<HttpEndpointCfg> listener)
                                    throws ConfigException
        Registers to be notified when existing Http Endpoints are deleted.
        Parameters:
        listener - The Http Endpoint configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeHttpEndpointDeleteListener

        void removeHttpEndpointDeleteListener​(ConfigurationDeleteListener<HttpEndpointCfg> listener)
        Deregisters an existing Http Endpoint configuration delete listener.
        Parameters:
        listener - The Http Endpoint configuration delete listener.
      • listIdentityMappers

        String[] listIdentityMappers()
        Lists the Identity Mappers.
        Returns:
        Returns an array containing the names of the Identity Mappers.
      • getIdentityMapper

        IdentityMapperCfg getIdentityMapper​(String name)
                                     throws ConfigException
        Gets the named Identity Mapper.
        Parameters:
        name - The name of the Identity Mapper to retrieve.
        Returns:
        Returns the named Identity Mapper.
        Throws:
        ConfigException - If the Identity Mapper could not be found or it could not be successfully decoded.
      • removeIdentityMapperAddListener

        void removeIdentityMapperAddListener​(ConfigurationAddListener<IdentityMapperCfg> listener)
        Deregisters an existing Identity Mapper configuration add listener.
        Parameters:
        listener - The Identity Mapper configuration add listener.
      • addIdentityMapperDeleteListener

        void addIdentityMapperDeleteListener​(ConfigurationDeleteListener<IdentityMapperCfg> listener)
                                      throws ConfigException
        Registers to be notified when existing Identity Mappers are deleted.
        Parameters:
        listener - The Identity Mapper configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeIdentityMapperDeleteListener

        void removeIdentityMapperDeleteListener​(ConfigurationDeleteListener<IdentityMapperCfg> listener)
        Deregisters an existing Identity Mapper configuration delete listener.
        Parameters:
        listener - The Identity Mapper configuration delete listener.
      • listKeyManagerProviders

        String[] listKeyManagerProviders()
        Lists the Key Manager Providers.
        Returns:
        Returns an array containing the names of the Key Manager Providers.
      • getKeyManagerProvider

        KeyManagerProviderCfg getKeyManagerProvider​(String name)
                                             throws ConfigException
        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:
        ConfigException - If the Key Manager Provider could not be found or it could not be successfully decoded.
      • removeKeyManagerProviderAddListener

        void removeKeyManagerProviderAddListener​(ConfigurationAddListener<KeyManagerProviderCfg> listener)
        Deregisters an existing Key Manager Provider configuration add listener.
        Parameters:
        listener - The Key Manager Provider configuration add listener.
      • addKeyManagerProviderDeleteListener

        void addKeyManagerProviderDeleteListener​(ConfigurationDeleteListener<KeyManagerProviderCfg> listener)
                                          throws ConfigException
        Registers to be notified when existing Key Manager Providers are deleted.
        Parameters:
        listener - The Key Manager Provider configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeKeyManagerProviderDeleteListener

        void removeKeyManagerProviderDeleteListener​(ConfigurationDeleteListener<KeyManagerProviderCfg> listener)
        Deregisters an existing Key Manager Provider configuration delete listener.
        Parameters:
        listener - The Key Manager Provider configuration delete listener.
      • listLogPublishers

        String[] listLogPublishers()
        Lists the Log Publishers.
        Returns:
        Returns an array containing the names of the Log Publishers.
      • getLogPublisher

        LogPublisherCfg getLogPublisher​(String name)
                                 throws ConfigException
        Gets the named Log Publisher.
        Parameters:
        name - The name of the Log Publisher to retrieve.
        Returns:
        Returns the named Log Publisher.
        Throws:
        ConfigException - If the Log Publisher could not be found or it could not be successfully decoded.
      • removeLogPublisherAddListener

        void removeLogPublisherAddListener​(ConfigurationAddListener<LogPublisherCfg> listener)
        Deregisters an existing Log Publisher configuration add listener.
        Parameters:
        listener - The Log Publisher configuration add listener.
      • addLogPublisherDeleteListener

        void addLogPublisherDeleteListener​(ConfigurationDeleteListener<LogPublisherCfg> listener)
                                    throws ConfigException
        Registers to be notified when existing Log Publishers are deleted.
        Parameters:
        listener - The Log Publisher configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeLogPublisherDeleteListener

        void removeLogPublisherDeleteListener​(ConfigurationDeleteListener<LogPublisherCfg> listener)
        Deregisters an existing Log Publisher configuration delete listener.
        Parameters:
        listener - The Log Publisher configuration delete listener.
      • listLogRetentionPolicies

        String[] listLogRetentionPolicies()
        Lists the Log Retention Policies.
        Returns:
        Returns an array containing the names of the Log Retention Policies.
      • getLogRetentionPolicy

        LogRetentionPolicyCfg getLogRetentionPolicy​(String name)
                                             throws ConfigException
        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:
        ConfigException - If the Log Retention Policy could not be found or it could not be successfully decoded.
      • removeLogRetentionPolicyAddListener

        void removeLogRetentionPolicyAddListener​(ConfigurationAddListener<LogRetentionPolicyCfg> listener)
        Deregisters an existing Log Retention Policy configuration add listener.
        Parameters:
        listener - The Log Retention Policy configuration add listener.
      • addLogRetentionPolicyDeleteListener

        void addLogRetentionPolicyDeleteListener​(ConfigurationDeleteListener<LogRetentionPolicyCfg> listener)
                                          throws ConfigException
        Registers to be notified when existing Log Retention Policies are deleted.
        Parameters:
        listener - The Log Retention Policy configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeLogRetentionPolicyDeleteListener

        void removeLogRetentionPolicyDeleteListener​(ConfigurationDeleteListener<LogRetentionPolicyCfg> listener)
        Deregisters an existing Log Retention Policy configuration delete listener.
        Parameters:
        listener - The Log Retention Policy configuration delete listener.
      • listLogRotationPolicies

        String[] listLogRotationPolicies()
        Lists the Log Rotation Policies.
        Returns:
        Returns an array containing the names of the Log Rotation Policies.
      • getLogRotationPolicy

        LogRotationPolicyCfg getLogRotationPolicy​(String name)
                                           throws ConfigException
        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:
        ConfigException - If the Log Rotation Policy could not be found or it could not be successfully decoded.
      • removeLogRotationPolicyAddListener

        void removeLogRotationPolicyAddListener​(ConfigurationAddListener<LogRotationPolicyCfg> listener)
        Deregisters an existing Log Rotation Policy configuration add listener.
        Parameters:
        listener - The Log Rotation Policy configuration add listener.
      • addLogRotationPolicyDeleteListener

        void addLogRotationPolicyDeleteListener​(ConfigurationDeleteListener<LogRotationPolicyCfg> listener)
                                         throws ConfigException
        Registers to be notified when existing Log Rotation Policies are deleted.
        Parameters:
        listener - The Log Rotation Policy configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeLogRotationPolicyDeleteListener

        void removeLogRotationPolicyDeleteListener​(ConfigurationDeleteListener<LogRotationPolicyCfg> listener)
        Deregisters an existing Log Rotation Policy configuration delete listener.
        Parameters:
        listener - The Log Rotation Policy configuration delete listener.
      • listMailServers

        String[] listMailServers()
        Lists the Mail Servers.
        Returns:
        Returns an array containing the names of the Mail Servers.
      • getMailServer

        MailServerCfg getMailServer​(String name)
                             throws ConfigException
        Gets the named Mail Server.
        Parameters:
        name - The name of the Mail Server to retrieve.
        Returns:
        Returns the named Mail Server.
        Throws:
        ConfigException - If the Mail Server could not be found or it could not be successfully decoded.
      • removeMailServerAddListener

        void removeMailServerAddListener​(ConfigurationAddListener<MailServerCfg> listener)
        Deregisters an existing Mail Server configuration add listener.
        Parameters:
        listener - The Mail Server configuration add listener.
      • addMailServerDeleteListener

        void addMailServerDeleteListener​(ConfigurationDeleteListener<MailServerCfg> listener)
                                  throws ConfigException
        Registers to be notified when existing Mail Servers are deleted.
        Parameters:
        listener - The Mail Server configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeMailServerDeleteListener

        void removeMailServerDeleteListener​(ConfigurationDeleteListener<MailServerCfg> listener)
        Deregisters an existing Mail Server configuration delete listener.
        Parameters:
        listener - The Mail Server configuration delete listener.
      • listPasswordGenerators

        String[] listPasswordGenerators()
        Lists the Password Generators.
        Returns:
        Returns an array containing the names of the Password Generators.
      • getPasswordGenerator

        PasswordGeneratorCfg getPasswordGenerator​(String name)
                                           throws ConfigException
        Gets the named Password Generator.
        Parameters:
        name - The name of the Password Generator to retrieve.
        Returns:
        Returns the named Password Generator.
        Throws:
        ConfigException - If the Password Generator could not be found or it could not be successfully decoded.
      • removePasswordGeneratorAddListener

        void removePasswordGeneratorAddListener​(ConfigurationAddListener<PasswordGeneratorCfg> listener)
        Deregisters an existing Password Generator configuration add listener.
        Parameters:
        listener - The Password Generator configuration add listener.
      • addPasswordGeneratorDeleteListener

        void addPasswordGeneratorDeleteListener​(ConfigurationDeleteListener<PasswordGeneratorCfg> listener)
                                         throws ConfigException
        Registers to be notified when existing Password Generators are deleted.
        Parameters:
        listener - The Password Generator configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removePasswordGeneratorDeleteListener

        void removePasswordGeneratorDeleteListener​(ConfigurationDeleteListener<PasswordGeneratorCfg> listener)
        Deregisters an existing Password Generator configuration delete listener.
        Parameters:
        listener - The Password Generator configuration delete listener.
      • listPasswordPolicies

        String[] listPasswordPolicies()
        Lists the Password Policies.
        Returns:
        Returns an array containing the names of the Password Policies.
      • getPasswordPolicy

        AuthenticationPolicyCfg getPasswordPolicy​(String name)
                                           throws ConfigException
        Gets the named Password Policy.
        Parameters:
        name - The name of the Password Policy to retrieve.
        Returns:
        Returns the named Password Policy.
        Throws:
        ConfigException - If the Password Policy could not be found or it could not be successfully decoded.
      • removePasswordPolicyAddListener

        void removePasswordPolicyAddListener​(ConfigurationAddListener<AuthenticationPolicyCfg> listener)
        Deregisters an existing Password Policy configuration add listener.
        Parameters:
        listener - The Password Policy configuration add listener.
      • removePasswordPolicyDeleteListener

        void removePasswordPolicyDeleteListener​(ConfigurationDeleteListener<AuthenticationPolicyCfg> listener)
        Deregisters an existing Password Policy configuration delete listener.
        Parameters:
        listener - The Password Policy configuration delete listener.
      • listPasswordStorageSchemes

        String[] listPasswordStorageSchemes()
        Lists the Password Storage Schemes.
        Returns:
        Returns an array containing the names of the Password Storage Schemes.
      • getPasswordStorageScheme

        PasswordStorageSchemeCfg getPasswordStorageScheme​(String name)
                                                   throws ConfigException
        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:
        ConfigException - If the Password Storage Scheme could not be found or it could not be successfully decoded.
      • removePasswordStorageSchemeAddListener

        void removePasswordStorageSchemeAddListener​(ConfigurationAddListener<PasswordStorageSchemeCfg> listener)
        Deregisters an existing Password Storage Scheme configuration add listener.
        Parameters:
        listener - The Password Storage Scheme configuration add listener.
      • addPasswordStorageSchemeDeleteListener

        void addPasswordStorageSchemeDeleteListener​(ConfigurationDeleteListener<PasswordStorageSchemeCfg> listener)
                                             throws ConfigException
        Registers to be notified when existing Password Storage Schemes are deleted.
        Parameters:
        listener - The Password Storage Scheme configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removePasswordStorageSchemeDeleteListener

        void removePasswordStorageSchemeDeleteListener​(ConfigurationDeleteListener<PasswordStorageSchemeCfg> listener)
        Deregisters an existing Password Storage Scheme configuration delete listener.
        Parameters:
        listener - The Password Storage Scheme configuration delete listener.
      • listPasswordValidators

        String[] listPasswordValidators()
        Lists the Password Validators.
        Returns:
        Returns an array containing the names of the Password Validators.
      • getPasswordValidator

        PasswordValidatorCfg getPasswordValidator​(String name)
                                           throws ConfigException
        Gets the named Password Validator.
        Parameters:
        name - The name of the Password Validator to retrieve.
        Returns:
        Returns the named Password Validator.
        Throws:
        ConfigException - If the Password Validator could not be found or it could not be successfully decoded.
      • removePasswordValidatorAddListener

        void removePasswordValidatorAddListener​(ConfigurationAddListener<PasswordValidatorCfg> listener)
        Deregisters an existing Password Validator configuration add listener.
        Parameters:
        listener - The Password Validator configuration add listener.
      • addPasswordValidatorDeleteListener

        void addPasswordValidatorDeleteListener​(ConfigurationDeleteListener<PasswordValidatorCfg> listener)
                                         throws ConfigException
        Registers to be notified when existing Password Validators are deleted.
        Parameters:
        listener - The Password Validator configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removePasswordValidatorDeleteListener

        void removePasswordValidatorDeleteListener​(ConfigurationDeleteListener<PasswordValidatorCfg> listener)
        Deregisters an existing Password Validator configuration delete listener.
        Parameters:
        listener - The Password Validator configuration delete listener.
      • getPluginRoot

        PluginRootCfg getPluginRoot()
                             throws ConfigException
        Gets the Plugin Root.
        Returns:
        Returns the Plugin Root.
        Throws:
        ConfigException - If the Plugin Root could not be found or it could not be successfully decoded.
      • getRootDseBackend

        RootDseBackendCfg getRootDseBackend()
                                     throws ConfigException
        Gets the Root Dse Backend.
        Returns:
        Returns the Root Dse Backend.
        Throws:
        ConfigException - If the Root Dse Backend could not be found or it could not be successfully decoded.
      • listSaslMechanismHandlers

        String[] listSaslMechanismHandlers()
        Lists the Sasl Mechanism Handlers.
        Returns:
        Returns an array containing the names of the Sasl Mechanism Handlers.
      • getSaslMechanismHandler

        SaslMechanismHandlerCfg getSaslMechanismHandler​(String name)
                                                 throws ConfigException
        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:
        ConfigException - If the Sasl Mechanism Handler could not be found or it could not be successfully decoded.
      • removeSaslMechanismHandlerAddListener

        void removeSaslMechanismHandlerAddListener​(ConfigurationAddListener<SaslMechanismHandlerCfg> listener)
        Deregisters an existing Sasl Mechanism Handler configuration add listener.
        Parameters:
        listener - The Sasl Mechanism Handler configuration add listener.
      • addSaslMechanismHandlerDeleteListener

        void addSaslMechanismHandlerDeleteListener​(ConfigurationDeleteListener<SaslMechanismHandlerCfg> listener)
                                            throws ConfigException
        Registers to be notified when existing Sasl Mechanism Handlers are deleted.
        Parameters:
        listener - The Sasl Mechanism Handler configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeSaslMechanismHandlerDeleteListener

        void removeSaslMechanismHandlerDeleteListener​(ConfigurationDeleteListener<SaslMechanismHandlerCfg> listener)
        Deregisters an existing Sasl Mechanism Handler configuration delete listener.
        Parameters:
        listener - The Sasl Mechanism Handler configuration delete listener.
      • listSchemaProviders

        String[] listSchemaProviders()
        Lists the Schema Providers.
        Returns:
        Returns an array containing the names of the Schema Providers.
      • getSchemaProvider

        SchemaProviderCfg getSchemaProvider​(String name)
                                     throws ConfigException
        Gets the named Schema Provider.
        Parameters:
        name - The name of the Schema Provider to retrieve.
        Returns:
        Returns the named Schema Provider.
        Throws:
        ConfigException - If the Schema Provider could not be found or it could not be successfully decoded.
      • removeSchemaProviderAddListener

        void removeSchemaProviderAddListener​(ConfigurationAddListener<SchemaProviderCfg> listener)
        Deregisters an existing Schema Provider configuration add listener.
        Parameters:
        listener - The Schema Provider configuration add listener.
      • addSchemaProviderDeleteListener

        void addSchemaProviderDeleteListener​(ConfigurationDeleteListener<SchemaProviderCfg> listener)
                                      throws ConfigException
        Registers to be notified when existing Schema Providers are deleted.
        Parameters:
        listener - The Schema Provider configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeSchemaProviderDeleteListener

        void removeSchemaProviderDeleteListener​(ConfigurationDeleteListener<SchemaProviderCfg> listener)
        Deregisters an existing Schema Provider configuration delete listener.
        Parameters:
        listener - The Schema Provider configuration delete listener.
      • listServiceDiscoveryMechanisms

        String[] listServiceDiscoveryMechanisms()
        Lists the Service Discovery Mechanisms.
        Returns:
        Returns an array containing the names of the Service Discovery Mechanisms.
      • getServiceDiscoveryMechanism

        ServiceDiscoveryMechanismCfg getServiceDiscoveryMechanism​(String name)
                                                           throws ConfigException
        Gets the named Service Discovery Mechanism.
        Parameters:
        name - The name of the Service Discovery Mechanism to retrieve.
        Returns:
        Returns the named Service Discovery Mechanism.
        Throws:
        ConfigException - If the Service Discovery Mechanism could not be found or it could not be successfully decoded.
      • removeServiceDiscoveryMechanismAddListener

        void removeServiceDiscoveryMechanismAddListener​(ConfigurationAddListener<ServiceDiscoveryMechanismCfg> listener)
        Deregisters an existing Service Discovery Mechanism configuration add listener.
        Parameters:
        listener - The Service Discovery Mechanism configuration add listener.
      • addServiceDiscoveryMechanismDeleteListener

        void addServiceDiscoveryMechanismDeleteListener​(ConfigurationDeleteListener<ServiceDiscoveryMechanismCfg> listener)
                                                 throws ConfigException
        Registers to be notified when existing Service Discovery Mechanisms are deleted.
        Parameters:
        listener - The Service Discovery Mechanism configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeServiceDiscoveryMechanismDeleteListener

        void removeServiceDiscoveryMechanismDeleteListener​(ConfigurationDeleteListener<ServiceDiscoveryMechanismCfg> listener)
        Deregisters an existing Service Discovery Mechanism configuration delete listener.
        Parameters:
        listener - The Service Discovery Mechanism configuration delete listener.
      • listSynchronizationProviders

        String[] listSynchronizationProviders()
        Lists the Synchronization Providers.
        Returns:
        Returns an array containing the names of the Synchronization Providers.
      • getSynchronizationProvider

        SynchronizationProviderCfg getSynchronizationProvider​(String name)
                                                       throws ConfigException
        Gets the named Synchronization Provider.
        Parameters:
        name - The name of the Synchronization Provider to retrieve.
        Returns:
        Returns the named Synchronization Provider.
        Throws:
        ConfigException - If the Synchronization Provider could not be found or it could not be successfully decoded.
      • removeSynchronizationProviderAddListener

        void removeSynchronizationProviderAddListener​(ConfigurationAddListener<SynchronizationProviderCfg> listener)
        Deregisters an existing Synchronization Provider configuration add listener.
        Parameters:
        listener - The Synchronization Provider configuration add listener.
      • addSynchronizationProviderDeleteListener

        void addSynchronizationProviderDeleteListener​(ConfigurationDeleteListener<SynchronizationProviderCfg> listener)
                                               throws ConfigException
        Registers to be notified when existing Synchronization Providers are deleted.
        Parameters:
        listener - The Synchronization Provider configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeSynchronizationProviderDeleteListener

        void removeSynchronizationProviderDeleteListener​(ConfigurationDeleteListener<SynchronizationProviderCfg> listener)
        Deregisters an existing Synchronization Provider configuration delete listener.
        Parameters:
        listener - The Synchronization Provider configuration delete listener.
      • listTrustManagerProviders

        String[] listTrustManagerProviders()
        Lists the Trust Manager Providers.
        Returns:
        Returns an array containing the names of the Trust Manager Providers.
      • getTrustManagerProvider

        TrustManagerProviderCfg getTrustManagerProvider​(String name)
                                                 throws ConfigException
        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:
        ConfigException - If the Trust Manager Provider could not be found or it could not be successfully decoded.
      • removeTrustManagerProviderAddListener

        void removeTrustManagerProviderAddListener​(ConfigurationAddListener<TrustManagerProviderCfg> listener)
        Deregisters an existing Trust Manager Provider configuration add listener.
        Parameters:
        listener - The Trust Manager Provider configuration add listener.
      • addTrustManagerProviderDeleteListener

        void addTrustManagerProviderDeleteListener​(ConfigurationDeleteListener<TrustManagerProviderCfg> listener)
                                            throws ConfigException
        Registers to be notified when existing Trust Manager Providers are deleted.
        Parameters:
        listener - The Trust Manager Provider configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeTrustManagerProviderDeleteListener

        void removeTrustManagerProviderDeleteListener​(ConfigurationDeleteListener<TrustManagerProviderCfg> listener)
        Deregisters an existing Trust Manager Provider configuration delete listener.
        Parameters:
        listener - The Trust Manager Provider configuration delete listener.
      • listVirtualAttributes

        String[] listVirtualAttributes()
        Lists the Virtual Attributes.
        Returns:
        Returns an array containing the names of the Virtual Attributes.
      • getVirtualAttribute

        VirtualAttributeCfg getVirtualAttribute​(String name)
                                         throws ConfigException
        Gets the named Virtual Attribute.
        Parameters:
        name - The name of the Virtual Attribute to retrieve.
        Returns:
        Returns the named Virtual Attribute.
        Throws:
        ConfigException - If the Virtual Attribute could not be found or it could not be successfully decoded.
      • removeVirtualAttributeAddListener

        void removeVirtualAttributeAddListener​(ConfigurationAddListener<VirtualAttributeCfg> listener)
        Deregisters an existing Virtual Attribute configuration add listener.
        Parameters:
        listener - The Virtual Attribute configuration add listener.
      • addVirtualAttributeDeleteListener

        void addVirtualAttributeDeleteListener​(ConfigurationDeleteListener<VirtualAttributeCfg> listener)
                                        throws ConfigException
        Registers to be notified when existing Virtual Attributes are deleted.
        Parameters:
        listener - The Virtual Attribute configuration delete listener.
        Throws:
        ConfigException - If the delete listener could not be registered.
      • removeVirtualAttributeDeleteListener

        void removeVirtualAttributeDeleteListener​(ConfigurationDeleteListener<VirtualAttributeCfg> listener)
        Deregisters an existing Virtual Attribute configuration delete listener.
        Parameters:
        listener - The Virtual Attribute configuration delete listener.
      • getWorkQueue

        WorkQueueCfg getWorkQueue()
                           throws ConfigException
        Gets the Work Queue.
        Returns:
        Returns the Work Queue.
        Throws:
        ConfigException - If the Work Queue could not be found or it could not be successfully decoded.