Package org.opends.server.core

Class DirectoryServer.InitializationBuilder

java.lang.Object
org.opends.server.core.DirectoryServer.InitializationBuilder
Enclosing class:
DirectoryServer
public static final class DirectoryServer.InitializationBuilder extends Object
Initialize the client DirectoryServer singleton by using a fluent interface.

  • Constructor Details

    • InitializationBuilder

      public InitializationBuilder(String configFile)
      Initialize the client side of DirectoryServer and the Core Configuration.
      Parameters:
      configFile - the configuration file

    • InitializationBuilder

      public InitializationBuilder(Path configFile)
      Initialize the client side of DirectoryServer and the Core Configuration.
      Parameters:
      configFile - the configuration file

  • Method Details

    • requireCryptoServices

      public DirectoryServer.InitializationBuilder requireCryptoServices()
      Require to setup and start everything necessary for Crypto Services. Core config should already be initialized through the constructor.
      Returns:
      this initialization builder

    • requireStatelessCryptoServices

      public DirectoryServer.InitializationBuilder requireStatelessCryptoServices()
      Require to setup stateless Crypto Services. Stateless Crypto Services are able to read local keys but cannot access admin data.
      Returns:
      this initialization builder.

    • requireLowMemoryPasswordStorageSchemes

      public DirectoryServer.InitializationBuilder requireLowMemoryPasswordStorageSchemes()
      Requires to setup and start Password Storage Schemes. Crypto services are needed for Password Storage, so it will also set them up if not already done.
      Returns:
      this initialization builder

    • requireUserPlugins

      public DirectoryServer.InitializationBuilder requireUserPlugins(PluginType... plugins)
      Requires to start specified user plugins.
      Parameters:
      plugins - the plugins to start
      Returns:
      this initialization builder

    • requireErrorAndDebugLogPublisher

      public DirectoryServer.InitializationBuilder requireErrorAndDebugLogPublisher(PrintStream loggingOut, PrintStream errConfiguringLogging)
      Requires to start the error and debug log publishers for tools.
      Parameters:
      loggingOut - The output stream where to write error and debug logging.
      errConfiguringLogging - The output stream where to write errors occurring when configuring logging.
      Returns:
      this initialization builder

    • requireStubsForTools

      public DirectoryServer.InitializationBuilder requireStubsForTools()
      Require to setup and start some stubs to bypass some behaviors reserved to the server.
      Returns:
      this initialization builder

    • initialize

      public ServerContext initialize() throws InitializationException
      Run all Initialization blocks as configured.
      Returns:
      the initialized server context
      Throws:
      InitializationException - if one of the initialization steps fails