Package org.intermine.webservice.server.core

Class ReadWriteJSONService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.core.ReadWriteJSONService

Direct Known Subclasses:

DeleteTokensService, NewDeletionTokenService, PermaTokenDeletionService, PermaTokenInfoService, QueryRemovalService, ReadPreferencesService, TemplateRemovalService, TokenService, TokensService

public abstract class ReadWriteJSONService
extends JSONService

Convenience for services that need to combine JSON service behaviour with strict RW authorisation.

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
ReadWriteJSONService(InterMineAPI im)	Construct a read/write service.

Method Summary

Modifier and Type	Method	Description
protected void	validateState()	Subclasses can put initialisation checks here.

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

addOutputInfo, addResultEntries, addResultEntries, addResultEntry, addResultEntry, addResultItem, addResultItem, addResultValue, addResultValue, addResultValue, getDefaultFormat, getHeaderAttributes, getResultsKey, lazyList, postInit

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWriteJSONService

public ReadWriteJSONService(InterMineAPI im)

Construct a read/write service.

Parameters:

im - The InterMine state object.

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