Class Config
- java.lang.Object
-
- org.intermine.webservice.server.WebService
-
- org.intermine.webservice.server.core.JSONService
-
- org.intermine.webservice.server.jbrowse.Config
-
public class Config extends JSONService
Provide standard JBrowse configuration files (trackList.json
andrefSeqs.json
) that are required to run a JBrowse instance. This service automatically generates the configuration required to run JBrowse for a given domain (usually an Organism), exposing all the reference sequences for which there are data, and providing a description of all the feature tracks. This service requires appropriate values to be configured in the web-properties of a mine. For most biological genomic webservices, the default configuration will suffice, but this can be altered on a per installation basis. See the JBrowse wiki for a guide to the formats of the files generated here.- 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 Config(InterMineAPI im)
Build a new instance with the injected API
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
execute()
Runs service.protected void
initState()
Subclasses can put initialisation here.protected Output
makeJSONOutput(java.io.PrintWriter out, java.lang.String separator)
Make the default JSON output given the HttpResponse's PrintWriter.-
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, 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, makeXMLOutput, service, setFormat, setNameSpace, validateState, wantsColumnHeaders, wantsDataPackage
-
-
-
-
Constructor Detail
-
Config
public Config(InterMineAPI im)
Build a new instance with the injected API- Parameters:
im
- InterMine API
-
-
Method Detail
-
initState
protected void initState()
Description copied from class:WebService
Subclasses can put initialisation here.- Overrides:
initState
in classWebService
-
makeJSONOutput
protected Output makeJSONOutput(java.io.PrintWriter out, java.lang.String separator)
Description copied from class:WebService
Make the default JSON output given the HttpResponse's PrintWriter.- Overrides:
makeJSONOutput
in classWebService
- Parameters:
out
- The PrintWriter from the HttpResponse.separator
- The line-separator for the client's platform.- Returns:
- An Output that produces good JSON.
-
execute
protected void execute() throws ServiceException
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:
ServiceException
-
-