de.aristaflow.adept2.ui.htmlgui.httpservice

Class AristaFlowHTTPService

java.lang.Object

javax.servlet.http.HttpServlet

de.aristaflow.adept2.ui.htmlgui.httpservice.AristaFlowHTTPService

All Implemented Interfaces:

HTTPService

public class AristaFlowHTTPService
extends javax.servlet.http.HttpServlet
implements HTTPService

Servlet implementation for the HTTP service of the HTML context.

Author:

Kevin Goeser

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger My logger.
protected java.util.Map<java.lang.String,HTTPReplyHandler>	replyHandlers The reply handlers to which HTTP-requests are forwarded after the decoding.
protected java.lang.String	servletName The name of the servlet if dynamically deployed, null otherwise.
protected java.util.Map<java.util.UUID,java.lang.String>	sessions Own session IDs.

Constructor Summary

Constructors

Constructor and Description
AristaFlowHTTPService() Constructor for initialisation via Extension Point (must not have any parameters).
AristaFlowHTTPService(java.lang.String servletName) Constructor providing a servlet name for dynamic servlet deployment.

Method Summary

Modifier and Type	Method and Description
void	deregisterReplyHandler(SessionToken session, java.lang.String sessionID) Deregisters a reply handler for the activity with the designated sessionID.
protected void	doGet(HttpServletRequest request, HttpServletResponse response)
protected void	doPost(HttpServletRequest request, HttpServletResponse response)
protected java.util.List<java.lang.String>	getListValue(java.lang.Object o) Returns the string list value for the given object, or null if the object is not a representation of a list-valued string value.
java.net.URI[]	getLocalUris()
protected void	getParameterAttachments(java.util.List<FileItem> items, java.util.Map<java.lang.String,HTMLContext.Attachment> attachments, java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> attachmentLists) Fills attachments and attachmentLists with the attachment parameters and the list-valued attachment parameters.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterLists(HttpServletRequest request) Retrieves all list-valued parameters from the request and returns them as map.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterLists(java.util.List<FileItem> items) Returns all list valued string parameters.
protected java.util.Map<java.lang.String,java.lang.String>	getParameters(HttpServletRequest request) Retrieves all non-list-valued and non-attachment parameters from the request and returns them as map.
protected java.util.Map<java.lang.String,java.lang.String>	getParameters(java.util.List<FileItem> items) Returns all non-list-valued string parameters.
<any>	getRelease() This service is started outside of the platform and therefore does not support the methods of ADEPT2Service.
java.lang.String[]	getRuntimeRequiredServices()
<any>	getServiceInstanceName() This service is started outside of the platform and therefore does not support the methods of ADEPT2Service.
java.lang.String	getServletName()
java.lang.String[]	getStartupRequiredServices()
protected java.lang.String	getStringValue(java.lang.Object o) Returns the string value for the given object, or null if the object is not a representation of a (non-list-valued) string value.
java.net.URI[]	getURIs()
void	init(java.net.URI[] localExportedUris, java.net.URI[] globalExportedUris) Not forwarded since no client component should control the service.
long	ping()
void	preShutdown(boolean emergency) Not forwarded since no client component should control the service.
void	registerReplyHandler(SessionToken session, java.lang.String sessionID, HTTPReplyHandler replyHandler) Registers a reply handler for the activity with the designated sessionID.
void	servletDeployed(ServletContext context, java.lang.String urlPattern)
void	servletUndeployed(ServletContext context)
void	setURL(java.net.URL myURL) Set the URL to be used for the HTML contexts.
void	shutdown(boolean emergency) Not forwarded since no client component should control the service.
void	start() Not forwarded since no client component should control the service.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient java.util.logging.Logger logger

My logger.

replyHandlers

protected final java.util.Map<java.lang.String,HTTPReplyHandler> replyHandlers

The reply handlers to which HTTP-requests are forwarded after the decoding. This maps the session ID to the corresponding reply handler-instance.

sessions

protected final java.util.Map<java.util.UUID,java.lang.String> sessions

Own session IDs.

servletName

protected java.lang.String servletName

The name of the servlet if dynamically deployed, null otherwise.

Constructor Detail

AristaFlowHTTPService

public AristaFlowHTTPService()

Constructor for initialisation via Extension Point (must not have any parameters).

AristaFlowHTTPService

public AristaFlowHTTPService(java.lang.String servletName)

Constructor providing a servlet name for dynamic servlet deployment.

Parameters:

servletName - The name of the servlet if dynamically deployed, null otherwise.

Method Detail

setURL

public void setURL(java.net.URL myURL)

Set the URL to be used for the HTML contexts.

Parameters:

myURL -

doGet

protected void doGet(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException,
                     java.io.IOException

Throws:

ServletException

java.io.IOException

doPost

protected void doPost(HttpServletRequest request,
                      HttpServletResponse response)
               throws ServletException,
                      java.io.IOException

Throws:

ServletException

java.io.IOException

deregisterReplyHandler

public void deregisterReplyHandler(SessionToken session,
                                   java.lang.String sessionID)

Description copied from interface: HTTPService

Deregisters a reply handler for the activity with the designated sessionID. A reply handler may be deregistered any time. In case a reply handling is currently running, it will be allowed to finish.

Specified by:

deregisterReplyHandler in interface HTTPService

Parameters:

session - The session which is used to check for access rights on this method.

sessionID - The session ID identifying the executed activity and therefore also the handler for the reply sent via HTTP.

registerReplyHandler

public void registerReplyHandler(SessionToken session,
                                 java.lang.String sessionID,
                                 HTTPReplyHandler replyHandler)
                          throws java.net.MalformedURLException

Description copied from interface: HTTPService

Registers a reply handler for the activity with the designated sessionID. This creates an own URL for the reply handler. It will be called as soon as a HTTP-request (the reply for the activity) is received by this HTTP-service.

Specified by:

registerReplyHandler in interface HTTPService

Parameters:

session - The session which is used to check for access rights on this method.

sessionID - The session ID for the executed activity. It is used to create an appropriate URL.

replyHandler - The handler for the HTTP-replies sent to this service.

Throws:

java.net.MalformedURLException - If the designated sessionID does not allow to create a valid URL, a MalformedURLException will be thrown.

getParameters

protected java.util.Map<java.lang.String,java.lang.String> getParameters(HttpServletRequest request)

Retrieves all non-list-valued and non-attachment parameters from the request and returns them as map.

Parameters:

request -

Returns:

The parameters as map from name to parameter value.

getParameterLists

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameterLists(HttpServletRequest request)

Retrieves all list-valued parameters from the request and returns them as map.

Parameters:

request -

Returns:

The parameters as map from name to list of parameter values.

getParameters

protected java.util.Map<java.lang.String,java.lang.String> getParameters(java.util.List<FileItem> items)

Returns all non-list-valued string parameters.

Parameters:

items -

Returns:

All string parameters.

getParameterLists

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameterLists(java.util.List<FileItem> items)

Returns all list valued string parameters.

Parameters:

items -

Returns:

All list valued string parameters.

getParameterAttachments

protected void getParameterAttachments(java.util.List<FileItem> items,
                                       java.util.Map<java.lang.String,HTMLContext.Attachment> attachments,
                                       java.util.Map<java.lang.String,java.util.List<HTMLContext.Attachment>> attachmentLists)

Fills attachments and attachmentLists with the attachment parameters and the list-valued attachment parameters.

Parameters:

items -

attachments -

attachmentLists -

getStringValue

protected java.lang.String getStringValue(java.lang.Object o)

Returns the string value for the given object, or null if the object is not a representation of a (non-list-valued) string value.

Parameters:

o -

Returns:

The string for the given object, or null if not applicable

getListValue

protected java.util.List<java.lang.String> getListValue(java.lang.Object o)

Returns the string list value for the given object, or null if the object is not a representation of a list-valued string value.

Parameters:

o -

Returns:

The string list for the given object, or null if not applicable

ping

public long ping()

getRelease

public <any> getRelease()

This service is started outside of the platform and therefore does not support the methods of ADEPT2Service.

Returns:

<unknown> for all elements of the triple.

getServiceInstanceName

public <any> getServiceInstanceName()

This service is started outside of the platform and therefore does not support the methods of ADEPT2Service.

Returns:

null for the cluster name, <unknown> for the other elements of the triple.

getStartupRequiredServices

public java.lang.String[] getStartupRequiredServices()

getRuntimeRequiredServices

public java.lang.String[] getRuntimeRequiredServices()

getLocalUris

public java.net.URI[] getLocalUris()

getURIs

public java.net.URI[] getURIs()

init

public void init(java.net.URI[] localExportedUris,
                 java.net.URI[] globalExportedUris)
          throws AbortServiceException

Not forwarded since no client component should control the service.

Throws:

AbortServiceException

start

public void start()

Not forwarded since no client component should control the service.

preShutdown

public void preShutdown(boolean emergency)

Not forwarded since no client component should control the service.

shutdown

public void shutdown(boolean emergency)

Not forwarded since no client component should control the service.

getServletName

public java.lang.String getServletName()

servletDeployed

public void servletDeployed(ServletContext context,
                            java.lang.String urlPattern)

servletUndeployed

public void servletUndeployed(ServletContext context)