org.dmilne.xjsf

Class Service

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.dmilne.xjsf.Service

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

ListServicesService, UsageService

public abstract class Service
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Service.Example
class	Service.ExampleBuilder
static class	Service.Message
class	Service.ProgressException
static class	Service.ResponseFormat
static class	Service.UsageLimitException

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanParameter	prmHelp
protected EnumParameter<Service.ResponseFormat>	prmResponseFormat
protected StringArrayParameter	prmWikipedia

Constructor Summary

Constructors

Constructor and Description
Service(String groupName, String shortDescription, String detailsMarkup, boolean supportsDirectResponse)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBaseParameter(Parameter param)
void	addExample(Service.Example example)
void	addGlobalParameter(Parameter param)
void	addParameterGroup(ParameterGroup paramGroup)
void	addParamGroup(ParameterGroup group)
void	buildUnwrappedResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
abstract Service.Message	buildWrappedResponse(javax.servlet.http.HttpServletRequest request)
void	destroy()
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getBasePath(javax.servlet.http.HttpServletRequest request)
String	getGroupName()
ServiceHub	getHub()
double	getInitProgress()
String	getShortDescription()
ParameterGroup	getSpecifiedParameterGroup(javax.servlet.http.HttpServletRequest request)
int	getUsageCost(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.ServletConfig config)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

prmResponseFormat

protected EnumParameter<Service.ResponseFormat> prmResponseFormat

prmHelp

protected BooleanParameter prmHelp

prmWikipedia

protected StringArrayParameter prmWikipedia

Constructor Detail

Service

public Service(String groupName,
       String shortDescription,
       String detailsMarkup,
       boolean supportsDirectResponse)

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

addBaseParameter

public void addBaseParameter(Parameter param)

addParamGroup

public void addParamGroup(ParameterGroup group)

addExample

public void addExample(Service.Example example)

getHub

public ServiceHub getHub()

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

IOException

javax.servlet.ServletException

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
           throws IOException,
                  javax.servlet.ServletException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

buildWrappedResponse

public abstract Service.Message buildWrappedResponse(javax.servlet.http.HttpServletRequest request)
                                              throws Exception

Throws:

Exception

buildUnwrappedResponse

public void buildUnwrappedResponse(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                            throws Exception

Throws:

Exception

getInitProgress

public double getInitProgress()

getUsageCost

public int getUsageCost(javax.servlet.http.HttpServletRequest request)

getBasePath

public String getBasePath(javax.servlet.http.HttpServletRequest request)

getGroupName

public String getGroupName()

getShortDescription

public String getShortDescription()

addParameterGroup

public void addParameterGroup(ParameterGroup paramGroup)

addGlobalParameter

public void addGlobalParameter(Parameter param)

getSpecifiedParameterGroup

public ParameterGroup getSpecifiedParameterGroup(javax.servlet.http.HttpServletRequest request)