org.ptolemy.ptango.lib.http

Class WebServerUtilities

java.lang.Object

org.ptolemy.ptango.lib.http.WebServerUtilities

public class WebServerUtilities
extends java.lang.Object

A web server and information about the applications registered to it. Used by WebServerManager

Since:

Ptolemy II 10.0

Version:

$Id: WebServerUtilities.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Elizabeth Latronico and Edward A. Lee

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.eclipse.jetty.server.nio.SelectChannelConnector	_selectChannelConnector The connector binding a port to the server.
(package private) static int	DEFAULT_MAX_IDLE_TIME Use 30 seconds (30000 milliseconds) as the default time the server will wait before returning a timeout response page.
(package private) static int	DEFAULT_PORT_NUMBER Use 8078 as the default port number that the server listens to for incoming requests.

Constructor Summary

Constructors

Constructor and Description
WebServerUtilities() Construct a new instance of this class with the default port number and maximum idle time.
WebServerUtilities(int portNumber) Construct a new instance of this class with the specified port number.
WebServerUtilities(int portNumber, int maxIdleTime) Construct a new instance of this class with the specified port number and maximum idle time.

Method Summary

Modifier and Type	Method and Description
protected void	_createResourceHandlers(WebApplicationInfo appInfo) Create or re-use resource handler(s) to serve files such as images, audio, etc.
protected void	_createServletHandler(WebApplicationInfo appInfo) Create a ContextHandler to store all of the servlets defined in the given application (e.g. a Ptolemy model).
boolean	getDynamicPortSelection() Return true if dynamic port selection is permitted; false otherwise
int	getMaxIdleTime() Return the maximum amount of time the server will wait before returning a timeout response page.
int	getPortNumber() Return the port number that the server listens to for requests.
boolean	isHostingModel(java.lang.String fullModelName) Return true if this web server is hosting the given model; false otherwise.
boolean	isRunning() Return true if the web server is running; false otherwise.
void	register(WebApplicationInfo appInfo) Register the following application on this server.
void	setDynamicPortSelection(boolean dynamicPortSelection) Set a flag indicating if dynamic port selection is permitted.
void	setMaxIdleTime(int maxIdleTime) Set the maximum amount of time, in milliseconds, that the server will wait before returning a timeout response page.
void	unregister(WebApplicationInfo appInfo) Unregister the given application from this server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT_NUMBER

static final int DEFAULT_PORT_NUMBER

Use 8078 as the default port number that the server listens to for incoming requests.

See Also:

Constant Field Values

DEFAULT_MAX_IDLE_TIME

static final int DEFAULT_MAX_IDLE_TIME

Use 30 seconds (30000 milliseconds) as the default time the server will wait before returning a timeout response page.

See Also:

Constant Field Values

_selectChannelConnector

org.eclipse.jetty.server.nio.SelectChannelConnector _selectChannelConnector

The connector binding a port to the server.

Constructor Detail

WebServerUtilities

public WebServerUtilities()

Construct a new instance of this class with the default port number and maximum idle time.

WebServerUtilities

public WebServerUtilities(int portNumber)

Construct a new instance of this class with the specified port number.

Parameters:

portNumber - The port number the web server receives requests on

WebServerUtilities

public WebServerUtilities(int portNumber,
                          int maxIdleTime)

Construct a new instance of this class with the specified port number and maximum idle time.

Parameters:

portNumber - The port number the web server receives requests on

maxIdleTime - The maximum amount of time the web server will wait before sending a timeout response page

Method Detail

getDynamicPortSelection

public boolean getDynamicPortSelection()

Return true if dynamic port selection is permitted; false otherwise

Returns:

True if dynamic port selection is permitted; false otherwise

See Also:

setDynamicPortSelection(boolean)

getMaxIdleTime

public int getMaxIdleTime()

Return the maximum amount of time the server will wait before returning a timeout response page.

Returns:

The maximum amount of time the server will wait before returning a timeout response page.

See Also:

setMaxIdleTime(int)

getPortNumber

public int getPortNumber()

Return the port number that the server listens to for requests. Note that the port number is only settable in the constructor - there is no setPortNumber() method - since web applications ask for a specific port number and changing the port number will cause client requests to the old port number to fail.

Returns:

The port number that the server listens to for requests.

isHostingModel

public boolean isHostingModel(java.lang.String fullModelName)

Return true if this web server is hosting the given model; false otherwise. The full model name should be provided.

Parameters:

fullModelName - The full name of the model to search for

Returns:

true if the web server is hosting the given model; false otherwise

isRunning

public boolean isRunning()

Return true if the web server is running; false otherwise.

Returns:

true if the web server is running; false otherwise

register

public void register(WebApplicationInfo appInfo)
              throws java.lang.Exception

Register the following application on this server. Start the server if it has not already been started. Throw an exception if the new application conflicts with existing applications, for example, by requesting the same URL mapping.

Parameters:

appInfo - The application to add to this server

Throws:

java.lang.Exception - If the new application conflicts with existing applications, for example, by requesting the same URL mapping.

setDynamicPortSelection

public void setDynamicPortSelection(boolean dynamicPortSelection)

Set a flag indicating if dynamic port selection is permitted.

Parameters:

dynamicPortSelection - True if dynamic port selection is permitted; false otherwise

See Also:

getDynamicPortSelection()

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTime)

Set the maximum amount of time, in milliseconds, that the server will wait before returning a timeout response page.

Parameters:

maxIdleTime - The maximum amount of time, in milliseconds, that the server will wait before returning a timeout response page

See Also:

getMaxIdleTime()

unregister

public void unregister(WebApplicationInfo appInfo)
                throws java.lang.Exception

Unregister the given application from this server. If this leaves no applications on the server, stop the server.

Parameters:

appInfo - The application to remove from the server.

Throws:

java.lang.Exception - if the application is not registered with this server or if the server cannot be stopped when the last application is unregistered

_createServletHandler

protected void _createServletHandler(WebApplicationInfo appInfo)
                              throws java.lang.Exception

Create a ContextHandler to store all of the servlets defined in the given application (e.g. a Ptolemy model). Add this handler to the collection of handlers for this web server.

Parameters:

appInfo - Information about the web application.

Throws:

java.lang.Exception - If the servlet cannot be started on the server

_createResourceHandlers

protected void _createResourceHandlers(WebApplicationInfo appInfo)
                                throws java.lang.Exception

Create or re-use resource handler(s) to serve files such as images, audio, etc. If the application requests a handler for a path that is already used by an existing resource handler, then the existing handler will be re-used, and the new search locations will be added to its search list. If a new path is provided, a new resource handler will be created, as long as at least one search location is given. New handlers are added to the _handlers list.

Parameters:

appInfo - An object containing information needed to register the new application

Throws:

java.lang.Exception - If a FileParameter is found that is not a valid URI or references a resource that cannot be found, or if the handler cannot be started on the server