org.ops4j.pax.web.service.spi

Interface ServerController

public interface ServerController

Interface used by pax-web-runtime to interact with actual server runtime. There are three groups of tasks that can be performed:

1. Changing state of the server: stop, start, (re)configuration
2. Sending registration orders related to deployed web applications, contexts, servlets, ...
3. Listener management.

ServerController SHOULD be created with some Configuration and then the runtime SHOULD configure() it, making it prepared for start().

Method Summary

Modifier and Type	Method and Description
void	addListener(ServerListener listener) Registers a listener to be notified about server state changes.
void	configure() Order the server to perform initial configuration.
javax.servlet.Servlet	createResourceServlet(URL urlBase, String base) Each native Servlet container has own version of default/resource servlet usually implementing such aspects as resource caching.
Configuration	getConfiguration() Returns Configuration associated with this ServerController
ServerState	getState() Get a state of the server.
void	removeListener(ServerListener listener) Unregisters previously registered listener
void	sendBatch(Batch batch) Each ServerController can be instructed to perform Batch of atomic operations.
void	start() Starts a configured server.
void	stop() Stops started server.

Method Detail

getState

ServerState getState()

Get a state of the server. Server is ServerState.UNCONFIGURED initially, but may later be reconfigured.

Returns:

configure

void configure()
        throws Exception

Order the server to perform initial configuration. Server can do some initial checks, detect available options (like HTTP/2 support, native libraries, ALPN, ...) and prepare itself to be started.

After server is configured, it can be started and stopped as needed. Of course this server controller, after being configured can be used to register contexts, servlets, filters, ...

Throws:

Exception

start

void start()
    throws Exception

Starts a configured server. Server is considered to be started after it has opened the listening server socket.

Throws:

Exception

stop

void stop()
   throws Exception

Stops started server. The server MAY be able to start again, but it's not necessary. Stopping server controller means it will never be started. Only when new instance will be created, the controller may start again.

Throws:

Exception

getConfiguration

Configuration getConfiguration()

Returns Configuration associated with this ServerController

Returns:

addListener

void addListener(ServerListener listener)

Registers a listener to be notified about server state changes.

Parameters:

listener -

removeListener

void removeListener(ServerListener listener)

Unregisters previously registered listener

Parameters:

listener -

sendBatch

void sendBatch(Batch batch)

Each ServerController can be instructed to perform Batch of atomic operations.

Parameters:

batch -

createResourceServlet

javax.servlet.Servlet createResourceServlet(URL urlBase,
                                            String base)

Each native Servlet container has own version of default/resource servlet usually implementing such aspects as resource caching. Such servlet can be created using two (distinct) parameters:

• urlBase - when the "base" is found to be proper, absolute path to existing, accessible directory
• base - if the "base" is not an absolute file: directory URL, this parameter will be treated as prefix for the resource access as defined in Http/Whiteboard Service specifications (access via HttpContext.getResource(String) or ServletContextHelper.getResource(String).

Parameters:

urlBase - if the "base" is found to be proper, accessible file: based directory, it is passed to this creation method and base can be safely ignored

base - According to HttpService and Whiteboard specifications, this is the base location for resource fetching. By default this base is prepended to a path and (combined) used as argument to HttpContext.getResource(String) or ServletContextHelper.getResource(String). It should not end with slash (/) and can be an empty string (meaning root of the bundle).

Returns: