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

Specifies a class responsible for providing a single EntityConnection instance. connection() is guaranteed to return a healthy connection or throw an exception. A factory for EntityConnectionProviders based on system properties.

See Also:

• 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 a 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 PropertyValue<DomainType>	CLIENT_DOMAIN_TYPE	Specifies the domain type required for a client connection Value type: is.codion.framework.domain.DomainType Default value: null
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

Method Summary

Modifier and Type	Method	Description
static EntityConnectionProvider.Builder<?,?>	builder()
UUID	clientId()
String	clientType()
Version	clientVersion()
void	close()	Closes the underlying connection and performs cleanup if required
Observer<EntityConnection>	connected()
<T extends EntityConnection> T	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
String	connectionType()	Returns a String specifying the type of connection provided by this connection provider
boolean	connectionValid()
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_DOMAIN_TYPE

static final PropertyValue<DomainType> CLIENT_DOMAIN_TYPE

Specifies the domain type required for a client connection

• Value type: is.codion.framework.domain.DomainType
• Default value: null

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

Method Details

entities

Entities entities()

Returns the domain entities this connection is based on

Returns:

the underlying domain entities

connection

<T extends EntityConnection> T 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

Type Parameters:

T - the expected EntityConnection type

Returns:

a EntityConnection instance

connectionType

String connectionType()

Returns a String specifying the type of connection provided by this connection provider

Returns:

a String specifying the type of connection, e.g. "local" or "remote"

description

String description()

Returns:

a short description of the database provider

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

domainType

DomainType domainType()

Returns:

the domain type

clientId

UUID clientId()

Returns:

the UUID identifying this client connection

clientType

String clientType()

Returns:

the String identifying the client type for this connection provider

clientVersion

Version clientVersion()

Returns:

the client version

builder

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

Returns:

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

Throws:

IllegalStateException - in case the required connection provider builder is not available on the classpath

See Also:

• CLIENT_CONNECTION_TYPE