Package io.camunda.zeebe.gateway.rest.controller

Class DocumentController

java.lang.Object

io.camunda.zeebe.gateway.rest.controller.DocumentController

@CamundaRestController
@RequestMapping("/v2/documents")
public class DocumentController
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentController.DocumentContentFetchException

Constructor Summary

Constructors

Constructor	Description
DocumentController(DocumentServices documentServices)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<org.springframework.http.ResponseEntity<Object>>	createDocument(String documentId, String storeId, org.springframework.web.multipart.MultipartFile file, DocumentMetadata metadata)
org.springframework.http.ResponseEntity<Object>	createDocumentLink(String documentId, String storeId, DocumentLinkRequest linkRequest)
CompletableFuture<org.springframework.http.ResponseEntity<Object>>	deleteDocument(String documentId, String storeId)
org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody>	getDocumentContent(String documentId, String storeId)
org.springframework.http.ResponseEntity<Object>	handleDocumentContentException(DocumentController.DocumentContentFetchException e)

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentController

@Autowired
public DocumentController(DocumentServices documentServices)

Method Details

createDocument

@PostMapping(consumes="multipart/form-data",
             produces={"application/json","application/problem+json"})
public CompletableFuture<org.springframework.http.ResponseEntity<Object>> createDocument(@RequestParam(required=false)
 String documentId,
 @RequestParam(required=false)
 String storeId,
 @RequestPart("file")
 org.springframework.web.multipart.MultipartFile file,
 @RequestPart(value="metadata",required=false)
 DocumentMetadata metadata)

getDocumentContent

@GetMapping(path="/{documentId}",
            produces={"application/octet-stream","application/problem+json"})
public org.springframework.http.ResponseEntity<org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody> getDocumentContent(@PathVariable
 String documentId,
 @RequestParam(required=false)
 String storeId)

handleDocumentContentException

@ExceptionHandler(DocumentContentFetchException.class)
public org.springframework.http.ResponseEntity<Object> handleDocumentContentException(DocumentController.DocumentContentFetchException e)

deleteDocument

@DeleteMapping(path="/{documentId}",
               produces={"application/json","application/problem+json"})
public CompletableFuture<org.springframework.http.ResponseEntity<Object>> deleteDocument(@PathVariable
 String documentId,
 @RequestParam(required=false)
 String storeId)

createDocumentLink

@PostMapping(path="/{documentId}/links",
             consumes="application/json",
             produces={"application/json","application/problem+json"})
public org.springframework.http.ResponseEntity<Object> createDocumentLink(@PathVariable
 String documentId,
 @RequestParam(required=false)
 String storeId,
 @RequestBody
 DocumentLinkRequest linkRequest)