io.spine.server

Class Server

java.lang.Object

io.spine.server.Server

All Implemented Interfaces:

io.spine.logging.Logging

public final class Server
extends java.lang.Object
implements io.spine.logging.Logging

Exposes one or more Bounded Contexts using CommandService, QueryService and SubscriptionService.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.Builder The builder for the server.

Method Summary

Modifier and Type	Method and Description
static Server.Builder	atPort(int port) Initiates creating a server exposed at the passed port.
void	awaitTermination() Waits for the server to become terminated.
CommandService	commandService() Obtains the CommandService exposed by this server.
static Server.Builder	inProcess(java.lang.String serverName) Initiates creating an in-process server exposed with the given name.
static Server.Builder	newBuilder() Deprecated. please use Server.atPort(int) or Server.inProcess(String)
int	port() Deprecated. please do not use
QueryService	queryService() Obtains the QueryService exposed by this server.
void	shutdown() Initiates an orderly shutdown in which existing calls continue but new calls are rejected.
void	shutdownAndWait() Initiates a forceful shutdown in which preexisting and new calls are rejected.
void	start() Starts the server.
SubscriptionService	subscriptionService() Obtains the SubscriptionService exposed by this server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Method Detail

newBuilder

@Deprecated
public static Server.Builder newBuilder()

Deprecated. please use Server.atPort(int) or Server.inProcess(String)

Creates a new builder for the server.

atPort

public static Server.Builder atPort(int port)

Initiates creating a server exposed at the passed port.

inProcess

public static Server.Builder inProcess(java.lang.String serverName)

Initiates creating an in-process server exposed with the given name.

The server is full-featured, high performance, and is useful in testing.

start

public void start()
           throws java.io.IOException

Starts the server.

Throws:

java.io.IOException - if the service could not be started

awaitTermination

public void awaitTermination()

Waits for the server to become terminated.

shutdown

public void shutdown()

Initiates an orderly shutdown in which existing calls continue but new calls are rejected.

shutdownAndWait

public void shutdownAndWait()

Initiates a forceful shutdown in which preexisting and new calls are rejected.

The method returns when the server becomes terminated. The most common usage scenario for this method is clean-up in unit tests (e.g. @AfterEach in JUnit5) that involve client-server communications.

queryService

public QueryService queryService()

Obtains the QueryService exposed by this server.

subscriptionService

public SubscriptionService subscriptionService()

Obtains the SubscriptionService exposed by this server.

commandService

public CommandService commandService()

Obtains the CommandService exposed by this server.

port

@Deprecated
public int port()

Deprecated. please do not use

Always returns zero.