Module is.codion.framework.db.http

Package is.codion.framework.db.http

Interface HttpEntityConnection

All Superinterfaces:

AutoCloseable, EntityConnection

public interface HttpEntityConnection
extends EntityConnection

A factory for http based EntityConnection builder.

See Also:

• HOSTNAME
• PORT
• SECURE
• JSON
• SOCKET_TIMEOUT
• CONNECT_TIMEOUT

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HttpEntityConnection.Builder	Builds a http based EntityConnection

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

EntityConnection.BatchCopy, EntityConnection.BatchInsert, EntityConnection.Count, EntityConnection.Select, EntityConnection.Transactional, EntityConnection.TransactionalResult<T>, EntityConnection.Update

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Integer>	CONNECT_TIMEOUT	The connect timeout in milliseconds Value type: Integer Default value: 2000 ms
static final PropertyValue<Boolean>	DISCONNECT_ON_CLOSE	Specifies whether HTTP connections should send a close request to the server when closing.
static final PropertyValue<String>	HOSTNAME	The host on which to locate the http server Value type: String Default value: localhost
static final PropertyValue<Boolean>	JSON	Specifies whether json serialization should be used Value types: Boolean Default value: true
static final PropertyValue<Integer>	PORT	The port which the http client should use. Value type: Integer Default value: 8080
static final PropertyValue<Boolean>	SECURE	Specifies whether https should be used Value type: boolean Default value: true
static final PropertyValue<Integer>	SECURE_PORT	The port which the https client should use Value type: Integer Default value: 4443
static final PropertyValue<Integer>	SOCKET_TIMEOUT	The socket timeout in milliseconds Value type: Integer Default value: 2000 ms

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

DEFAULT_MAXIMUM_BATCH_SIZE, DEFAULT_QUERY_TIMEOUT_SECONDS, MAXIMUM_BATCH_SIZE

Method Summary

Static Methods

Modifier and Type	Method	Description
static HttpEntityConnection.Builder	builder()

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

close, commitTransaction, connected, count, delete, delete, delete, dependencies, entities, execute, execute, execute, execute, insert, insert, insertSelect, insertSelect, queryCache, queryCache, report, rollbackTransaction, select, select, select, select, select, select, select, selectSingle, selectSingle, startTransaction, transactionOpen, update, update, update, updateSelect, updateSelect, user

Field Details

HOSTNAME

static final PropertyValue<String> HOSTNAME

The host on which to locate the http server

• Value type: String
• Default value: localhost

PORT

static final PropertyValue<Integer> PORT

The port which the http client should use.

• Value type: Integer
  
• Default value: 8080

SECURE_PORT

static final PropertyValue<Integer> SECURE_PORT

The port which the https client should use

• Value type: Integer
• Default value: 4443

SECURE

static final PropertyValue<Boolean> SECURE

Specifies whether https should be used

• Value type: boolean
• Default value: true

JSON

static final PropertyValue<Boolean> JSON

Specifies whether json serialization should be used Value types: Boolean

• Default value: true

SOCKET_TIMEOUT

static final PropertyValue<Integer> SOCKET_TIMEOUT

The socket timeout in milliseconds

• Value type: Integer
• Default value: 2000 ms

CONNECT_TIMEOUT

static final PropertyValue<Integer> CONNECT_TIMEOUT

The connect timeout in milliseconds

• Value type: Integer
• Default value: 2000 ms

DISCONNECT_ON_CLOSE

static final PropertyValue<Boolean> DISCONNECT_ON_CLOSE

Specifies whether HTTP connections should send a close request to the server when closing.

When true (default), the connection will notify the server when closing by sending a "close" request. This allows stateful servers to clean up resources associated with the connection.

When false, the connection will close immediately without notifying the server. This is useful for stateless deployments such as serverless functions (e.g. AWS Lambda), where sending a close request would unnecessarily invoke the function, causing delays and incurring costs.

Value types: Boolean

• Default value: true

See Also:

• EntityConnection.close()

Method Details

builder

static HttpEntityConnection.Builder builder()

Returns:

a new builder instance