Package org.intermine.webservice.server.oauth2

Class CallbackService

java.lang.Object

org.intermine.webservice.server.WebService

org.intermine.webservice.server.core.JSONService

org.intermine.webservice.server.oauth2.CallbackService

public class CallbackService
extends JSONService

The service handles the requests made after the user has visited their authorisation provider to log-in. That provider will then send them off here with a code that we need to use to access their user details via a two-step process (get an authorisation token, and then get user details). If all is well, this controller will log the user in Duplication of the Callback class used by struts. See org.intermine.web.struts.oauth2.Callback

Author:

Alex Kalderimis, Daniela Butano

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
CallbackService(InterMineAPI im)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	execute()	Runs service.
protected java.lang.String	getResultsKey()

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, validateState, wantsColumnHeaders, wantsDataPackage

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackService

public CallbackService(InterMineAPI im)

Constructor

Parameters:

im - The InterMine state object.

Method Detail

getResultsKey

protected java.lang.String getResultsKey()

Overrides:

getResultsKey in class JSONService

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 class WebService

Throws:

java.lang.Exception - if some error occurs