org.ptolemy.ptango.lib

Interface HttpService

All Known Implementing Classes:

HttpActor

public interface HttpService

An interface for actors that handle HTTP requests. The interface allows the relative path for the HTTP request to be set and obtained, and provides a servlet to handle requests. If this interface is implemented by an actor or attribute in a model that contains an instance of WebServer, then requests to that server that match the relative path set by the setRelativePath(URI) method of this interface will be delegated to that actor or attribute.

Note that "HttpService" is also the name of an OSGi interface. If OSGi is incorporated in Ptolemy in the future, we might want to rename this interface. See /home/hudson/jobs/kepler/workspace/ptolemy/src/com/microstar/xml/demo/XmlApp.java.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Elizabeth Latronico and Edward A. Lee

See Also:

WebServer, WebServer

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

Method Summary

Modifier and Type	Method and Description
java.net.URI	getRelativePath() Returns the relative path that this HttpService is mapped to, which is the value set previously by a call to setRelativePath(URI).
javax.servlet.http.HttpServlet	getServlet() Returns an HttpServlet which is used to handle requests that arrive at the given relative path.
void	setRelativePath(java.net.URI relativePath) Set the relative path that this HttpService is mapped to.
void	setWebServer(WebServer server) Specify the web server for this service.

Method Detail

getRelativePath

java.net.URI getRelativePath()

Returns the relative path that this HttpService is mapped to, which is the value set previously by a call to setRelativePath(URI).

Returns:

The relative path that this HttpService is mapped to.

See Also:

setRelativePath(URI)

getServlet

javax.servlet.http.HttpServlet getServlet()

Returns an HttpServlet which is used to handle requests that arrive at the given relative path.

Returns:

An HttpServlet to handle requests.

setRelativePath

void setRelativePath(java.net.URI relativePath)

Set the relative path that this HttpService is mapped to.

Parameters:

relativePath - The relative path that this HttpService is mapped to.

See Also:

getRelativePath()

setWebServer

void setWebServer(WebServer server)

Specify the web server for this service. This will be called by the WebServer attribute of a model, if there is one, and will enable the service to access information about the web server (such as the resourcePath, resourceLocation, or temporaryFileLocation).

Parameters:

server - The WebServer for this service