Interface JobDirectoryServerService

  • All Known Implementing Classes:
    JobDirectoryServerServiceImpl

    @Validated
    public interface JobDirectoryServerService
    This service abstracts away the details of responding to API requests for the files and directories created during the execution of a job in the Genie ecosystem. This service is read only.
    Since:
    4.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void serveResource​(java.lang.String jobId, java.net.URL baseUrl, java.lang.String relativePath, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Given the request this API will write the resource to response if possible.
    • Method Detail

      • serveResource

        void serveResource​(java.lang.String jobId,
                           java.net.URL baseUrl,
                           java.lang.String relativePath,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws GenieException
        Given the request this API will write the resource to response if possible. If the resource doesn't exist or an error is generated an appropriate HTTP error response will be written to response instead.
        Parameters:
        jobId - The id of the job this request is for
        baseUrl - The base URL used to generate all URLs for resources
        relativePath - The relative path from the root of the job directory of the expected resource
        request - The HTTP request containing all information about the request
        response - The HTTP response where all results should be written
        Throws:
        GenieException - If there is an error serving the response