Module is.codion.framework.servlet

Package is.codion.framework.servlet

Class EntityService

java.lang.Object

is.codion.framework.servlet.EntityService

All Implemented Interfaces:

AuxiliaryServer

public final class EntityService
extends Object
implements AuxiliaryServer

An AuxiliaryServer implementation providing HTTP based entity services.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<String>	CLASSPATH_KEYSTORE	The https keystore to use on the classpath, this will be resolved to a temporary file and set as the codion.server.http.keyStore system property on server start Value type: String Default value: null
static final PropertyValue<Boolean>	JSON	Specifies whether json based services should be enabled.
static final PropertyValue<String>	KEYSTORE_PASSWORD	Specifies the password for the keystore used for securing http connections.
static final PropertyValue<String>	KEYSTORE_PATH	Specifies the keystore to use for securing http connections.
static final PropertyValue<Integer>	PORT	The port on which the http server is made available to clients.
static final PropertyValue<Boolean>	SECURE	Specifies whether https should be used.
static final PropertyValue<Integer>	SECURE_PORT	The port on which the http server is made available to clients.
static final PropertyValue<Boolean>	SERALIZATION	Specifies whether java serialization based services should be enabled.
static final PropertyValue<Boolean>	USE_VIRTUAL_THREADS	Specifies whether virtual threads should be used.

Method Summary

Modifier and Type	Method	Description
String	information()
void	start()	Starts this server
void	stop()	Stops this server

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PORT

public static final PropertyValue<Integer> PORT

The port on which the http server is made available to clients.

• Value type: Integer
• Default value: 8080

SECURE_PORT

public static final PropertyValue<Integer> SECURE_PORT

The port on which the http server is made available to clients.

• Value type: Integer
• Default value: 4443

SECURE

public static final PropertyValue<Boolean> SECURE

Specifies whether https should be used.

• Value type: Boolean
• Default value: true

CLASSPATH_KEYSTORE

public static final PropertyValue<String> CLASSPATH_KEYSTORE

The https keystore to use on the classpath, this will be resolved to a temporary file and set as the codion.server.http.keyStore system property on server start

• Value type: String
• Default value: null

KEYSTORE_PATH

public static final PropertyValue<String> KEYSTORE_PATH

Specifies the keystore to use for securing http connections.

• Value type: String
• Default value: null

See Also:

• CLASSPATH_KEYSTORE

KEYSTORE_PASSWORD

public static final PropertyValue<String> KEYSTORE_PASSWORD

Specifies the password for the keystore used for securing http connections.

• Value type: String
• Default value: null

USE_VIRTUAL_THREADS

public static final PropertyValue<Boolean> USE_VIRTUAL_THREADS

Specifies whether virtual threads should be used.

• Value type: Boolean
• Default value: false

SERALIZATION

public static final PropertyValue<Boolean> SERALIZATION

Specifies whether java serialization based services should be enabled.

• Value type: Boolean
• Default value: false

JSON

public static final PropertyValue<Boolean> JSON

Specifies whether json based services should be enabled.

• Value type: Boolean
• Default value: true

Method Details

start

public void start()

Description copied from interface: AuxiliaryServer

Starts this server

Specified by:

start in interface AuxiliaryServer

stop

public void stop()

Description copied from interface: AuxiliaryServer

Stops this server

Specified by:

stop in interface AuxiliaryServer

information

public String information()

Specified by:

information in interface AuxiliaryServer

Returns:

a String describing the server and its configuration, for logging purposes