Module is.codion.framework.server
Package is.codion.framework.server

Interface EntityServerConfiguration

All Superinterfaces:
is.codion.common.rmi.server.ServerConfiguration
public interface EntityServerConfiguration extends is.codion.common.rmi.server.ServerConfiguration
Configuration values for a EntityServer.
See Also:

  • 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 is.codion.common.property.PropertyValue<String>
    CLIENT_CONNECTION_TIMEOUT
    Specifies the default client connection timeout (ms) in a comma separated list.
    static final is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.PropertyValue<String>
    CONNECTION_POOL_FACTORY_CLASS
    Specifies the class name of the connection pool factory to use.
    Value type: String
    Default value: none
    static final is.codion.common.property.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 int
    DEFAULT_CONNECTION_LIMIT
     
    static final is.codion.common.property.PropertyValue<String>
    DOMAIN_MODEL_CLASSES
    Specifies a comma separated list of domain model class names, these classes must be available on the server classpath
    static final org.slf4j.Logger
    LOG
     

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

    ADMIN_PORT, ADMIN_USER, 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_NAME_PREFIX, SERVER_PORT, SSL_ENABLED

  • Method Summary

    Modifier and Type
    Method
    Description
    is.codion.common.user.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()
     
    int
    connectionLimit()
     
    String
    connectionPoolFactory()
     
    Collection<is.codion.common.user.User>
    connectionPoolUsers()
     
    is.codion.common.db.database.Database
    database()
     
    Collection<String>
    domainClassNames()
     
    int
    idleConnectionTimeout()
     

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

    adminPort, auxiliaryServerFactoryClassNames, connectionMaintenanceInterval, port, registryPort, rmiClientSocketFactory, rmiServerSocketFactory, serializationFilterDryRun, serializationFilterWhitelist, serverName, sslEnabled

  • Field Details

    • LOG

      static final org.slf4j.Logger LOG

    • DEFAULT_CONNECTION_LIMIT

      static final int DEFAULT_CONNECTION_LIMIT
      See Also:

    • CONNECTION_LIMIT

      static final is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.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 is.codion.common.property.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

      is.codion.common.db.database.Database database()
      Returns:
      the Database implementation

    • adminUser

      is.codion.common.user.User adminUser()
      Returns:
      the admin user

    • connectionLimit

      int connectionLimit()
      Returns:
      the maximum number of concurrent connections, -1 for no limit

    • 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<is.codion.common.user.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.