Module is.codion.framework.server

Package is.codion.framework.server

Interface EntityServerConfiguration

All Superinterfaces:

ServerConfiguration

public interface EntityServerConfiguration
extends ServerConfiguration

Configuration values for a EntityServer.

See Also:

• builder(int, int)
• builderFromSystemProperties()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityServerConfiguration.Builder	A Builder for EntityServerConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	CLIENT_CONNECTION_TIMEOUT	Specifies the default client connection timeout (ms) in a comma separated list.
static final PropertyValue<Boolean>	CLIENT_LOGGING	The initial connection logging status on the server, either true (on) or false (off) Value type: Boolean Default value: false
static final PropertyValue<Integer>	CONNECTION_LIMIT	Specifies maximum number of concurrent connections the server accepts -1 indicates no limit and 0 indicates a closed server.
static final PropertyValue<String>	CONNECTION_POOL_FACTORY_CLASS	Specifies the class name of the connection pool factory to use.
static final PropertyValue<String>	CONNECTION_POOL_USERS	Specifies a comma separated list of username:password combinations for which to create connection pools on startup Example: scott:tiger,john:foo,paul:bar
static final PropertyValue<String>	DOMAIN_MODEL_CLASSES	Specifies a comma separated list of domain model class names, these classes must be available on the server classpath

Fields inherited from interface is.codion.common.rmi.server.ServerConfiguration

ADMIN_PORT, ADMIN_USER, AUXILIARY_SERVER_FACTORY_CLASS_NAMES, CLASSPATH_KEYSTORE, CONNECTION_MAINTENANCE_INTERVAL, DEFAULT_CONNECTION_MAINTENANCE_INTERVAL, DEFAULT_IDLE_CONNECTION_TIMEOUT, IDLE_CONNECTION_TIMEOUT, JAVAX_NET_KEYSTORE, JAVAX_NET_KEYSTORE_PASSWORD, KEYSTORE, KEYSTORE_PASSWORD, LOCALHOST, OBJECT_INPUT_FILTER_FACTORY_CLASS_NAME, REGISTRY_PORT, RMI_SERVER_HOSTNAME, SERVER_NAME_PREFIX, SERVER_PORT, SSL_ENABLED

Method Summary

Modifier and Type	Method	Description
User	adminUser()
static EntityServerConfiguration.Builder	builder(int serverPort, int registryPort)
static EntityServerConfiguration.Builder	builderFromSystemProperties()	Returns a Builder initialized with values from system properties.
boolean	clientLogging()
Map<String,Integer>	clientTypeIdleConnectionTimeouts()
String	connectionPoolFactory()
Collection<User>	connectionPoolUsers()
Database	database()
Collection<String>	domainClassNames()
int	idleConnectionTimeout()

Methods inherited from interface is.codion.common.rmi.server.ServerConfiguration

adminPort, auxiliaryServerFactoryClassNames, connectionLimit, connectionMaintenanceInterval, objectInputFilterFactoryClassName, port, registryPort, rmiClientSocketFactory, rmiServerSocketFactory, serverName, sslEnabled

Field Details

CONNECTION_LIMIT

static final PropertyValue<Integer> CONNECTION_LIMIT

Specifies maximum number of concurrent connections the server accepts -1 indicates no limit and 0 indicates a closed server.

• Value type: Integer
• Default value: -1

CONNECTION_POOL_FACTORY_CLASS

static final PropertyValue<String> CONNECTION_POOL_FACTORY_CLASS

Specifies the class name of the connection pool factory to use.

• Value type: String
• Default value: none

See Also:

• ConnectionPoolFactory

CLIENT_CONNECTION_TIMEOUT

static final PropertyValue<String> CLIENT_CONNECTION_TIMEOUT

Specifies the default client connection timeout (ms) in a comma separated list.

• Example: is.codion.demos.employees.client.ui.EmployeesAppPanel:60000,is.codion.demos.chinook.ui.ChinookAppPanel:120000
• Value type: String
• Default value: none

CLIENT_LOGGING

static final PropertyValue<Boolean> CLIENT_LOGGING

The initial connection logging status on the server, either true (on) or false (off)

• Value type: Boolean
• Default value: false

CONNECTION_POOL_USERS

static final PropertyValue<String> CONNECTION_POOL_USERS

Specifies a comma separated list of username:password combinations for which to create connection pools on startup Example: scott:tiger,john:foo,paul:bar

DOMAIN_MODEL_CLASSES

static final PropertyValue<String> DOMAIN_MODEL_CLASSES

Specifies a comma separated list of domain model class names, these classes must be available on the server classpath

Method Details

database

Database database()

Returns:

the Database implementation

adminUser

User adminUser()

Returns:

the admin user

clientLogging

boolean clientLogging()

Returns:

true if client logging should be enabled on startup

idleConnectionTimeout

int idleConnectionTimeout()

Returns:

the idle connection timeout

connectionPoolFactory

String connectionPoolFactory()

Returns:

the connection pool factory classname

domainClassNames

Collection<String> domainClassNames()

Returns:

the domain model classes to load on startup

connectionPoolUsers

Collection<User> connectionPoolUsers()

Returns:

the users for which to initialize connection pools on startup

clientTypeIdleConnectionTimeouts

Map<String,Integer> clientTypeIdleConnectionTimeouts()

Returns:

client type specific idle connection timeouts, mapped to clientTypeId

builder

static EntityServerConfiguration.Builder builder(int serverPort,
 int registryPort)

Parameters:

serverPort - the server port

registryPort - the registry port

Returns:

a default entity connection server configuration builder

builderFromSystemProperties

static EntityServerConfiguration.Builder builderFromSystemProperties()

Returns a Builder initialized with values from system properties.

Returns:

an entity server configuration builder initialized with values from system properties.