de.aristaflow.adept2.ui.htmlgui.httpservice

Interface HTTPService

All Known Implementing Classes:

AristaFlowHTTPService, EmbdServContHTTPService, NullHTTPService

public interface HTTPService

A HTTPService provides the means to register and deregister handlers for replies for an activity sent via HTTP. This allows HTML-/HTTP-based activities to get all replies via a single web server that accepts the replies (normal HTTP-requests), forwards them to the corresponding activities (handlers) and sends appropriate HTTP-responses back to the clients.

Author:

Ulrich Kreher

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.
void	registerReplyHandler(SessionToken session, java.lang.String sessionID, HTTPReplyHandler replyHandler) Registers a reply handler for the activity with the designated sessionID.

Method Detail

registerReplyHandler

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

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.

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.

deregisterReplyHandler

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

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.

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.