uk.ac.starlink.ttools.server

Interface PlotService

public interface PlotService

Defines a behaviour offered to service an HTTP request relating to a PlotSession.

Since:

29 Sep 2020

Author:

Mark Taylor

Method Summary

Modifier and Type	Method and Description
boolean	canCreateSession() Indicates whether it makes sense to invoke this service for creating a new session, or whether it has to refer to an existing session.
String	getServiceName() Returns the name of the service.
String	getXmlDescription() Returns a user-directed XML description of the invocation syntax and behaviour of this service.
void	sessionRespond(PlotSession<?,?> session, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Responds to an HTTP request relating to a given plot session.

Method Detail

getServiceName

String getServiceName()

Returns the name of the service. This is both a mnemonic user-directed label, and the path element that identifies an HTTP request as referring to this service.

Returns:

short service name

canCreateSession

boolean canCreateSession()

Indicates whether it makes sense to invoke this service for creating a new session, or whether it has to refer to an existing session.

Returns:

iff true, this service can initiate a new session

getXmlDescription

String getXmlDescription()

Returns a user-directed XML description of the invocation syntax and behaviour of this service.

Returns:

P-level XML documentation

sessionRespond

void sessionRespond(PlotSession<?,?> session,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws IOException

Responds to an HTTP request relating to a given plot session.

Parameters:

session - plot session

request - HTTP request supplying action details

response - HTTP response to which output must be written

Throws:

IOException