Module is.codion.framework.db.core

Package is.codion.framework.db

Interface EntityConnectionProvider

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

HttpEntityConnectionProvider, LocalEntityConnectionProvider, RemoteEntityConnectionProvider

All Known Implementing Classes:

AbstractEntityConnectionProvider

public interface EntityConnectionProvider
extends AutoCloseable

Provides a managed EntityConnection instance with automatic reconnection handling.

EntityConnectionProvider serves as the primary entry point for database access in Codion applications. It manages connection lifecycle, handles reconnection for both local and remote connections, and provides a consistent interface regardless of the underlying connection type.

Connection Types

• CONNECTION_TYPE_LOCAL - Direct JDBC connection
• CONNECTION_TYPE_REMOTE - RMI-based remote connection
• CONNECTION_TYPE_HTTP - HTTP-based remote connection

Basic Usage

 // Local connection
 EntityConnectionProvider provider = LocalEntityConnectionProvider.builder()
     .domainType(DOMAIN)
     .user(User.parse("scott:tiger"))
     .build();

 // Remote connection
 EntityConnectionProvider provider = RemoteEntityConnectionProvider.builder()
     .domainType(DOMAIN)
     .hostname("localhost")
     .port(2223)
     .registryPort(1099)
     .user(User.parse("scott:tiger"))
     .build();

 // Use the connection
 try (EntityConnectionProvider connProvider = provider) {
     EntityConnection connection = connProvider.connection();
     List<Entity> customers = connection.select(all(Customer.TYPE));
 }

Configuration-based Creation

 // Configure via system properties
 System.setProperty("codion.client.connectionType", "remote");

 // Create provider based on configuration
 EntityConnectionProvider provider = EntityConnectionProvider.builder()
     .user(User.parse("scott:tiger"))
     .build();

See Also:

• EntityConnection
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityConnectionProvider.Builder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>	Builds EntityConnectionProvider instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	CLIENT_CONNECTION_TYPE	Specifies whether the client should connect locally, via rmi or http, accepted values: local, remote, http Value type: String Default value: CONNECTION_TYPE_LOCAL
static final String	CONNECTION_TYPE_HTTP	Indicates a http database connection
static final String	CONNECTION_TYPE_LOCAL	Indicates a local database connection
static final String	CONNECTION_TYPE_REMOTE	Indicates a remote database connection
static final PropertyValue<String>	DESCRIPTION	Specifies a connection provider description, overriding the default one which usually provides a hostname or other connection based information.

Method Summary

Modifier and Type	Method	Description
static EntityConnectionProvider.Builder<?,?>	builder()	Creates a connection provider builder based on system configuration.
UUID	clientId()
String	clientType()
Optional<Version>	clientVersion()
void	close()	Closes the underlying connection and performs cleanup if required
Observer<EntityConnection>	connected()
EntityConnection	connection()	Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally
boolean	connectionValid()
Optional<String>	description()
DomainType	domainType()
Entities	entities()	Returns the domain entities this connection is based on
User	user()

Field Details

CONNECTION_TYPE_LOCAL

static final String CONNECTION_TYPE_LOCAL

Indicates a local database connection

See Also:

• CLIENT_CONNECTION_TYPE
• Constant Field Values

CONNECTION_TYPE_REMOTE

static final String CONNECTION_TYPE_REMOTE

Indicates a remote database connection

See Also:

• CLIENT_CONNECTION_TYPE
• Constant Field Values

CONNECTION_TYPE_HTTP

static final String CONNECTION_TYPE_HTTP

Indicates a http database connection

See Also:

• CLIENT_CONNECTION_TYPE
• Constant Field Values

CLIENT_CONNECTION_TYPE

static final PropertyValue<String> CLIENT_CONNECTION_TYPE

Specifies whether the client should connect locally, via rmi or http, accepted values: local, remote, http

• Value type: String
• Default value: CONNECTION_TYPE_LOCAL

See Also:

• CONNECTION_TYPE_LOCAL
• CONNECTION_TYPE_REMOTE
• CONNECTION_TYPE_HTTP

DESCRIPTION

static final PropertyValue<String> DESCRIPTION

Specifies a connection provider description, overriding the default one which usually provides a hostname or other connection based information.

• Value type: String
• Default value: null

See Also:

• description()

Method Details

entities

Entities entities()

Returns the domain entities this connection is based on

Returns:

the underlying domain entities

connection

EntityConnection connection()

Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally

Returns:

a EntityConnection instance

description

Optional<String> description()

Returns:

a description of the database provider or an empty Optional in case no description is provided

See Also:

• DESCRIPTION

connectionValid

boolean connectionValid()

Returns:

true if a connection has been establised and the connection is in a valid state

connected

Observer<EntityConnection> connected()

Returns:

an observer notified when a connection is established

close

void close()

Closes the underlying connection and performs cleanup if required

Specified by:

close in interface AutoCloseable

See Also:

• EntityConnectionProvider.Builder.onClose(Consumer)

user

User user()

Returns:

the user used by this connection provider

See Also:

• EntityConnectionProvider.Builder.user(User)

domainType

DomainType domainType()

Returns:

the domain type

See Also:

• EntityConnectionProvider.Builder.domain(DomainType)

clientId

UUID clientId()

Returns:

the UUID identifying this client connection

See Also:

• EntityConnectionProvider.Builder.clientId(UUID)

clientType

String clientType()

Returns:

the String identifying the client type for this connection provider

See Also:

• EntityConnectionProvider.Builder.clientType(String)

clientVersion

Optional<Version> clientVersion()

Returns:

the client version

See Also:

• EntityConnectionProvider.Builder.clientVersion(Version)

builder

static EntityConnectionProvider.Builder<?,?> builder()

Creates a connection provider builder based on system configuration.

 // Configure connection type
 System.setProperty("codion.client.connectionType", "remote");

 // Create builder based on configuration
 EntityConnectionProvider provider = EntityConnectionProvider.builder()
     .domain(DomainModel.DOMAIN)
     .user(User.parse("scott:tiger"))
     .build();

Returns:

an unconfigured EntityConnectionProvider.Builder instance, based on the CLIENT_CONNECTION_TYPE configuration value

Throws:

IllegalStateException - in case no connection provider builder supporting the configured connection type is available on the classpath

See Also:

• CLIENT_CONNECTION_TYPE