com.ge.research.semtk.services.results

Class ResultsServiceRestController

java.lang.Object

com.ge.research.semtk.services.results.ResultsServiceRestController

@CrossOrigin
 @RestController
 @RequestMapping(value="/results")
 @ComponentScan(basePackages="com.ge.research.semtk.springutillib")
public class ResultsServiceRestController
extends Object

Service to get query results.

Constructor Summary

Constructors

Constructor and Description
ResultsServiceRestController()

Method Summary

Modifier and Type	Method and Description
org.json.simple.JSONObject	deleteStorage(JobIdRequest requestBody, org.springframework.http.HttpHeaders headers) Delete file and metadata associated with this jobId
org.springframework.core.io.FileSystemResource	getBinaryFile(String fileId, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
void	getJsonBlobResults(JobIdRequest requestBody, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers) Given a jobId, write back the raw json.
void	getJsonLdResults(JobIdRequest requestBody, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
org.json.simple.JSONObject	getResults(JobIdRequest requestBody, org.springframework.http.HttpHeaders headers) Gets a CSV URL and a JSON URL containing results for a job Keeping this only for backwards compatibility with v1.3 or earlier "fullURL" is the CSV file (retaining bad label for backward compatibility) "sampleURL" is the JSON file (retaining bad label for backward compatibility)
org.json.simple.JSONObject	getResultsFiles(JobIdRequest requestBody, org.springframework.http.HttpHeaders headers)
void	getTableResultsCsv(ResultsRequestBodyCsvMaxRows requestBody, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers) Return a CSV file containing results (possibly truncated) for job
void	getTableResultsCsvForWebClient(String jobId, Integer maxRows, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
void	getTableResultsJson(ResultsRequestBodyMaxRows requestBody, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getTableResultsJsonForWebClient(String jobId, Integer maxRows, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
org.json.simple.JSONObject	getTableResultsRowCount(JobIdRequest requestBody, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers)
void	init()
org.json.simple.JSONObject	storeBinaryFile(org.springframework.web.multipart.MultipartFile file, String jobId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, org.springframework.http.HttpHeaders headers) Given multipartFile, save a copy, assign a fileId and URL (stores a metafile)
org.json.simple.JSONObject	storeBinaryFilePath(ResultsRequestBodyPath requestBody, org.springframework.http.HttpHeaders headers) Given path, assign a fileId and URL (stores a metafile)
org.json.simple.JSONObject	storeJsonBlobResults(JsonBlobRequestBody requestBody, org.springframework.http.HttpHeaders headers)
org.json.simple.JSONObject	storeJsonLdResults(JsonLdStoreRequestBody requestBody, org.springframework.http.HttpHeaders headers)
org.json.simple.JSONObject	storeTableResultsJsonAddIncremental(ResultsRequestBodyFileExtContents requestBody, org.springframework.http.HttpHeaders headers) Call 2 of 3 for storing JSON results.
org.json.simple.JSONObject	storeTableResultsJsonFinalize(ResultsRequestBodyFinalizeTableResultsJson requestBody, org.springframework.http.HttpHeaders headers) Call 3 of 3 for storing JSON results.
org.json.simple.JSONObject	storeTableResultsJsonInitialize(ResultsRequestBodyInitializeTableResultsJson requestBody, org.springframework.http.HttpHeaders headers) Call 1 of 3 for storing JSON results.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultsServiceRestController

public ResultsServiceRestController()

Method Detail

init

@PostConstruct
public void init()

storeJsonLdResults

@CrossOrigin
 @RequestMapping(value="/storeJsonLdResults",
                method=POST)
public org.json.simple.JSONObject storeJsonLdResults(@RequestBody
                                                                                                                                                JsonLdStoreRequestBody requestBody,
                                                                                                                                                @RequestHeader
                                                                                                                                                org.springframework.http.HttpHeaders headers)

getJsonLdResults

@CrossOrigin
 @RequestMapping(value="/getJsonLdResults",
                method=POST)
public void getJsonLdResults(@RequestBody
                                                                                                                      JobIdRequest requestBody,
                                                                                                                      javax.servlet.http.HttpServletResponse resp,
                                                                                                                      @RequestHeader
                                                                                                                      org.springframework.http.HttpHeaders headers)

storeJsonBlobResults

@CrossOrigin
 @RequestMapping(value="/storeJsonBlobResults",
                method=POST)
public org.json.simple.JSONObject storeJsonBlobResults(@RequestBody
                                                                                                                                                    JsonBlobRequestBody requestBody,
                                                                                                                                                    @RequestHeader
                                                                                                                                                    org.springframework.http.HttpHeaders headers)

getJsonBlobResults

@CrossOrigin
 @RequestMapping(value="/getJsonBlobResults",
                method=POST)
public void getJsonBlobResults(@RequestBody
                                                                                                                          JobIdRequest requestBody,
                                                                                                                          javax.servlet.http.HttpServletResponse resp,
                                                                                                                          @RequestHeader
                                                                                                                          org.springframework.http.HttpHeaders headers)

Given a jobId, write back the raw json. Empty if bad jobId.

Parameters:

requestBody -

resp -

headers -

getResultsFiles

@CrossOrigin
 @RequestMapping(value="/getResultsFiles",
                method=POST)
public org.json.simple.JSONObject getResultsFiles(@RequestBody
                                                                                                                                          JobIdRequest requestBody,
                                                                                                                                          @RequestHeader
                                                                                                                                          org.springframework.http.HttpHeaders headers)

storeBinaryFile

@CrossOrigin
 @RequestMapping(value="/storeBinaryFile",
                method=POST)
public org.json.simple.JSONObject storeBinaryFile(@RequestParam(value="file")
                                                                                                                                          org.springframework.web.multipart.MultipartFile file,
                                                                                                                                          @RequestParam(value="jobId")
                                                                                                                                          String jobId,
                                                                                                                                          javax.servlet.http.HttpServletRequest req,
                                                                                                                                          javax.servlet.http.HttpServletResponse resp,
                                                                                                                                          @RequestHeader
                                                                                                                                          org.springframework.http.HttpHeaders headers)

Given multipartFile, save a copy, assign a fileId and URL (stores a metafile)

Parameters:

requestBody -

headers -

Returns:

res.fullURL res.fileId

storeBinaryFilePath

@CrossOrigin
 @RequestMapping(value="/storeBinaryFilePath",
                method=POST)
public org.json.simple.JSONObject storeBinaryFilePath(@RequestBody
                                                                                                                                                  ResultsRequestBodyPath requestBody,
                                                                                                                                                  @RequestHeader
                                                                                                                                                  org.springframework.http.HttpHeaders headers)

Given path, assign a fileId and URL (stores a metafile)

Parameters:

requestBody -

headers -

Returns:

res.fullURL res.fileId

getBinaryFile

@CrossOrigin
 @RequestMapping(value="/getBinaryFile/{fileId}",
                method=GET)
 @ResponseBody
public org.springframework.core.io.FileSystemResource getBinaryFile(@PathVariable(value="fileId")
                                                                                                                                                                                  String fileId,
                                                                                                                                                                                  javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                                                  @RequestHeader
                                                                                                                                                                                  org.springframework.http.HttpHeaders headers)

storeTableResultsJsonInitialize

@CrossOrigin
 @RequestMapping(value="/storeTableResultsJsonInitialize",
                method=POST)
public org.json.simple.JSONObject storeTableResultsJsonInitialize(@RequestBody
                                                                                                                                                                          ResultsRequestBodyInitializeTableResultsJson requestBody,
                                                                                                                                                                          @RequestHeader
                                                                                                                                                                          org.springframework.http.HttpHeaders headers)

Call 1 of 3 for storing JSON results. Writes JSON start, column names, and column types.

storeTableResultsJsonAddIncremental

@CrossOrigin
 @RequestMapping(value="/storeTableResultsJsonAddIncremental",
                method=POST)
public org.json.simple.JSONObject storeTableResultsJsonAddIncremental(@RequestBody
                                                                                                                                                                                  ResultsRequestBodyFileExtContents requestBody,
                                                                                                                                                                                  @RequestHeader
                                                                                                                                                                                  org.springframework.http.HttpHeaders headers)

Call 2 of 3 for storing JSON results. Repeat for multiple batches. Writes rows of data. The input data ("contents") must: 1) be ZLIB compressed, using Utility.compress() or other 2) omit tailing comma for the last row of the last call Sample input (decompressed): ["a1","b1","c1"], ["a2","b2","c2"], ["a3","b3","c3"]

storeTableResultsJsonFinalize

@CrossOrigin
 @RequestMapping(value="/storeTableResultsJsonFinalize",
                method=POST)
public org.json.simple.JSONObject storeTableResultsJsonFinalize(@RequestBody
                                                                                                                                                                      ResultsRequestBodyFinalizeTableResultsJson requestBody,
                                                                                                                                                                      @RequestHeader
                                                                                                                                                                      org.springframework.http.HttpHeaders headers)

Call 3 of 3 for storing JSON results. Writes row count and JSON end.

getTableResultsCsv

@CrossOrigin
 @RequestMapping(value="/getTableResultsCsv",
                method=POST)
public void getTableResultsCsv(@RequestBody
                                                                                                                          ResultsRequestBodyCsvMaxRows requestBody,
                                                                                                                          javax.servlet.http.HttpServletResponse resp,
                                                                                                                          @RequestHeader
                                                                                                                          org.springframework.http.HttpHeaders headers)

Return a CSV file containing results (possibly truncated) for job

getTableResultsJsonForWebClient

@CrossOrigin
 @RequestMapping(value="/getTableResultsJsonForWebClient",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getTableResultsJsonForWebClient(@RequestParam
                                                                                                                                                                                                                            String jobId,
                                                                                                                                                                                                                            @RequestParam(required=false)
                                                                                                                                                                                                                            Integer maxRows,
                                                                                                                                                                                                                            javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                                                                                            @RequestHeader
                                                                                                                                                                                                                            org.springframework.http.HttpHeaders headers)

getTableResultsCsvForWebClient

@CrossOrigin
 @RequestMapping(value="/getTableResultsCsvForWebClient",
                method=GET)
public void getTableResultsCsvForWebClient(@RequestParam
                                                                                                                                                 String jobId,
                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                 Integer maxRows,
                                                                                                                                                 javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                 @RequestHeader
                                                                                                                                                 org.springframework.http.HttpHeaders headers)

getTableResultsRowCount

@CrossOrigin
 @RequestMapping(value="/getTableResultsRowCount",
                method=POST)
public org.json.simple.JSONObject getTableResultsRowCount(@RequestBody
                                                                                                                                                          JobIdRequest requestBody,
                                                                                                                                                          javax.servlet.http.HttpServletResponse resp,
                                                                                                                                                          @RequestHeader
                                                                                                                                                          org.springframework.http.HttpHeaders headers)

getTableResultsJson

@CrossOrigin
 @RequestMapping(value="/getTableResultsJson",
                method=POST)
public void getTableResultsJson(@RequestBody
                                                                                                                            ResultsRequestBodyMaxRows requestBody,
                                                                                                                            javax.servlet.http.HttpServletResponse resp,
                                                                                                                            @RequestHeader
                                                                                                                            org.springframework.http.HttpHeaders headers)

getResults

@CrossOrigin
 @RequestMapping(value="/getResults",
                method=POST)
public org.json.simple.JSONObject getResults(@RequestBody
                                                                                                                                JobIdRequest requestBody,
                                                                                                                                @RequestHeader
                                                                                                                                org.springframework.http.HttpHeaders headers)

Gets a CSV URL and a JSON URL containing results for a job Keeping this only for backwards compatibility with v1.3 or earlier "fullURL" is the CSV file (retaining bad label for backward compatibility) "sampleURL" is the JSON file (retaining bad label for backward compatibility)

deleteStorage

@CrossOrigin
 @RequestMapping(value="/deleteJob",
                method=POST)
public org.json.simple.JSONObject deleteStorage(@RequestBody
                                                                                                                                  JobIdRequest requestBody,
                                                                                                                                  @RequestHeader
                                                                                                                                  org.springframework.http.HttpHeaders headers)

Delete file and metadata associated with this jobId