com.ibm.wsspi.kernel.embeddable
Interface Server


public interface Server

An embedded Liberty server instance.

Server instances are obtained using the ServerBuilder. The methods of this interface can be used to manage and control the server instance.

There are some limitations when working with an embedded server: environment variables are not checked, and jvm.options and server.env files are not read. Management of the JVM and environment is assumed to be managed by the caller.

bootstrap.properties and server.xml files will be read as normal, with additional caveats listed below.

Consumers of this SPI must not implement this interface. A server instance is thread safe.

See Also:
ServerBuilder.build()

Nested Class Summary
static interface Server.Result
          Result of a start or stop operation.
 
Method Summary
 boolean isRunning()
           
 java.util.concurrent.Future<Server.Result> start(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String... arguments)
          Start the Liberty server instance using the given arguments.
 java.util.concurrent.Future<Server.Result> start(java.lang.String... arguments)
          Start the Liberty server instance using the given arguments.
 java.util.concurrent.Future<Server.Result> stop(java.lang.String... arguments)
          Stop the Liberty server instance.
 

Method Detail

start

java.util.concurrent.Future<Server.Result> start(java.lang.String... arguments)
Start the Liberty server instance using the given arguments. The arguments used here are the same as would be passed to the command line.

Parameters:
arguments - Command line arguments for start
Returns:
a Future representing pending completion of the start operation

start

java.util.concurrent.Future<Server.Result> start(java.util.Map<java.lang.String,java.lang.String> props,
                                                 java.lang.String... arguments)
Start the Liberty server instance using the given arguments. The arguments used here are the same as would be passed to the command line.

Parameters:
props - Additional properties that will supersede any values read from bootstrap.properties or System.properties
arguments - Command line arguments for start
Returns:
a Future representing pending completion of the start operation

stop

java.util.concurrent.Future<Server.Result> stop(java.lang.String... arguments)
Stop the Liberty server instance.

Parameters:
arguments - Command line arguments for stop
Returns:
a Future representing pending completion of the stop operation

isRunning

boolean isRunning()
Returns:
true if this server instance is running