Module org.neo4j.bolt.connection
Package org.neo4j.bolt.connection

Interface BoltConnectionProviderFactory

public interface BoltConnectionProviderFactory
A factory for creating instances of BoltConnectionProvider.

Implementations MUST be loadable by the ServiceLoader.

Since:
4.0.0

  • Method Details

    • supports

      boolean supports(String scheme)
      Indicates if BoltConnectionProvider instances created by this factory support the given URI scheme.
      Parameters:
      scheme - the URI scheme
      Returns:
      true if support is available, false if not

    • create

      BoltConnectionProvider create(LoggingProvider loggingProvider, ValueFactory valueFactory, MetricsListener metricsListener, Map<String,?> additionalConfig)
      Creates a new BoltConnectionProvider instance.
      Parameters:
      loggingProvider - the LoggingProvider that should be used for logging
      valueFactory - the ValueFactory that should be used for value management
      metricsListener - the MetricsListener that should be used for metrics
      additionalConfig - the additional config with arbitrary values that may be used by factories that recognise them
      Returns:
      the new BoltConnectionProvider instance

    • getOrder

      default int getOrder()
      Returns the order of this factory.

      This may be used for sorting factories that support the same scheme in order to select the one with highest precedence.

      The higher the value is, the lower the precedence is. For example, the Integer.MIN_VALUE has highest precedence.

      The default is Integer.MAX_VALUE.

      Returns:
      the order