is.codion.framework.server

Interface EntityServerConfiguration

All Superinterfaces:

ServerConfiguration

public interface EntityServerConfiguration
extends ServerConfiguration

Configuration values for a EntityServer.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SERVER_CONNECTION_LIMIT
static org.slf4j.Logger	LOG
static PropertyValue<String>	SERVER_CLIENT_CONNECTION_TIMEOUT Specifies the default client connection timeout (ms) in a comma separated list.
static PropertyValue<Boolean>	SERVER_CLIENT_LOGGING_ENABLED The initial connection logging status on the server, either true (on) or false (off) Value type: Boolean Default value: false
static PropertyValue<Integer>	SERVER_CONNECTION_LIMIT Specifies maximum number of concurrent connections the server accepts -1 indicates no limit and 0 indicates a closed server.
static PropertyValue<String>	SERVER_CONNECTION_POOL_FACTORY_CLASS Specifies the class name of the connection pool factory to user. Value type: String Default value: none
static PropertyValue<String>	SERVER_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 PropertyValue<String>	SERVER_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

AUXILIARY_SERVER_FACTORY_CLASS_NAMES, CLASSPATH_KEYSTORE, CONNECTION_MAINTENANCE_INTERVAL_MS, DEFAULT_CONNECTION_MAINTENANCE_INTERVAL, DEFAULT_IDLE_CONNECTION_TIMEOUT, IDLE_CONNECTION_TIMEOUT, JAVAX_NET_KEYSTORE, JAVAX_NET_KEYSTORE_PASSWORD, KEYSTORE, KEYSTORE_PASSWORD, LOCALHOST, REGISTRY_PORT, RMI_SERVER_HOSTNAME, SERIALIZATION_FILTER_DRYRUN, SERIALIZATION_FILTER_WHITELIST, SERVER_ADMIN_PORT, SERVER_ADMIN_USER, SERVER_CONNECTION_SSL_ENABLED, SERVER_NAME_PREFIX, SERVER_PORT

Method Summary

Modifier and Type	Method and Description
User	adminUser()
static EntityServerConfiguration.Builder	builder(int serverPort, int registryPort)
static EntityServerConfiguration.Builder	builderFromSystemProperties() Returns a Builder initialized with values from system properties.
Map<String,Integer>	clientTypeIdleConnectionTimeouts()
int	connectionLimit()
String	connectionPoolProvider()
Collection<User>	connectionPoolUsers()
Database	database()
Collection<String>	domainModelClassNames()
static EntityServerConfiguration	fromSystemProperties() Parses configuration from system properties.
int	idleConnectionTimeout()
boolean	isClientLoggingEnabled()

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

auxiliaryServerFactoryClassNames, builder, connectionMaintenanceInterval, isSerializationFilterDryRun, isSslEnabled, registryPort, rmiClientSocketFactory, rmiServerSocketFactory, serializationFilterWhitelist, serverAdminPort, serverName, serverPort

Field Detail

LOG

static final org.slf4j.Logger LOG

DEFAULT_SERVER_CONNECTION_LIMIT

static final int DEFAULT_SERVER_CONNECTION_LIMIT

See Also:

Constant Field Values

SERVER_CONNECTION_LIMIT

static final PropertyValue<Integer> SERVER_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

SERVER_CONNECTION_POOL_FACTORY_CLASS

static final PropertyValue<String> SERVER_CONNECTION_POOL_FACTORY_CLASS

Specifies the class name of the connection pool factory to user.
Value type: String
Default value: none

See Also:

ConnectionPoolFactory

SERVER_CLIENT_CONNECTION_TIMEOUT

static final PropertyValue<String> SERVER_CLIENT_CONNECTION_TIMEOUT

Specifies the default client connection timeout (ms) in a comma separated list. Example: is.codion.demos.empdept.client.ui.EmpDeptAppPanel:60000,is.codion.demos.chinook.ui.ChinookAppPanel:120000 Value type: String
Default value: none

SERVER_CLIENT_LOGGING_ENABLED

static final PropertyValue<Boolean> SERVER_CLIENT_LOGGING_ENABLED

The initial connection logging status on the server, either true (on) or false (off)
Value type: Boolean
Default value: false

SERVER_CONNECTION_POOL_USERS

static final PropertyValue<String> SERVER_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

SERVER_DOMAIN_MODEL_CLASSES

static final PropertyValue<String> SERVER_DOMAIN_MODEL_CLASSES

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

Method Detail

database

Database database()

Returns:

the Database implementation

adminUser

User adminUser()

Returns:

the admin user

connectionLimit

int connectionLimit()

Returns:

the maximum number of concurrent connections, -1 for no limit

isClientLoggingEnabled

boolean isClientLoggingEnabled()

Returns:

true if client logging should be enabled on startup

idleConnectionTimeout

int idleConnectionTimeout()

Returns:

the idle connection timeout

connectionPoolProvider

String connectionPoolProvider()

Returns:

the connection pool provider classname

domainModelClassNames

Collection<String> domainModelClassNames()

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)

Specified by:

builder in interface ServerConfiguration

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.

Specified by:

builderFromSystemProperties in interface ServerConfiguration

Returns:

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

fromSystemProperties

static EntityServerConfiguration fromSystemProperties()

Parses configuration from system properties.

Specified by:

fromSystemProperties in interface ServerConfiguration

Returns:

the server configuration according to system properties