Module is.codion.framework.db.core

Package is.codion.framework.db

Class AbstractEntityConnectionProvider

java.lang.Object

is.codion.framework.db.AbstractEntityConnectionProvider

All Implemented Interfaces:

EntityConnectionProvider, AutoCloseable

public abstract class AbstractEntityConnectionProvider
extends Object
implements EntityConnectionProvider

An abstract EntityConnectionProvider implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractEntityConnectionProvider.AbstractBuilder<T extends EntityConnectionProvider,B extends EntityConnectionProvider.Builder<T,B>>

Nested classes/interfaces inherited from interface is.codion.framework.db.EntityConnectionProvider

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

Field Summary

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

CLIENT_CONNECTION_TYPE, CLIENT_DOMAIN_TYPE, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityConnectionProvider(AbstractEntityConnectionProvider.AbstractBuilder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
final void	addOnConnectListener(Consumer<EntityConnection> listener)	Adds a listener notified each time this connection provider establishes a connection to the database
final UUID	clientId()
final String	clientTypeId()
final is.codion.common.version.Version	clientVersion()
final void	close()	Closes the underlying connection and performs cleanup if required
protected abstract void	close(EntityConnection connection)	Closes the given connection
protected abstract EntityConnection	connect()
final 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
final boolean	connectionValid()
final is.codion.framework.domain.DomainType	domainType()
final is.codion.framework.domain.entity.Entities	entities()	Returns the domain entities this connection is based on
final void	removeOnConnectListener(Consumer<EntityConnection> listener)	Removes the given listener
final is.codion.common.user.User	user()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

connectionType, description

Constructor Details

AbstractEntityConnectionProvider

protected AbstractEntityConnectionProvider(AbstractEntityConnectionProvider.AbstractBuilder<?,?> builder)

Method Details

entities

public final is.codion.framework.domain.entity.Entities entities()

Description copied from interface: EntityConnectionProvider

Returns the domain entities this connection is based on

Specified by:

entities in interface EntityConnectionProvider

Returns:

the underlying domain entities

user

public final is.codion.common.user.User user()

Specified by:

user in interface EntityConnectionProvider

Returns:

the user used by this connection provider

domainType

public final is.codion.framework.domain.DomainType domainType()

Specified by:

domainType in interface EntityConnectionProvider

Returns:

the domain type

clientId

public final UUID clientId()

Specified by:

clientId in interface EntityConnectionProvider

Returns:

the UUID identifying this client connection

clientTypeId

public final String clientTypeId()

Specified by:

clientTypeId in interface EntityConnectionProvider

Returns:

the String identifying the client type for this connection provider

clientVersion

public final is.codion.common.version.Version clientVersion()

Specified by:

clientVersion in interface EntityConnectionProvider

Returns:

the client version

connectionValid

public final boolean connectionValid()

Specified by:

connectionValid in interface EntityConnectionProvider

Returns:

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

addOnConnectListener

public final void addOnConnectListener(Consumer<EntityConnection> listener)

Description copied from interface: EntityConnectionProvider

Adds a listener notified each time this connection provider establishes a connection to the database

Specified by:

addOnConnectListener in interface EntityConnectionProvider

Parameters:

listener - a listener notified when a connection is established

removeOnConnectListener

public final void removeOnConnectListener(Consumer<EntityConnection> listener)

Description copied from interface: EntityConnectionProvider

Removes the given listener

Specified by:

removeOnConnectListener in interface EntityConnectionProvider

Parameters:

listener - the listener to remove

connection

public final EntityConnection connection()

Description copied from interface: EntityConnectionProvider

Provides a 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:

a EntityConnection instance

close

public final void close()

Description copied from interface: EntityConnectionProvider

Closes the underlying connection and performs cleanup if required

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EntityConnectionProvider

See Also:

• EntityConnectionProvider.Builder.onClose(Consumer)

connect

protected abstract EntityConnection connect()

Returns:

an established connection

close

protected abstract void close(EntityConnection connection)

Closes the given connection

Parameters:

connection - the connection to be closed