com.vmware.vapi.server

Class Server

java.lang.Object

com.vmware.vapi.server.Server

All Implemented Interfaces:

ServerInterface, Runnable

public class Server
extends Object
implements ServerInterface

Starts an ApiProvider server.

Constructor Summary

Constructors

Constructor and Description
Server(Configurator configurator) Creates an ApiProvider instance configured by the provided Configurator.
Server(Properties props) Creates an ApiProvider instance configured according to the provided properties object.

Method Summary

Methods

Modifier and Type	Method and Description
ProtocolConnection	getLocalConnection() Returns local connection to the primary API provider.
static void	main(String[] args) Program entry point; runs the server using the configuration specified in the properties file provided as a command-line argument.
void	run() Runs the server.
void	stop() Stops the server.
boolean	waitForShutdown(long timeoutMillis) Wait for the server shutdown to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(Properties props)
       throws Exception

Creates an ApiProvider instance configured according to the provided properties object.

Parameters:

props - properties object

Throws:

Exception

Server

public Server(Configurator configurator)

Creates an ApiProvider instance configured by the provided Configurator.

Parameters:

configurator - configurator instance

Method Detail

stop

public void stop()

Stops the server.

Specified by:

stop in interface ServerInterface

waitForShutdown

public boolean waitForShutdown(long timeoutMillis)
                        throws InterruptedException

Wait for the server shutdown to complete. If the server is already shutdown, the method will return true immediately.

Specified by:

waitForShutdown in interface ServerInterface

Parameters:

timeoutMillis - maximum time to wait for the shutdown to complete (in milliseconds)

Returns:

whether the shutdown completed or the timeout expired

Throws:

InterruptedException - the wait has been interrupted

run

public void run()

Runs the server.

Specified by:

run in interface ServerInterface

Specified by:

run in interface Runnable

getLocalConnection

public ProtocolConnection getLocalConnection()

Returns local connection to the primary API provider. This connection can be used only by clients inside the same process.

Specified by:

getLocalConnection in interface ServerInterface

Returns:

connection which involves no networking

main

public static void main(String[] args)
                 throws Exception

Program entry point; runs the server using the configuration specified in the properties file provided as a command-line argument.

Parameters:

args - program arguments; should contain a single entry specifying the path to the properties file for the server instance.

Throws:

Exception - problem with the starting the server