Package org.intermine.webservice.server

Class VersionService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.VersionService

public class VersionService
extends JSONService

Service for returning the version of this service.

Author:

Alex Kalderimis

Field Summary

Fields inherited from class org.intermine.webservice.server.core.JSONService

bagManager, model

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

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

Constructor Summary

Constructors

Constructor	Description
VersionService(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 Format	getDefaultFormat()
protected java.util.Map<java.lang.String,java.lang.Object>	getHeaderAttributes()	Get the header attributes to apply to the formatter.
protected java.lang.String	getResultsKey()
protected void	initState()	Subclasses can put initialisation here.

Methods inherited from class org.intermine.webservice.server.core.JSONService

addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, lazyList, postInit

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionService

public VersionService(InterMineAPI im)

Constructor

Parameters:

im - The InterMine configuration object.

Method Detail

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

initState

protected void initState()

Description copied from class: WebService

Subclasses can put initialisation here.

Overrides:

initState in class WebService

getHeaderAttributes

protected java.util.Map<java.lang.String,java.lang.Object> getHeaderAttributes()

Description copied from class: JSONService

Get the header attributes to apply to the formatter.

Overrides:

getHeaderAttributes in class JSONService

Returns:

A map from string to object.

getDefaultFormat

protected Format getDefaultFormat()

Overrides:

getDefaultFormat in class JSONService

Returns:

The default format constant for this service.

getResultsKey

protected java.lang.String getResultsKey()

Overrides:

getResultsKey in class JSONService

Returns:

The key for the results property.

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.