de.aristaflow.adept2.ui.htmlgui.httpservice

Class EmbdServContHTTPService

java.lang.Object

AbstractAuthenticatedService

de.aristaflow.adept2.ui.htmlgui.httpservice.EmbdServContHTTPService

All Implemented Interfaces:

HTTPService

public class EmbdServContHTTPService
extends AbstractAuthenticatedService
implements HTTPService

Simple HTTP service based on a ServletService (an embedded servlet container). This delegates to the AristaFlowHTTPService-servlet implementingdoGet and doPost-methods.

Author:

Kevin Goeser, Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected AristaFlowHTTPService	httpService The HTTP service (servlet) handling the requests.
protected static java.lang.String	WEB_APP_CONTEXT The hierarchical context of the servlet.
protected static java.lang.String	WEB_APP_NAME The name used for the publishing the servlet, that is as servlet name.

Constructor Summary

Constructors

Constructor and Description
EmbdServContHTTPService(Configuration configuration, Registry registry) Registers the HTTP-service-servlet at an embedded servlet container.

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.
boolean	isActive() Allows waiting reply handlers to retrieve the state of the HTTP-service.
void	registerReplyHandler(SessionToken session, java.lang.String sessionID, HTTPReplyHandler replayHandler) Registers a reply handler for the activity with the designated sessionID.
void	shutdown(boolean emergency) Removes the HTTP-service-servlet from the ServletService.
void	start() Adds the HTTP-service-servlet to the ServletService.

Methods inherited from class java.lang.Object

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

Field Detail

WEB_APP_NAME

protected static final java.lang.String WEB_APP_NAME

The name used for the publishing the servlet, that is as servlet name.

See Also:

Constant Field Values

WEB_APP_CONTEXT

protected static final java.lang.String WEB_APP_CONTEXT

The hierarchical context of the servlet.

See Also:

Constant Field Values

httpService

protected final AristaFlowHTTPService httpService

The HTTP service (servlet) handling the requests.

Constructor Detail

EmbdServContHTTPService

public EmbdServContHTTPService(Configuration configuration,
                               Registry registry)
                        throws ConfigurationException

Registers the HTTP-service-servlet at an embedded servlet container.

Parameters:

configuration - The configuration providing the user credentials for this service.

registry - The registry for accessing the servlet services.

Throws:

ConfigurationException - If there are problems parsing the user credentials from the configuration, a ConfigurationException will be thrown.

Method Detail

registerReplyHandler

public void registerReplyHandler(SessionToken session,
                                 java.lang.String sessionID,
                                 HTTPReplyHandler replayHandler)
                          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.

replayHandler - 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.

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.

start

public void start()
           throws AbortServiceException

Adds the HTTP-service-servlet to the ServletService.

Throws:

AbortServiceException - If the base URL (servlet URL having the URL-pattern appended) cannot be created, an AbortServiceException will be thrown.

ServiceNotKnownException - If the servlet container cannot be retrieved from the registry, a ServiceNotKnownException will be thrown.

shutdown

public void shutdown(boolean emergency)

Removes the HTTP-service-servlet from the ServletService.

isActive

public boolean isActive()

Allows waiting reply handlers to retrieve the state of the HTTP-service. Please note that this method blocks when starting until the service is started.