org.ptolemy.ptango.lib

Class WebApplicationInfo

java.lang.Object

org.ptolemy.ptango.lib.WebApplicationInfo

public class WebApplicationInfo
extends java.lang.Object

Information for a web application running on a web server. Used by WebServerUtilities

Since:

Ptolemy II 10.0

Version:

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

Author:

Elizabeth Latronico and Edward A. Lee

Accepted Rating:

Red (ltrnc)

Proposed Rating:

Red (ltrnc)

Constructor Summary

Constructors

Constructor and Description
WebApplicationInfo(java.lang.String modelName, java.lang.String applicationPath, FileParameter temporaryFileLocation) Construct a new instance of this class with the given model name, an application path, and a temporary file location.

Method Summary

Modifier and Type	Method and Description
void	addResourceInfo(java.net.URI path, java.util.Set<org.eclipse.jetty.util.resource.Resource> resourceLocations) Add a new resource path and location set for this web application.
void	addServletInfo(java.net.URI path, javax.servlet.Servlet servlet) Add a new servlet path to the set of paths of this web application.
void	addSocketInfo(java.net.URI path, Entity entity) Add a new socket path to the set of paths of this web application.
java.net.URI	getApplicationPath() Get the base path of this web application.
java.lang.String	getModelName() Get the full model name of the model that is running the web application.
java.util.HashMap<java.net.URI,java.util.HashSet<org.eclipse.jetty.util.resource.Resource>>	getResourceInfo() Get the set of resource paths and their associated locations.
java.util.HashMap<java.net.URI,javax.servlet.Servlet>	getServletInfo() Get the set of servlet paths assigned to this web application and their corresponding servlets.
FileParameter	getTemporaryFileLocation() Get the location where temporary files should be stored.
java.util.HashMap<java.net.URI,java.util.HashSet<Entity>>	getWebSocketInfo() Get the set of socket paths assigned to this web application and their corresponding sets of actors.
boolean	hasPath(java.lang.String path) Returns true if the web application has already mapped a handler to the given URL; returns false otherwise.
boolean	hasPath(java.net.URI path) Returns true if the web application has already mapped a handler to the given URL; returns false otherwise.
boolean	hasResourcePath(java.lang.String path) Returns true if the web application has already mapped a resource handler to the given path.
void	setApplicationPath(java.net.URI applicationPath) Set the base path of this application.
void	setModelName(java.lang.String modelName) Record the full model name from the model that is running the web application.
void	setTemporaryFileLocation(FileParameter temporaryFileLocation) Set the location where temporary files should be stored.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApplicationInfo

public WebApplicationInfo(java.lang.String modelName,
                          java.lang.String applicationPath,
                          FileParameter temporaryFileLocation)
                   throws java.lang.Exception

Construct a new instance of this class with the given model name, an application path, and a temporary file location.

Parameters:

modelName - The full name of the model

applicationPath - The base path for the application

temporaryFileLocation - The directory where temporary files are stored

Throws:

java.lang.Exception - If the model does not yet have a name (for example, a new unsaved model)

Method Detail

addServletInfo

public void addServletInfo(java.net.URI path,
                           javax.servlet.Servlet servlet)
                    throws java.lang.Exception

Add a new servlet path to the set of paths of this web application. Null, empty or duplicate paths are not allowed. Return true if the path was added successfully, or false if the path was null, empty or a duplicate

Parameters:

path - The new servlet path to add

servlet - The servlet to associated with the servlet path

Throws:

java.lang.Exception - If the path has already been requested by another servlet

addSocketInfo

public void addSocketInfo(java.net.URI path,
                          Entity entity)
                   throws java.lang.Exception

Add a new socket path to the set of paths of this web application. Null or empty paths are not allowed. New path is not allowed if already claimed by a servlet or resource. Return true if the path was added successfully; false otherwise

Parameters:

path - The new socket path to add

entity - The entity (multiple allowed) associated with this socket path

Throws:

java.lang.Exception - If the path has already been requested by a servlet or resource

addResourceInfo

public void addResourceInfo(java.net.URI path,
                            java.util.Set<org.eclipse.jetty.util.resource.Resource> resourceLocations)
                     throws java.lang.Exception

Add a new resource path and location set for this web application. A null path is not allowed. An empty path is OK (since apps may share a resource handler, it can make sense to map the handler to the root path). If the path is a duplicate of a path already assigned to a resource handler, the resource location list for that path will be updated. The path may not be a duplicate of a path already assigned to a context handler. There should be at least one resource location.

Parameters:

path - The new resource path to add. May not be null.

resourceLocations - The non-empty set of resource locations to add

Throws:

java.lang.Exception - If this path is a duplicate of a path already requested by a servlet, or if the resource does not exist

getApplicationPath

public java.net.URI getApplicationPath()

Get the base path of this web application.

Returns:

The base path of this web application

See Also:

setApplicationPath(URI)

getModelName

public java.lang.String getModelName()

Get the full model name of the model that is running the web application.

Returns:

The full model name of the model that is running the web application

See Also:

setModelName(String)

getServletInfo

public java.util.HashMap<java.net.URI,javax.servlet.Servlet> getServletInfo()

Get the set of servlet paths assigned to this web application and their corresponding servlets. May be empty.

Returns:

The set of servlet paths assigned to this web application and their corresponding servlets. May be empty.

getResourceInfo

public java.util.HashMap<java.net.URI,java.util.HashSet<org.eclipse.jetty.util.resource.Resource>> getResourceInfo()

Get the set of resource paths and their associated locations.

Returns:

The set of resource paths and their associated locations

getWebSocketInfo

public java.util.HashMap<java.net.URI,java.util.HashSet<Entity>> getWebSocketInfo()

Get the set of socket paths assigned to this web application and their corresponding sets of actors. May be empty.

Returns:

the set of socket paths assigned to this web application and their corresponding sets of actors. May be empty.

getTemporaryFileLocation

public FileParameter getTemporaryFileLocation()

Get the location where temporary files should be stored. May be empty or null if the web application does not use temporary files.

Returns:

The location where temporary files should be stored. May be empty or null if the web application does not use temporary files

See Also:

setTemporaryFileLocation(FileParameter)

hasPath

public boolean hasPath(java.lang.String path)

Returns true if the web application has already mapped a handler to the given URL; returns false otherwise. The handler can be any handler - for example, a ContextHandler or a ResourceHandler. This check is purposefully NOT case-sensitive. While URLs are case-sensitive (excluding the domain name), many users are not aware of this, and it would be confusing to have two URLs that differ only in case. The application path should be included as part of this URL, e.g. /webapp/start for service /start of application /webapp

Parameters:

path - The URL to check for existing mappings

Returns:

True if the web application has already mapped a handler to the given URL; false otherwise

hasPath

public boolean hasPath(java.net.URI path)

Returns true if the web application has already mapped a handler to the given URL; returns false otherwise. See hasPath(String path)

Parameters:

path - The URL to check for existing mappings

Returns:

True if the web application has already mapped a handler to the given URL; false otherwise

hasResourcePath

public boolean hasResourcePath(java.lang.String path)

Returns true if the web application has already mapped a resource handler to the given path. Used by the web server to determine if a new resource handler is needed or if an existing one can be re-used.

Parameters:

path - The URL to check for existing mappings to a resource handler

Returns:

True if the web application has already mapped a resource handler to the given URL

setApplicationPath

public void setApplicationPath(java.net.URI applicationPath)

Set the base path of this application.

Parameters:

applicationPath - The new base path to this application

See Also:

getApplicationPath()

setModelName

public void setModelName(java.lang.String modelName)

Record the full model name from the model that is running the web application.

Parameters:

modelName - The full model name of the model that is running the web application

See Also:

getModelName()

setTemporaryFileLocation

public void setTemporaryFileLocation(FileParameter temporaryFileLocation)

Set the location where temporary files should be stored. May be null if the web application does not use temporary files.

Parameters:

temporaryFileLocation - The location where temporary files should be stored. May be null if the web application does not use temporary files

See Also:

getTemporaryFileLocation()