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.UploadHandler
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
protected org.eclipse.jetty.server.handler.HandlerCollection	handlerCollection
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
protected java.util.Map<java.lang.String,org.eclipse.jetty.server.handler.ContextHandler>	staticContexts

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebServer(int port)
protected	WebServer(int port, java.lang.String ip)

Method Summary

Modifier and Type	Method and Description
void	add(org.eclipse.jetty.server.handler.ContextHandler handler) Adds a context handler to the server.
void	add(java.lang.String context, java.io.File dir) Adds a context to serve static documents.
void	add(java.lang.String context, java.io.File dir, java.lang.String cacheControl) Adds a context to serve static documents.
void	add(java.lang.String context, java.io.File dir, WebServer.WebServerOptions options) Adds a context to serve static documents.
void	add(java.lang.String context, java.lang.String resource) Adds a context to serve static documents.
void	add(java.lang.String context, java.lang.String resource, java.lang.String cacheControl) Adds a context to serve static documents.
void	add(java.lang.String context, java.lang.String resource, WebServer.WebServerOptions options) Adds a context to serve static documents.
void	addRule(org.eclipse.jetty.rewrite.handler.Rule rule) Adds a rule to rewrite handler.
void	addUpload(java.lang.String context, java.io.File dir) Adds a context to upload files to.
void	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	hasContext(java.lang.String context) Checks if a context is already configured to serve documents.
static boolean	hasInstance(int port) Checks if an instance of a web server is running on the specified port.
void	remove(org.eclipse.jetty.server.handler.ContextHandler handler) Removes a context handler.
void	remove(java.lang.String context) 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

staticContexts

protected java.util.Map<java.lang.String,org.eclipse.jetty.server.handler.ContextHandler> staticContexts

handlerCollection

protected org.eclipse.jetty.server.handler.HandlerCollection handlerCollection

started

protected boolean started

port

protected int port

Constructor Detail

WebServer

protected WebServer(int port)

WebServer

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

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.

add

public void add(org.eclipse.jetty.server.handler.ContextHandler handler)

Adds a context handler to the server. Context handler should be added before the web server is started.

Parameters:

handler - context handler.

remove

public void remove(org.eclipse.jetty.server.handler.ContextHandler handler)

Removes a context handler.

Parameters:

handler - context handler to remove.

add

public void add(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.

add

public void add(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.

add

public void add(java.lang.String context,
                java.lang.String resource)

Adds a context to serve static documents.

Parameters:

context - context path.

resource - resource path.

add

public void add(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.

add

public void add(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.

add

public void add(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.

addUpload

public void 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.

addUpload

public void 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

remove

public void remove(java.lang.String context)

Removes a context serving static documents.

Parameters:

context - context path.

hasContext

public boolean hasContext(java.lang.String context)

Checks if a context is already configured to serve documents.

Parameters:

context - context path.

Returns:

true if configured, false otherwise

addRule

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

Adds a rule to rewrite handler.

Parameters:

rule - rewrite rule.