Module is.codion.framework.db.local

Package is.codion.framework.db.local

Interface LocalEntityConnectionProvider

All Superinterfaces:

AutoCloseable, EntityConnectionProvider, EntityConnectionTracer

public interface LocalEntityConnectionProvider
extends EntityConnectionProvider, EntityConnectionTracer

An interface responsible for managing a local EntityConnection.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LocalEntityConnectionProvider.Builder	Builds a LocalEntityConnectionProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	TRACING	Specifies whether method tracing is enabled by default.

Fields inherited from interface is.codion.framework.db.EntityConnectionProvider

CLIENT_CONNECTION_TYPE, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE, DESCRIPTION

Method Summary

Modifier and Type	Method	Description
static LocalEntityConnectionProvider.Builder	builder()	Instantiates a new builder instance.
LocalEntityConnection	connection()	Provides an EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally
Database	database()
Domain	domain()

Methods inherited from interface is.codion.framework.db.EntityConnectionProvider

clientId, clientType, clientVersion, close, connected, connectionValid, description, domainType, entities, user

Methods inherited from interface is.codion.framework.db.EntityConnectionTracer

trace, tracing

Field Details

TRACING

static final PropertyValue<Boolean> TRACING

Specifies whether method tracing is enabled by default.

• Value type: Boolean
• Default value: false

Method Details

domain

Domain domain()

Returns:

the underlying domain model

See Also:

• LocalEntityConnectionProvider.Builder.domain(Domain)

database

Database database()

Returns:

the underlying Database instance

See Also:

• LocalEntityConnectionProvider.Builder.database(Database)

connection

LocalEntityConnection connection()

Description copied from interface: EntityConnectionProvider

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

Specified by:

connection in interface EntityConnectionProvider

Returns:

an EntityConnection instance

builder

static LocalEntityConnectionProvider.Builder builder()

Instantiates a new builder instance.

Returns:

a new builder