Package org.intermine.webservice.server.template

Class TemplateUploadService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.template.TemplateUploadService

public class TemplateUploadService
extends WebService

A service to enable templates to be uploaded.

Author:

Alexis Kalderimis

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TEMPLATES_PARAMETER	The key for the templates parameter
static java.lang.String	VERSION_PARAMETER	The key for the version parameter

Fields inherited from class org.intermine.webservice.server.WebService

dataPackageOutput, DEFAULT_CALLBACK, im, os, out, output, request, response, webProperties

Constructor Summary

Constructors

Constructor	Description
TemplateUploadService(InterMineAPI im)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	canServe(Format format)	Check whether the format is acceptable.
protected void	execute()	Runs service.
protected void	validateState()	Subclasses can put initialisation checks here.

Methods inherited from class org.intermine.webservice.server.WebService

cleanUp, formatIsFlatFile, formatIsJSON, formatIsJSONP, formatIsXML, getAuthenticatedUser, getCallback, getColumnHeaderStyle, getDefaultFileName, getDefaultFormat, getDefaultOutput, getDefaultOutput, getExtension, getFormat, getIntParameter, getIntParameter, getLineBreak, getListManager, getOptionalParameter, getOptionalParameter, getPermission, getProperty, getRawOutput, getRequestFileName, getRequiredParameter, hasCallback, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, postInit, service, setFormat, setNameSpace, wantsColumnHeaders, wantsDataPackage

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATES_PARAMETER

public static final java.lang.String TEMPLATES_PARAMETER

The key for the templates parameter

See Also:

Constant Field Values

VERSION_PARAMETER

public static final java.lang.String VERSION_PARAMETER

The key for the version parameter

See Also:

Constant Field Values

Constructor Detail

TemplateUploadService

public TemplateUploadService(InterMineAPI im)

Constructor.

Parameters:

im - A reference to the API configuration and settings bundle.

Method Detail

validateState

protected void validateState()

Description copied from class: WebService

Subclasses can put initialisation checks here. The main use case is for confirming authentication.

Overrides:

validateState in class WebService

canServe

protected boolean canServe(Format format)

Description copied from class: WebService

Check whether the format is acceptable. By default returns true. Services with a particular set of accepted formats should override this and check.

Overrides:

canServe in class WebService

Parameters:

format - The format to check.

Returns:

whether or not this format is acceptable.

execute

protected void execute()
                throws java.lang.Exception

Description copied from class: WebService

Runs service. This is abstract method, that must be defined in subclasses and so performs something useful. Standard procedure is overwrite this method in subclasses and let this method to be called from WebService.doGet method that encapsulates logic common for all web services else you can overwrite doGet method in your web service class and manage all the things alone.

Specified by:

execute in class WebService

Throws:

java.lang.Exception - if some error occurs