org.arl.fjage.connectors

Class WebServer

java.lang.Object

org.arl.fjage.connectors.WebServer

public class WebServer
extends java.lang.Object

Web server instance manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebServer.WebServerOptions Builder style class for configuring web server options.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE
protected org.eclipse.jetty.server.handler.ContextHandlerCollection	contexts
static java.lang.String	NOCACHE
protected int	port
protected org.eclipse.jetty.rewrite.handler.RewriteHandler	rewrite
protected org.eclipse.jetty.server.Server	server
protected boolean	started

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebServer(int port)
protected	WebServer(int port, java.lang.String ip) Creates a new web server instance.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jetty.server.handler.ContextHandler	addHandler(java.lang.String context, org.eclipse.jetty.server.handler.AbstractHandler handler) Add a handler to the server at the specified context.
boolean	addRule(org.eclipse.jetty.rewrite.handler.Rule rule) Adds a rule to rewrite handler.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.io.File dir) Adds a context to serve static documents.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.io.File dir, java.lang.String cacheControl) Adds a context to serve static documents.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.io.File dir, WebServer.WebServerOptions options) Adds a context to serve static documents.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.lang.String resource) Adds a context to serve static documents.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.lang.String resource, java.lang.String cacheControl) Adds a context to serve static documents.
java.util.List<org.eclipse.jetty.server.handler.ContextHandler>	addStatic(java.lang.String context, java.lang.String resource, WebServer.WebServerOptions options) Adds a context to serve static documents.
boolean	addUpload(java.lang.String context, java.io.File dir) Adds a context to upload files to.
boolean	addUpload(java.lang.String context, java.io.File dir, long maxFileSize, long maxRequestSize, int fileSizeThreshold) Adds a context to upload files to.
static WebServer	getInstance(int port) Gets an instance of a web server running on the specified port.
static WebServer	getInstance(int port, java.lang.String ip) Gets an instance of a web server running on the specified port.
static WebServer[]	getInstances() Gets all web server instances running.
int	getPort() Gets the port number that the web server is running on.
boolean	hasHandler(java.lang.String context) Checks if a handler is already registered for the specified context.
static boolean	hasInstance(int port) Checks if an instance of a web server is running on the specified port.
boolean	hasStatic(java.lang.String context) Checks is there's already a context serving static documents.
boolean	removeHandler(org.eclipse.jetty.server.handler.ContextHandler handler) Removes a ContextHandler from the server.
boolean	removeStatic(org.eclipse.jetty.server.handler.ContextHandler handler) Removes a context serving static documents.
static void	shutdown() Shutdown all web servers.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Field Detail

NOCACHE

public static final java.lang.String NOCACHE

See Also:

Constant Field Values

CACHE

public static final java.lang.String CACHE

See Also:

Constant Field Values

server

protected org.eclipse.jetty.server.Server server

contexts

protected org.eclipse.jetty.server.handler.ContextHandlerCollection contexts

rewrite

protected org.eclipse.jetty.rewrite.handler.RewriteHandler rewrite

started

protected boolean started

port

protected int port

Constructor Detail

WebServer

protected WebServer(int port)

WebServer

protected WebServer(int port,
                    java.lang.String ip)

Creates a new web server instance.
The Jetty based WebServer has a set of handlers that are initialized and more handlers can be added to it. The handler stack setup is

GzipHandler -> RewriteHandler -> ContextHandlerCollection[ contexts[] , DefaultHandler]

Any new handlers added to the server will be added to the list of ContextHandlers (contexts).

Parameters:

port - HTTP port number.

ip - IP address to bind HTTP server to.

Method Detail

getInstance

public static WebServer getInstance(int port)

Gets an instance of a web server running on the specified port. If an instance is not already available, a new one is created.

Parameters:

port - HTTP port number.

getInstance

public static WebServer getInstance(int port,
                                    java.lang.String ip)

Gets an instance of a web server running on the specified port. If an instance is not already available, a new one is created.

Parameters:

port - HTTP port number.

ip - IP address to bind HTTP server to.

hasInstance

public static boolean hasInstance(int port)

Checks if an instance of a web server is running on the specified port.

Parameters:

port - HTTP port number.

Returns:

true if running, false otherwise.

getInstances

public static WebServer[] getInstances()

Gets all web server instances running.

Returns:

array of web server instances.

shutdown

public static void shutdown()

Shutdown all web servers.

getPort

public int getPort()

Gets the port number that the web server is running on.

Returns:

TCP port number.

start

public void start()

Starts the web server.

stop

public void stop()

Stops the web server. Once this method is called, the server cannot be restarted.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.lang.String resource,
                                                                                 WebServer.WebServerOptions options)

Adds a context to serve static documents.

Parameters:

context - context path.

resource - resource path.

options - WebServerOptions object.

Returns:

a List of ContextHandler objects if added.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.lang.String resource,
                                                                                 java.lang.String cacheControl)

Adds a context to serve static documents.

Parameters:

context - context path.

resource - resource path.

cacheControl - cache control header.

Returns:

a List of ContextHandler objects if added.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.lang.String resource)

Adds a context to serve static documents.

Parameters:

context - context path.

resource - resource path.

Returns:

a List of ContextHandler objects if added.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.io.File dir,
                                                                                 WebServer.WebServerOptions options)

Adds a context to serve static documents.

Parameters:

context - context path.

dir - filesystem path of directory to serve files from.

options - WebServerOptions object.

Returns:

a List of ContextHandler objects if added.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.io.File dir,
                                                                                 java.lang.String cacheControl)

Adds a context to serve static documents.

Parameters:

context - context path.

dir - filesystem path of directory to serve files from.

cacheControl - cache control header.

Returns:

ContextHandler object if added, null otherwise.

addStatic

public java.util.List<org.eclipse.jetty.server.handler.ContextHandler> addStatic(java.lang.String context,
                                                                                 java.io.File dir)

Adds a context to serve static documents.

Parameters:

context - context path.

dir - filesystem path of directory to serve files from.

Returns:

ContextHandler object if added, null otherwise.

removeStatic

public boolean removeStatic(org.eclipse.jetty.server.handler.ContextHandler handler)

Removes a context serving static documents.

Parameters:

handler - context handler to remove.

Returns:

true if removed, false otherwise.

hasStatic

public boolean hasStatic(java.lang.String context)

Checks is there's already a context serving static documents.

Parameters:

context - context path.

Returns:

true if configured, false otherwise.

addUpload

public boolean addUpload(java.lang.String context,
                         java.io.File dir)

Adds a context to upload files to.

Parameters:

context - context path.

dir - filesystem path of directory to upload files to.

Returns:

true if added, false otherwise.

addUpload

public boolean addUpload(java.lang.String context,
                         java.io.File dir,
                         long maxFileSize,
                         long maxRequestSize,
                         int fileSizeThreshold)

Adds a context to upload files to.

Parameters:

context - context path.

dir - filesystem path of directory to upload files to.

maxFileSize - maximum size of a file. @see javax.servlet.MultipartConfigElement

maxRequestSize - maximum size of a request. @see javax.servlet.MultipartConfigElement

fileSizeThreshold - size threshold after which files will be written to disk. @see javax.servlet.MultipartConfigElement

Returns:

true if added, false otherwise.

addHandler

public org.eclipse.jetty.server.handler.ContextHandler addHandler(java.lang.String context,
                                                                  org.eclipse.jetty.server.handler.AbstractHandler handler)

Add a handler to the server at the specified context.

Parameters:

context - context path.

handler - handler to add.

Returns:

ContextHandler object if added, null otherwise.

hasHandler

public boolean hasHandler(java.lang.String context)

Checks if a handler is already registered for the specified context.

Parameters:

context - context path.

Returns:

true if a handler is already registered, false otherwise.

removeHandler

public boolean removeHandler(org.eclipse.jetty.server.handler.ContextHandler handler)

Removes a ContextHandler from the server.

Parameters:

handler - handler to remove.

Returns:

true if removed, false otherwise.

addRule

public boolean addRule(org.eclipse.jetty.rewrite.handler.Rule rule)

Adds a rule to rewrite handler.

NOTE: Rules cannot be added after the server is started.

Parameters:

rule - rewrite rule.

Returns:

true if added, false otherwise.