Package org.forgerock.opendj.server.core

Interface DataProviderFactory<T extends DataProviderCfg>

  • Type Parameters:
    T - The type of configuration handled by this data provider.
    public interface DataProviderFactory<T extends DataProviderCfg>
    A factory for creating data provider instances.
    See Also:
    DataProvider

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      DataProvider createDataProvider​(DataProviderID id, T configuration)
      Creates and initializes a new data provider based on the information in the provided configuration.
      boolean isConfigurationAcceptable​(T configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
      Indicates whether the provided configuration is acceptable for creating and initializing a new data provider using this data provider factory.

    • Method Detail

      • createDataProvider

        DataProvider createDataProvider​(DataProviderID id,
                                T configuration)
                         throws org.forgerock.opendj.config.server.ConfigException
        Creates and initializes a new data provider based on the information in the provided configuration.

        Implementations must not start any services nor attempt to connect to other data providers. However, they may register with the backup/restore and import/export managers.

        Parameters:
        id - The ID which should be used to uniquely identify this data provider.
        configuration - The configuration that contains the information to use to create and initialize the new data provider.
        Returns:
        The new data provider instance.
        Throws:
        org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises during initialization of the data provider as a result of the server configuration.
        See Also:
        DataProvider.startDataProvider()

      • isConfigurationAcceptable

        boolean isConfigurationAcceptable​(T configuration,
                                  List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
        Indicates whether the provided configuration is acceptable for creating and initializing a new data provider using this data provider factory.

        This method will be called before createDataProvider(DataProviderID, DataProviderCfg) in order validate the configuration.

        Implementations should perform basic validation of the configuration but should not attempt to start any resource or connect to other data providers.

        Parameters:
        configuration - The configuration for which to make the determination.
        unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.
        Returns:
        true if the provided configuration is acceptable for this data provider factory, or false if not.