Package org.intermine.webservice.server.lists

Class AuthenticatedListService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.lists.AbstractListService

org.intermine.webservice.server.lists.AuthenticatedListService

Direct Known Subclasses:

ListDeletionService, ListMakerService, ListRenameService, ListUpdateService

public abstract class AuthenticatedListService
extends AbstractListService

A Class that insists on being authenticated.

Author:

Alex Kalderimis

Field Summary

Fields inherited from class org.intermine.webservice.server.lists.AbstractListService

LIST_DESCRIPTION_KEY, LIST_ID_KEY, LIST_NAME_KEY, LIST_SIZE_KEY

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
AuthenticatedListService(InterMineAPI api)	Constructor.

Method Summary

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

Methods inherited from class org.intermine.webservice.server.lists.AbstractListService

getClassesForBags, getInput

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

AuthenticatedListService

public AuthenticatedListService(InterMineAPI api)

Constructor.

Parameters:

api - The InterMine application 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