com.edorasware.publicapi.rest

Class DocumentController

java.lang.Object

com.edorasware.publicapi.rest.DocumentController

@ApiController
public class DocumentController
extends Object

This class implements Document specific public API methods

Constructor Summary

Constructors

Constructor and Description
DocumentController(DocumentContentManager documentContentManager, WorkObjectManager workObjectManager, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
ValueMap	create(String data, String view, List<String> fields)
void	delete(String workObjectId)
QueryResponse	get(String query, Integer start, Integer size, String view, List<String> fields)
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	getDocumentContent(String workObjectId, boolean forceDownload)
Map<String,Object>	getDocumentWorkForm(String ambiguousWorkObjectId, Locale locale)
ValueMap	getInstance(String ambiguousWorkObjectId, String view, List<String> fields)
void	options(javax.servlet.http.HttpServletResponse response)
UploadResponse	saveDocumentContent(String workObjectId, boolean deleteOnError, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
ValueMap	update(String workObjectId, String data, String view, List<String> fields)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentController

@Autowired
public DocumentController(DocumentContentManager documentContentManager,
                                     WorkObjectManager workObjectManager,
                                     @Qualifier(value="publicApiObjectMapper")
                                     com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

get

@RequestMapping(value={"/documents","/v1/documents"},
                method=GET,
                produces="application/json")
 @ResponseBody
public QueryResponse get(@RequestParam(required=false)
                                                                                                                                                                       String query,
                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                       Integer start,
                                                                                                                                                                       @RequestParam(required=false,defaultValue="50")
                                                                                                                                                                       Integer size,
                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                       String view,
                                                                                                                                                                       @RequestParam(required=false)
                                                                                                                                                                       List<String> fields)

getInstance

@RequestMapping(value={"/documents/{ambiguousWorkObjectId}","/v1/documents/{ambiguousWorkObjectId}"},
                method=GET,
                produces="application/json")
 @ResponseBody
public ValueMap getInstance(@PathVariable
                                                                                                                                                                                                                          String ambiguousWorkObjectId,
                                                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                                                          String view,
                                                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                                                          List<String> fields)

getDocumentWorkForm

@RequestMapping(value={"/documents/{ambiguousWorkObjectId}/work-form","/v1/documents/{ambiguousWorkObjectId}/work-form"},
                method=GET,
                produces="application/json")
 @ResponseBody
public Map<String,Object> getDocumentWorkForm(@PathVariable
                                                                                                                                                                                                                                                                String ambiguousWorkObjectId,
                                                                                                                                                                                                                                                                Locale locale)

create

@RequestMapping(value={"/documents","/v1/documents"},
                method=POST,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap create(@RequestBody
                                                                                                                                                                                                                   String data,
                                                                                                                                                                                                                   @RequestParam(required=false)
                                                                                                                                                                                                                   String view,
                                                                                                                                                                                                                   @RequestParam(required=false)
                                                                                                                                                                                                                   List<String> fields)
                                                                                                                                                                                                            throws IOException

Throws:

IOException

update

@RequestMapping(value={"/documents/{workObjectId}","/v1/documents/{workObjectId}"},
                method=PUT,
                produces="application/json",
                consumes="application/json")
 @ResponseBody
public ValueMap update(@PathVariable
                                                                                                                                                                                                                                                String workObjectId,
                                                                                                                                                                                                                                                @RequestBody
                                                                                                                                                                                                                                                String data,
                                                                                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                                                                                String view,
                                                                                                                                                                                                                                                @RequestParam(required=false)
                                                                                                                                                                                                                                                List<String> fields)
                                                                                                                                                                                                                                         throws IOException

Throws:

IOException

delete

@RequestMapping(value={"/documents/{workObjectId}","/v1/documents/{workObjectId}"},
                method=DELETE)
public void delete(@PathVariable
                                                                                                                                      String workObjectId)
                                                                                                                               throws IOException

Throws:

IOException

options

@RequestMapping(value={"/documents","/v1/documents"},
                method=OPTIONS,
                produces="application/json")
public void options(javax.servlet.http.HttpServletResponse response)
                                                                                                                                                throws IOException

Throws:

IOException

getDocumentContent

@RequestMapping(value={"/documents/{workObjectId}/content","/v1/documents/{workObjectId}/content"},
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> getDocumentContent(@PathVariable
                                                                                                                                                                                                                                        String workObjectId,
                                                                                                                                                                                                                                        @RequestParam(required=false,defaultValue="false")
                                                                                                                                                                                                                                        boolean forceDownload)

saveDocumentContent

@ResponseBody
 @RequestMapping(value={"/documents/{workObjectId}/content","/v1/documents/{workObjectId}/content"},
                method=POST,
                produces="application/json",
                consumes="multipart/form-data")
public UploadResponse saveDocumentContent(@PathVariable(value="workObjectId")
                                                                                                                                                                                                                                                                                       String workObjectId,
                                                                                                                                                                                                                                                                                       @RequestParam(defaultValue="false")
                                                                                                                                                                                                                                                                                       boolean deleteOnError,
                                                                                                                                                                                                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                                                                                       javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                                                                                                throws Exception

Throws:

Exception