Module is.codion.framework.db.core
Package is.codion.framework.db

Interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Type Parameters:
T - the connection provider type
B - the builder type
All Known Subinterfaces:
HttpEntityConnectionProvider.Builder, LocalEntityConnectionProvider.Builder, RemoteEntityConnectionProvider.Builder
All Known Implementing Classes:
AbstractEntityConnectionProvider.AbstractBuilder, DefaultHttpEntityConnectionProviderBuilder, DefaultLocalEntityConnectionProviderBuilder, DefaultRemoteEntityConnectionProviderBuilder
Enclosing interface:
EntityConnectionProvider
public static interface EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>
Builds a EntityConnectionProvider instances

  • Method Details

    • connectionType

      String connectionType()
      Returns a String specifying the type of connection provided by this connection provider builder
      Returns:
      a String specifying the type of connection, e.g. "local" or "remote"

    • user

      B user(User user)
      Parameters:
      user - the user
      Returns:
      this builder instance

    • domainType

      B domainType(DomainType domainType)
      Parameters:
      domainType - the domain type to base this connection on
      Returns:
      this builder instance

    • clientId

      B clientId(UUID clientId)
      Parameters:
      clientId - the UUID identifying this client connection
      Returns:
      this builder instance

    • clientTypeId

      B clientTypeId(String clientTypeId)
      Parameters:
      clientTypeId - a String identifying the client type for this connection provider
      Returns:
      this builder instance

    • clientVersion

      B clientVersion(Version clientVersion)
      Parameters:
      clientVersion - the client version
      Returns:
      this builder instance

    • onClose

      B onClose(Consumer<EntityConnectionProvider> onClose)
      Parameters:
      onClose - called when this connection provider has been closed
      Returns:
      this builder instance
      See Also:

    • build

      T build()
      Builds a EntityConnectionProvider instance based on this builder
      Returns:
      a new EntityConnectionProvider instance