Module is.codion.framework.db.rmi

Package is.codion.framework.db.rmi

Interface ServerEntityConnection

All Superinterfaces:

AutoCloseable, Remote

public interface ServerEntityConnection
extends Remote, AutoCloseable

The EntityConnection running on the server, as exported to clients over RMI.

This is the wire contract, adapted to EntityConnection on the client side by RemoteEntityConnection. Each method mirrors its EntityConnection counterpart, adding RemoteException; refer to EntityConnection for the behavioral contract.

Note that this interface can not extend EntityConnection, RMI requiring every method on a Remote interface to declare RemoteException.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOTE_CLIENT_DOMAIN_TYPE	A key for specifying the domain type required by a remote client

Method Summary

Modifier and Type	Method	Description
UUID	clientId()
default Optional<Version>	clientVersion()	Returns the version of the client this connection belongs to, as reported to the server.
void	close()	Closes this connection.
void	commitTransaction()	Performs a commit and ends the current transaction.
boolean	connected()
int	count(EntityConnection.Count count)	Counts the number of rows returned based on the given count conditions.
default int	count(Supplier<EntityConnection.Count> count)	Convenience overload accepting a EntityConnection.Count.Builder or any Supplier of EntityConnection.Count, removing the need for a trailing EntityConnection.Count.Builder.build() call.
int	delete(Condition condition)	Deletes the entities specified by the given condition.
void	delete(Entity.Key key)	Deletes the entity with the given primary key.
void	delete(Collection<Entity.Key> keys)	Deletes the entities with the given primary keys.
Map<EntityType,Collection<Entity>>	dependencies(Collection<Entity> entities)	Selects the entities that depend on the given entities via (non-soft) foreign keys, mapped to corresponding entityTypes.
default Optional<String>	description()	Returns a description of this connection, a database or server name for example.
Entities	entities()
<C extends EntityConnection, P, R> @Nullable R	execute(FunctionType<C,P,R> functionType)	Executes the function with the given type with no parameter.
<C extends EntityConnection, P, R> @Nullable R	execute(FunctionType<C,P,R> functionType, @Nullable P parameter)	Executes the function with the given type.
<C extends EntityConnection, P> void	execute(ProcedureType<C,P> procedureType)	Executes the procedure with the given type with no parameter.
<C extends EntityConnection, P> void	execute(ProcedureType<C,P> procedureType, @Nullable P parameter)	Executes the procedure with the given type.
Entity.Key	insert(Entity entity)	Inserts the given entity, returning the primary key.
Collection<Entity.Key>	insert(Collection<Entity> entities)	Inserts the given entities, returning the primary keys.
Entity	insertSelect(Entity entity)	Inserts the given entity, returning the inserted entity.
Collection<Entity>	insertSelect(Collection<Entity> entities)	Inserts the given entities, returning the inserted entities.
ServerEntityResultIterator	iterator(EntityConnection.Select select)	Returns a result set iterator based on the given select.
ServerEntityResultIterator	iterator(Condition condition)	Returns a result set iterator based on the given query condition.
default ServerEntityResultIterator	iterator(Supplier<EntityConnection.Select> select)	Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.
<P, R> R	report(ReportType<P,R> reportType, @Nullable P parameter)	Fills the given report using a JDBC datasource and returns the result.
void	rollbackTransaction()	Performs a rollback and ends the current transaction.
List<Entity>	select(EntityConnection.Select select)	Selects entities based on the given select.
<T> List<T>	select(Column<T> column)	Selects ordered and distinct non-null values of the given column.
<T> List<T>	select(Column<T> column, EntityConnection.Select select)	Selects distinct non-null values of the given column.
<T> List<T>	select(Column<T> column, Condition condition)	Selects distinct non-null values of the given column.
default <T> List<T>	select(Column<T> column, Supplier<EntityConnection.Select> select)	Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.
List<Entity>	select(Condition condition)	Selects entities based on the given condition.
Entity	select(Entity.Key key)	Selects an entity by key.
Collection<Entity>	select(Collection<Entity.Key> keys)	Selects entities based on the given keys.
default List<Entity>	select(Supplier<EntityConnection.Select> select)	Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.
Entity	selectSingle(EntityConnection.Select select)	Selects a single entity based on the specified select.
Entity	selectSingle(Condition condition)	Selects a single entity based on the specified condition.
default Entity	selectSingle(Supplier<EntityConnection.Select> select)	Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.
void	startTransaction()	Starts a transaction on this connection.
boolean	transactionOpen()
int	update(EntityConnection.Update update)	Performs an update based on the given update.
void	update(Entity entity)	Updates the given entity based on its attribute values.
void	update(Collection<Entity> entities)	Updates the given entities based on their attribute values.
default int	update(Supplier<EntityConnection.Update> update)	Convenience overload accepting an EntityConnection.Update.Builder or any Supplier of EntityConnection.Update, removing the need for a trailing EntityConnection.Update.Builder.build() call.
Entity	updateSelect(Entity entity)	Updates the given entity based on its attribute values, returning the updated entity.
Collection<Entity>	updateSelect(Collection<Entity> entities)	Updates the given entities based on their attribute values, returning the updated entities.
User	user()

Field Details

REMOTE_CLIENT_DOMAIN_TYPE

static final String REMOTE_CLIENT_DOMAIN_TYPE

A key for specifying the domain type required by a remote client

See Also:

• Constant Field Values

Method Details

entities

Entities entities()
           throws RemoteException

Returns:

the underlying domain entities

Throws:

RemoteException - in case of an exception

See Also:

• EntityConnection.entities()

user

User user()
   throws RemoteException

Returns:

the user being used by this connection

Throws:

RemoteException - in case of an exception

See Also:

• EntityConnection.user()

clientId

UUID clientId()
       throws RemoteException

Returns:

the client id for this connection

Throws:

RemoteException - in case of an exception

See Also:

• EntityConnection.clientId()

description

default Optional<String> description()
                              throws RemoteException

Returns a description of this connection, a database or server name for example.

Empty unless this connection manages itself, a raw connection knowing nothing of how it was configured.

Returns:

a description of this connection, an empty Optional if none is available

Throws:

RemoteException - in case of an exception

clientVersion

default Optional<Version> clientVersion()
                                 throws RemoteException

Returns the version of the client this connection belongs to, as reported to the server.

Empty unless this connection manages itself.

Returns:

the client version, an empty Optional if none was specified

Throws:

RemoteException - in case of an exception

connected

boolean connected()
           throws RemoteException

Returns:

true if this connection has been established and is valid

Throws:

RemoteException - in case of an exception

See Also:

• EntityConnection.connected()

close

void close()
    throws RemoteException

Closes this connection.

Specified by:

close in interface AutoCloseable

Throws:

RemoteException - in case of an exception

See Also:

• EntityConnection.close()

transactionOpen

boolean transactionOpen()
                 throws RemoteException

Returns:

true if a transaction is open, false otherwise

Throws:

RemoteException - in case of exception

See Also:

• EntityConnection.transactionOpen()

startTransaction

void startTransaction()
               throws RemoteException

Starts a transaction on this connection.

Throws:

IllegalStateException - if a transaction is already open

RemoteException - in case of exception

See Also:

• EntityConnection.startTransaction()

rollbackTransaction

void rollbackTransaction()
                  throws RemoteException

Performs a rollback and ends the current transaction.

Throws:

DatabaseException - in case the rollback failed

IllegalStateException - in case a transaction is not open

RemoteException - in case of a remote exception

See Also:

• EntityConnection.rollbackTransaction()

commitTransaction

void commitTransaction()
                throws RemoteException

Performs a commit and ends the current transaction.

Throws:

DatabaseException - in case the commit failed

IllegalStateException - in case a transaction is not open

RemoteException - in case of a remote exception

See Also:

• EntityConnection.commitTransaction()

execute

<C extends EntityConnection,
P,
R> @Nullable R execute(FunctionType<C,P,R> functionType)
                                                throws RemoteException

Executes the function with the given type with no parameter.

Type Parameters:

C - the connection type

P - the parameter type

R - the return value type

Parameters:

functionType - the function type

Returns:

the function return value

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.execute(FunctionType)

execute

<C extends EntityConnection,
P,
R> @Nullable R execute(FunctionType<C,P,R> functionType,
 @Nullable P parameter)
                                                throws RemoteException

Executes the function with the given type.

Type Parameters:

C - the connection type

P - the parameter type

R - the return value type

Parameters:

functionType - the function type

parameter - the function parameter

Returns:

the function return value

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.execute(FunctionType, Object)

execute

<C extends EntityConnection,
P> void execute(ProcedureType<C,P> procedureType)
                                      throws RemoteException

Executes the procedure with the given type with no parameter.

Type Parameters:

C - the connection type

P - the procedure parameter type

Parameters:

procedureType - the procedure type

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.execute(ProcedureType)

execute

<C extends EntityConnection,
P> void execute(ProcedureType<C,P> procedureType,
 @Nullable P parameter)
                                      throws RemoteException

Executes the procedure with the given type.

Type Parameters:

C - the connection type

P - the procedure parameter type

Parameters:

procedureType - the procedure type

parameter - the procedure parameter

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.execute(ProcedureType, Object)

insert

Entity.Key insert(Entity entity)
           throws RemoteException

Inserts the given entity, returning the primary key.

Parameters:

entity - the entity to insert

Returns:

the primary key of the inserted entity

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.insert(Entity)

insertSelect

Entity insertSelect(Entity entity)
             throws RemoteException

Inserts the given entity, returning the inserted entity.

Parameters:

entity - the entity to insert

Returns:

the inserted entity

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.insertSelect(Entity)

insert

Collection<Entity.Key> insert(Collection<Entity> entities)
                       throws RemoteException

Inserts the given entities, returning the primary keys.

Parameters:

entities - the entities to insert

Returns:

the primary keys of the inserted entities

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.insert(Collection)

insertSelect

Collection<Entity> insertSelect(Collection<Entity> entities)
                         throws RemoteException

Inserts the given entities, returning the inserted entities.

Parameters:

entities - the entities to insert

Returns:

the inserted entities

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.insertSelect(Collection)

update

void update(Entity entity)
     throws RemoteException

Updates the given entity based on its attribute values.

Parameters:

entity - the entity to update

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.update(Entity)

updateSelect

Entity updateSelect(Entity entity)
             throws RemoteException

Updates the given entity based on its attribute values, returning the updated entity.

Parameters:

entity - the entity to update

Returns:

the updated entity

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.updateSelect(Entity)

update

void update(Collection<Entity> entities)
     throws RemoteException

Updates the given entities based on their attribute values.

Parameters:

entities - the entities to update

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.update(Collection)

updateSelect

Collection<Entity> updateSelect(Collection<Entity> entities)
                         throws RemoteException

Updates the given entities based on their attribute values, returning the updated entities.

Parameters:

entities - the entities to update

Returns:

the updated entities, in no particular order

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.updateSelect(Collection)

update

int update(EntityConnection.Update update)
    throws RemoteException

Performs an update based on the given update.

Parameters:

update - the update to perform

Returns:

the number of affected rows

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.update(Update)

update

default int update(Supplier<EntityConnection.Update> update)
            throws RemoteException

Convenience overload accepting an EntityConnection.Update.Builder or any Supplier of EntityConnection.Update, removing the need for a trailing EntityConnection.Update.Builder.build() call.

Parameters:

update - the update supplier, typically an EntityConnection.Update.Builder

Returns:

the number of affected rows

Throws:

RemoteException - in case of a remote exception

See Also:

• update(Update)

delete

void delete(Entity.Key key)
     throws RemoteException

Deletes the entity with the given primary key.

Parameters:

key - the primary key of the entity to delete

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.delete(Entity.Key)

delete

void delete(Collection<Entity.Key> keys)
     throws RemoteException

Deletes the entities with the given primary keys.

Parameters:

keys - the primary keys of the entities to delete

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.delete(Collection)

delete

int delete(Condition condition)
    throws RemoteException

Deletes the entities specified by the given condition.

Parameters:

condition - the condition specifying the entities to delete

Returns:

the number of deleted rows

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.delete(Condition)

select

<T> List<T> select(Column<T> column)
            throws RemoteException

Selects ordered and distinct non-null values of the given column.

Type Parameters:

T - the value type

Parameters:

column - the column

Returns:

all the values of the given column

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Column)

select

<T> List<T> select(Column<T> column,
 Condition condition)
            throws RemoteException

Selects distinct non-null values of the given column.

Type Parameters:

T - the value type

Parameters:

column - column

condition - the condition

Returns:

the values of the given column

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Column, Condition)

select

<T> List<T> select(Column<T> column,
 EntityConnection.Select select)
            throws RemoteException

Selects distinct non-null values of the given column.

Type Parameters:

T - the value type

Parameters:

column - the column

select - the select to perform

Returns:

the values of the given column

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Column, Select)

select

default <T> List<T> select(Column<T> column,
 Supplier<EntityConnection.Select> select)
                    throws RemoteException

Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.

Type Parameters:

T - the column value type

Parameters:

column - the column for which to retrieve the values

select - the select supplier, typically a EntityConnection.Select.Builder

Returns:

the values of the given column

Throws:

RemoteException - in case of a remote exception

See Also:

• select(Column, Select)

select

Entity select(Entity.Key key)
       throws RemoteException

Selects an entity by key.

Parameters:

key - the key of the entity to select

Returns:

an entity having the key key

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Entity.Key)

selectSingle

Entity selectSingle(Condition condition)
             throws RemoteException

Selects a single entity based on the specified condition.

Parameters:

condition - the condition specifying the entity to select

Returns:

the entity based on the given condition

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.selectSingle(Condition)

selectSingle

Entity selectSingle(EntityConnection.Select select)
             throws RemoteException

Selects a single entity based on the specified select.

Parameters:

select - the select to perform

Returns:

the entity based on the given select

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.selectSingle(Select)

selectSingle

default Entity selectSingle(Supplier<EntityConnection.Select> select)
                     throws RemoteException

Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.

Parameters:

select - the select supplier, typically a EntityConnection.Select.Builder

Returns:

the entity based on the given select

Throws:

RemoteException - in case of a remote exception

See Also:

• selectSingle(Select)

select

Collection<Entity> select(Collection<Entity.Key> keys)
                   throws RemoteException

Selects entities based on the given keys.

Parameters:

keys - the keys used in the condition

Returns:

entities based on keys

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Collection)

select

List<Entity> select(Condition condition)
             throws RemoteException

Selects entities based on the given condition.

Parameters:

condition - the condition specifying which entities to select

Returns:

entities based on the given condition

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Condition)

select

List<Entity> select(EntityConnection.Select select)
             throws RemoteException

Selects entities based on the given select.

Parameters:

select - the select to perform

Returns:

entities based on the given select

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.select(Select)

select

default List<Entity> select(Supplier<EntityConnection.Select> select)
                     throws RemoteException

Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.

Parameters:

select - the select supplier, typically a EntityConnection.Select.Builder

Returns:

entities based on the given select

Throws:

RemoteException - in case of a remote exception

See Also:

• select(Select)

dependencies

Map<EntityType,Collection<Entity>> dependencies(Collection<Entity> entities)
                                         throws RemoteException

Selects the entities that depend on the given entities via (non-soft) foreign keys, mapped to corresponding entityTypes.

Parameters:

entities - the entities for which to retrieve dependencies

Returns:

the entities that depend on entities

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.dependencies(Collection)

count

int count(EntityConnection.Count count)
   throws RemoteException

Counts the number of rows returned based on the given count conditions.

Parameters:

count - the count conditions

Returns:

the number of rows fitting the given count conditions

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.count(Count)

count

default int count(Supplier<EntityConnection.Count> count)
           throws RemoteException

Convenience overload accepting a EntityConnection.Count.Builder or any Supplier of EntityConnection.Count, removing the need for a trailing EntityConnection.Count.Builder.build() call.

Parameters:

count - the count supplier, typically a EntityConnection.Count.Builder

Returns:

the number of rows fitting the given count conditions

Throws:

RemoteException - in case of a remote exception

See Also:

• count(Count)

report

<P,
R> R report(ReportType<P,R> reportType,
 @Nullable P parameter)
         throws RemoteException

Fills the given report using a JDBC datasource and returns the result.

Type Parameters:

P - the report parameters type

R - the report result type

Parameters:

reportType - the report to fill

parameter - the report parameter, if any

Returns:

the filled result object

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.report(ReportType, Object)

iterator

ServerEntityResultIterator iterator(Condition condition)
                             throws RemoteException

Returns a result set iterator based on the given query condition. Note that the returned iterator is wrapped to present the EntityResultIterator interface to client code.

Parameters:

condition - the query condition

Returns:

an iterator for the given query condition

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.iterator(Condition)

iterator

ServerEntityResultIterator iterator(EntityConnection.Select select)
                             throws RemoteException

Returns a result set iterator based on the given select. Note that the returned iterator is wrapped to present the EntityResultIterator interface to client code.

Parameters:

select - the query select

Returns:

an iterator for the given query select

Throws:

RemoteException - in case of a remote exception

See Also:

• EntityConnection.iterator(Select)

iterator

default ServerEntityResultIterator iterator(Supplier<EntityConnection.Select> select)
                                     throws RemoteException

Convenience overload accepting a EntityConnection.Select.Builder or any Supplier of EntityConnection.Select, removing the need for a trailing EntityConnection.Select.Builder.build() call.

Parameters:

select - the select supplier, typically a EntityConnection.Select.Builder

Returns:

an iterator for the given query select

Throws:

RemoteException - in case of a remote exception

See Also:

• iterator(Select)