Class WhoAmIService
- java.lang.Object
-
- org.intermine.webservice.server.WebService
-
- org.intermine.webservice.server.core.JSONService
-
- org.intermine.webservice.server.user.WhoAmIService
-
public class WhoAmIService extends JSONService
Class for retrieving information about the currently authenticated user. Currently just a stub. This will be fleshed out in future with any useful user data:- preferences (enrichment algorithms, preferred extra-values).
- roles and groups
- etc...
- 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 WhoAmIService(InterMineAPI im)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
execute()
Runs service.protected java.lang.String
getResultsKey()
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, lazyList, postInit
-
Methods inherited from class org.intermine.webservice.server.WebService
canServe, 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, initState, isAuthenticated, isGzip, isUncompressed, isZip, makeJSONOutput, makeXMLOutput, service, setFormat, setNameSpace, wantsColumnHeaders, wantsDataPackage
-
-
-
-
Constructor Detail
-
WhoAmIService
public WhoAmIService(InterMineAPI im)
Constructor- Parameters:
im
- The InterMine API 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 classWebService
-
getResultsKey
protected java.lang.String getResultsKey()
- Overrides:
getResultsKey
in classJSONService
- Returns:
- The key for the results property.
-
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 classWebService
- Throws:
java.lang.Exception
- if some error occurs
-
-