Package uk.org.esciencelab.researchobjectservice.researchobject

Class ResearchObjectController

  • @RestController
public class ResearchObjectController
extends java.lang.Object
    A simple controller to handle viewing, listing, deleting, creating and bagging Research Objects.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<ResearchObjectSummary>> all​(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler pagedAssembler)  
      org.springframework.hateoas.Resources<org.springframework.hateoas.Resource<ResearchObjectSummary>> allForProfile​(java.lang.String profileName, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler pagedAssembler)  
      org.springframework.http.ResponseEntity<java.lang.Object> createResearchObject​(java.lang.String profileName, com.fasterxml.jackson.databind.JsonNode content)  
      java.lang.String defaultDeposit​(long id, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,​java.lang.String> depositorParams)  
      org.springframework.http.ResponseEntity<?> deleteResearchObject​(long id)  
      java.lang.String deposit​(long id, java.lang.String depositor, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,​java.lang.String> depositorParams)  
      void mintBag​(long id, javax.servlet.http.HttpServletResponse response)  
      org.springframework.hateoas.Resource<ResearchObject> one​(long id)  
      void validate​(long id, javax.servlet.http.HttpServletResponse response)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ResearchObjectController

        public ResearchObjectController()

    • Method Detail

      • all

        @GetMapping("/research_objects")
public org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<ResearchObjectSummary>> all​(@PageableDefault
                                                                                                                   org.springframework.data.domain.Pageable pageable,
                                                                                                                   org.springframework.data.web.PagedResourcesAssembler pagedAssembler)

      • one

        @GetMapping("/research_objects/{id}")
public org.springframework.hateoas.Resource<ResearchObject> one​(@PathVariable
                                                                long id)

      • deleteResearchObject

        @DeleteMapping("/research_objects/{id}")
public org.springframework.http.ResponseEntity<?> deleteResearchObject​(@PathVariable
                                                                       long id)

      • allForProfile

        @GetMapping("/profiles/{profileName}/research_objects")
public org.springframework.hateoas.Resources<org.springframework.hateoas.Resource<ResearchObjectSummary>> allForProfile​(@PathVariable
                                                                                                                        java.lang.String profileName,
                                                                                                                        @PageableDefault
                                                                                                                        org.springframework.data.domain.Pageable pageable,
                                                                                                                        org.springframework.data.web.PagedResourcesAssembler pagedAssembler)

      • createResearchObject

        @PostMapping("/profiles/{profileName}/research_objects")
public org.springframework.http.ResponseEntity<java.lang.Object> createResearchObject​(@PathVariable
                                                                                      java.lang.String profileName,
                                                                                      @RequestBody(required=false)
                                                                                      com.fasterxml.jackson.databind.JsonNode content)

      • mintBag

        @PostMapping(value="/research_objects/{id}/bag",
             produces="application/zip")
public void mintBag​(@PathVariable
                    long id,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
        Throws:
        java.lang.Exception

      • defaultDeposit

        @PostMapping(value="/research_objects/{id}/deposit",
             produces="text/plain")
public java.lang.String defaultDeposit​(@PathVariable
                                       long id,
                                       javax.servlet.http.HttpServletResponse response,
                                       @RequestParam
                                       java.util.Map<java.lang.String,​java.lang.String> depositorParams)

      • deposit

        @PostMapping(value="/research_objects/{id}/deposit/{depositor}",
             produces="text/plain")
public java.lang.String deposit​(@PathVariable
                                long id,
                                @PathVariable
                                java.lang.String depositor,
                                javax.servlet.http.HttpServletResponse response,
                                @RequestParam
                                java.util.Map<java.lang.String,​java.lang.String> depositorParams)

      • validate

        @GetMapping("/research_objects/{id}/validate")
public void validate​(@PathVariable
                     long id,
                     javax.servlet.http.HttpServletResponse response)