io.spine.server

Class ServerEnvironment

java.lang.Object

io.spine.server.ServerEnvironment

All Implemented Interfaces:

java.lang.AutoCloseable

public final class ServerEnvironment
extends java.lang.Object
implements java.lang.AutoCloseable

The server conditions and configuration under which the application operates.

Configuration

Some parts of the ServerEnvironment can be customized based on the EnvironmentType. To do so, one of the overloads of the use method can be called. Two environment types exist out of the box: Tests and Production. For example:

     ServerEnvironment.use(productionStorageFactory, Production.class)
                      .use(testingStorageFactory, Tests.class)
                      .use(memoizingTracerFactory, Production.class)
 

A custom environment type may also be used:

     final class StagingEnvironment extends EnvironmentType {
         ...
     }

     // Can also be
     // `ServerEnvironment.use(inMemoryStorageFactory, new Staging(stagingServiceDiscovery));`,
     // if `Staging` expects dependencies to its constructor.
     ServerEnvironment.use(inMemoryStorageFactory, Staging.class);
 

If Staging is enabled, the specified value is going to be returned on ServerEnvironment.storageFactory().

Method Summary

Modifier and Type	Method and Description
void	close() Releases resources associated with this instance.
void	configureDelivery(Delivery delivery) Deprecated. use ServerEnvironment.use(Delivery, EnvironmentType)
void	configureDeployment(java.util.function.Supplier<io.spine.server.DeploymentType> supplier) Makes the ServerEnvironment.deploymentType() return the values from the provided supplier.
void	configureStorage(StorageFactory factory) Deprecated. use ServerEnvironment.use(StorageFactory, Class), specifying the Production.class or any other environment type
void	configureStorageForTests(StorageFactory factory) Deprecated. use ServerEnvironment.use(StorageFactory, Class), specifying Tests.class)
Delivery	delivery() Returns the delivery mechanism specific to this environment.
io.spine.server.DeploymentType	deploymentType() The type of the environment application is deployed to.
static ServerEnvironment	instance() Returns a singleton instance.
CommandScheduler	newCommandScheduler() Obtains command scheduling mechanism used by CommandBus in this environment.
io.spine.server.NodeId	nodeId() Obtains the identifier of the server node, on which this code is running at the moment.
void	reset() This is test-only method required for cleaning of the server environment instance in tests.
void	scheduleCommandsUsing(java.util.function.Supplier<CommandScheduler> commandScheduler) Assigns command scheduling mechanism used at this environment by all CommandBus instances.
StorageFactory	storageFactory() Obtains the storage factory for the current environment.
java.util.Optional<TracerFactory>	tracing() Obtains the TracerFactory associated with the current environment, if it was set.
TransportFactory	transportFactory() Obtains the transport factory for the current environment.
ServerEnvironment	use(Delivery delivery, java.lang.Class<? extends io.spine.base.EnvironmentType> envType) Assigns the specified Delivery for the selected environment.
ServerEnvironment	use(Delivery delivery, io.spine.base.EnvironmentType envType) Assigns the specified Delivery for the selected environment.
ServerEnvironment	use(StorageFactory factory, java.lang.Class<? extends io.spine.base.EnvironmentType> type) Assigns the specified TransportFactory for the specified application environment.
ServerEnvironment	use(StorageFactory factory, io.spine.base.EnvironmentType envType) Assigns the specified TransportFactory for the specified application environment.
ServerEnvironment	use(TracerFactory factory, java.lang.Class<? extends io.spine.base.EnvironmentType> envType) Assigns TracerFactory for the specified application environment.
ServerEnvironment	use(TracerFactory factory, io.spine.base.EnvironmentType envType) Assigns TracerFactory for the specified application environment.
ServerEnvironment	use(TransportFactory factory, java.lang.Class<? extends io.spine.base.EnvironmentType> type) Configures the specified transport factory for the selected type of environment.
ServerEnvironment	use(TransportFactory factory, io.spine.base.EnvironmentType envType) Configures the specified transport factory for the selected type of environment.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ServerEnvironment instance()

Returns a singleton instance.

deploymentType

public io.spine.server.DeploymentType deploymentType()

The type of the environment application is deployed to.

configureDelivery

@Deprecated
public void configureDelivery(Delivery delivery)

Deprecated. use ServerEnvironment.use(Delivery, EnvironmentType)

Updates the delivery for the current environment.

This method is most typically used upon an application start. It's very uncommon and even dangerous to update the delivery mechanism later when the message delivery process may have been already used by various BoundedContexts.

delivery

public Delivery delivery()

Returns the delivery mechanism specific to this environment.

Unless updated manually, returns a local implementation of Delivery.

newCommandScheduler

public CommandScheduler newCommandScheduler()

Obtains command scheduling mechanism used by CommandBus in this environment.

scheduleCommandsUsing

public void scheduleCommandsUsing(java.util.function.Supplier<CommandScheduler> commandScheduler)

Assigns command scheduling mechanism used at this environment by all CommandBus instances.

If not configured, ExecutorCommandScheduler is used.

nodeId

public io.spine.server.NodeId nodeId()

Obtains the identifier of the server node, on which this code is running at the moment.

At the moment, the node identifier is always UUID-generated. In future versions of the framework it is expected to become configurable.

configureDeployment

public void configureDeployment(java.util.function.Supplier<io.spine.server.DeploymentType> supplier)

Makes the ServerEnvironment.deploymentType() return the values from the provided supplier.

When supplying your own deployment type in tests, remember to reset it during tear down.

use

@CanIgnoreReturnValue
public ServerEnvironment use(StorageFactory factory,
                                                   io.spine.base.EnvironmentType envType)

Assigns the specified TransportFactory for the specified application environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(StorageFactory factory,
                                                   java.lang.Class<? extends io.spine.base.EnvironmentType> type)

Assigns the specified TransportFactory for the specified application environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(Delivery delivery,
                                                   io.spine.base.EnvironmentType envType)

Assigns the specified Delivery for the selected environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(Delivery delivery,
                                                   java.lang.Class<? extends io.spine.base.EnvironmentType> envType)

Assigns the specified Delivery for the selected environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(TracerFactory factory,
                                                   io.spine.base.EnvironmentType envType)

Assigns TracerFactory for the specified application environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(TracerFactory factory,
                                                   java.lang.Class<? extends io.spine.base.EnvironmentType> envType)

Assigns TracerFactory for the specified application environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(TransportFactory factory,
                                                   io.spine.base.EnvironmentType envType)

Configures the specified transport factory for the selected type of environment.

Returns:

this instance of ServerEnvironment

use

@CanIgnoreReturnValue
public ServerEnvironment use(TransportFactory factory,
                                                   java.lang.Class<? extends io.spine.base.EnvironmentType> type)

Configures the specified transport factory for the selected type of environment.

Returns:

this instance of ServerEnvironment

configureStorageForTests

@Deprecated
public void configureStorageForTests(StorageFactory factory)

Deprecated. use ServerEnvironment.use(StorageFactory, Class), specifying Tests.class)

Assigns the specified StorageFactory for tests.

configureStorage

@Deprecated
public void configureStorage(StorageFactory factory)

Deprecated. use ServerEnvironment.use(StorageFactory, Class), specifying the Production.class or any other environment type

Assigns the specified StorageFactory for the Production application environment.

tracing

public java.util.Optional<TracerFactory> tracing()

Obtains the TracerFactory associated with the current environment, if it was set.

storageFactory

public StorageFactory storageFactory()

Obtains the storage factory for the current environment.

For tests, if the value was not set, defaults to a new InMemoryStorageFactory.

For other environments, if the value was not set, throws a IllegalStateException.

Returns:

StorageFactory instance for the storage for the current environment

Throws:

java.lang.IllegalStateException - if the value StorageFactory was not ServerEnvironment.use(StorageFactory, Class) configured} prior to the call

transportFactory

public TransportFactory transportFactory()

Obtains the transport factory for the current environment.

In the testing environment, if the factory was not assigned, assigns a new InMemoryTransportFactory and returns it.

For all other environment types, throws an IllegalStateException.

If the factory is not assigned in the Tests mode, assigns the instance of InMemoryTransportFactory and returns it.

reset

public void reset()

This is test-only method required for cleaning of the server environment instance in tests.

close

public void close()
           throws java.lang.Exception

Releases resources associated with this instance.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception