Package eu.cloudnetservice.wrapper.configuration

Interface WrapperConfiguration

All Known Implementing Classes:
DocumentWrapperConfiguration
@Singleton public interface WrapperConfiguration
Represents the configuration which is passed from a node instance to the wrapper in form of a file before starting. It contains the most basic information in order to allow the wrapper to start and connect to the cluster.
Since:
4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    connectionKey()
    Get the key which allows this wrapper to authenticate with the associated node.
    @NonNull eu.cloudnetservice.driver.service.ServiceConfiguration
    serviceConfiguration()
    Get the service configuration which was used to create the service associated with this wrapper instance.
    @NonNull eu.cloudnetservice.driver.service.ServiceInfoSnapshot
    serviceInfoSnapshot()
    Get the initial service info snapshot created by the node before the wrapper was started.
    @NonNull eu.cloudnetservice.driver.network.ssl.SSLConfiguration
    sslConfiguration()
    Get the ssl configuration which should be applied when connecting and communicating with the associated node.
    @NonNull eu.cloudnetservice.driver.network.HostAndPort
    targetListener()
    Get the address of the node listener this wrapper should connect.

  • Method Details

    • connectionKey

      @NonNull @NonNull String connectionKey()
      Get the key which allows this wrapper to authenticate with the associated node.
      Returns:
      the key which allows this wrapper to authenticate with the associated node.

    • targetListener

      @NonNull @NonNull eu.cloudnetservice.driver.network.HostAndPort targetListener()
      Get the address of the node listener this wrapper should connect.
      Returns:
      the address of the node listener this wrapper should connect.

    • serviceConfiguration

      @NonNull @NonNull eu.cloudnetservice.driver.service.ServiceConfiguration serviceConfiguration()
      Get the service configuration which was used to create the service associated with this wrapper instance.
      Returns:
      the base service configuration of the associated service.

    • serviceInfoSnapshot

      @NonNull @NonNull eu.cloudnetservice.driver.service.ServiceInfoSnapshot serviceInfoSnapshot()
      Get the initial service info snapshot created by the node before the wrapper was started.
      Returns:
      the initial service info snapshot created by the node before the wrapper was started.

    • sslConfiguration

      @NonNull @NonNull eu.cloudnetservice.driver.network.ssl.SSLConfiguration sslConfiguration()
      Get the ssl configuration which should be applied when connecting and communicating with the associated node.
      Returns:
      the ssl configuration to apply to all client connection of this wrapper.