com.vmware.vapi.protocol.server.rpc.http.impl

Class AbstractServer

java.lang.Object

com.vmware.vapi.protocol.server.rpc.http.impl.AbstractServer

All Implemented Interfaces:

LifecycleListener, LifecycleManager, Server

Direct Known Subclasses:

TcServer

public abstract class AbstractServer
extends Object
implements Server, LifecycleManager

Base class implementing Server interface with common code.

Field Summary

Fields

Modifier and Type	Field and Description
protected Endpoint[]	_endpoints Server listening endpoints
protected Filter[]	_filters Filters for HTTP requests and responses
protected LifecycleManager	_lifecycleManager Common lifecycle for all server components
protected static org.slf4j.Logger	_logger Logger
protected ServerConfigurator	_serverConfig
protected Service[]	_services Services to handle HTTP requests
static int	DEFAULT_PORT
protected static Filter[]	NO_FILTERS
protected static Service[]	NO_SERVICES

Constructor Summary

Constructors

Constructor and Description
AbstractServer()

Method Summary

Modifier and Type	Method and Description
void	addLifecycleListener(LifecycleListener lifecycleListener) Add single life LifecycleListener to the end of the LifecycleListener listeners list.
protected void	applyServerConfigurator()
protected String[]	getDisabledSSLCiphers() Returns an array with supported disabled cipher suites.
protected String[]	getEnabledSSLCiphers() Returns an array with supported enabled cipher suites.
protected abstract Service	prepareDefaultServlet(StaticContentService staticSrv) Prepares default servlet for serving static content.
protected void	prepareStaticContentServices()
void	setEnabledSSLCiphers(String[] enabledCiphers) Configures the enabled SSL ciphers.
void	setEndpoints(Endpoint[] endpoints) Specify the HTTP listening endpoints.
void	setFilters(Filter[] filters) Set the filter chain.
void	setLifecycleListeners(List<LifecycleListener> lifecycleListeners) Sets a List of LifecycleListener listener items that should be managed.
void	setServerConfigurator(ServerConfigurator serverConfig) Set a server configurator class that allows a server add a custom configuration
void	setServices(Service[] services)
void	shutdown() Shutdown the task.
void	shutdownNow() Initiate ungraceful shutdown.
protected static void	validateArray(Object[] array)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vmware.vapi.protocol.server.rpc.http.Server

join, start, stop

Field Detail

_logger

protected static final org.slf4j.Logger _logger

Logger

NO_SERVICES

protected static final Service[] NO_SERVICES

NO_FILTERS

protected static final Filter[] NO_FILTERS

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

_endpoints

protected Endpoint[] _endpoints

Server listening endpoints

_services

protected Service[] _services

Services to handle HTTP requests

_filters

protected Filter[] _filters

Filters for HTTP requests and responses

_lifecycleManager

protected final LifecycleManager _lifecycleManager

Common lifecycle for all server components

_serverConfig

protected ServerConfigurator _serverConfig

Constructor Detail

AbstractServer

public AbstractServer()

Method Detail

prepareDefaultServlet

protected abstract Service prepareDefaultServlet(StaticContentService staticSrv)

Prepares default servlet for serving static content. Each Server implementation receives a StaticContentService and must return a service configured to serve static content.

Parameters:

staticSrv - a static content service definition

Returns:

a static content service prepared to be used with server implementation

setEndpoints

public void setEndpoints(Endpoint[] endpoints)

Description copied from interface: Server

Specify the HTTP listening endpoints.

Specified by:

setEndpoints in interface Server

Parameters:

endpoints - The server will listen for requests on these endpoints.

setServices

public void setServices(Service[] services)

Specified by:

setServices in interface Server

setFilters

public void setFilters(Filter[] filters)

Description copied from interface: Server

Set the filter chain. The filters applied in the order in, which they are listed. During request processing filters that don't match the request path are skipped.

Specified by:

setFilters in interface Server

Parameters:

filters - list of filters.

setServerConfigurator

public void setServerConfigurator(ServerConfigurator serverConfig)

Description copied from interface: Server

Set a server configurator class that allows a server add a custom configuration

Specified by:

setServerConfigurator in interface Server

Parameters:

serverConfig - a ServerConfigurator to add custom configuration to the server

validateArray

protected static void validateArray(Object[] array)

prepareStaticContentServices

protected void prepareStaticContentServices()

applyServerConfigurator

protected void applyServerConfigurator()

addLifecycleListener

public void addLifecycleListener(LifecycleListener lifecycleListener)

Description copied from interface: LifecycleManager

Add single life LifecycleListener to the end of the LifecycleListener listeners list.

Specified by:

addLifecycleListener in interface LifecycleManager

Parameters:

lifecycleListener - LifecycleListener item to be added.

setLifecycleListeners

public void setLifecycleListeners(List<LifecycleListener> lifecycleListeners)

Description copied from interface: LifecycleManager

Sets a List of LifecycleListener listener items that should be managed. The order that the items will be managed is the same as they are passed. If there are already added items with LifecycleManager.addLifecycleListener(LifecycleListener) they are removed from the list.

Specified by:

setLifecycleListeners in interface LifecycleManager

Parameters:

lifecycleListeners - list of LifecycleListener items.

shutdown

public void shutdown()

Description copied from interface: LifecycleListener

Shutdown the task. The call to this method should block until the shutdown is complete.

Shutting down a LifecycleListener that is already shutdown or in the process of shutting down should have no effect.

Specified by:

shutdown in interface LifecycleListener

shutdownNow

public void shutdownNow()

Description copied from interface: LifecycleListener

Initiate ungraceful shutdown. The method call should return immediately without blocking until the shutdown completes.

Shutting down a LifecycleListener that is already shutdown or in the process of shutting down should have no effect.

Specified by:

shutdownNow in interface LifecycleListener

setEnabledSSLCiphers

public void setEnabledSSLCiphers(String[] enabledCiphers)

Configures the enabled SSL ciphers.

Parameters:

enabledCiphers - the enabled SSL ciphers.

Throws:

NullPointerException - if enabledCiphers is null or empty.

getDisabledSSLCiphers

protected String[] getDisabledSSLCiphers()

Returns an array with supported disabled cipher suites.

Returns:

array of disabled cipher suites that are supported on the JVM

getEnabledSSLCiphers

protected String[] getEnabledSSLCiphers()

Returns an array with supported enabled cipher suites.

Returns:

array of enabled cipher suites that are supported on the JVM