Package overit.geocallapp.docshare.documents.rs1.file

Class FileService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.docshare.documents.rs1.file.FileService

@RestController
@RequestMapping("documents/r1/files")
@Resource(logging=true)
public class FileService
extends PrivateService

Service to manage files.

Since:

14.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
FileService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	activateFile(String fileUuid)	Activates the latest uploaded version of a file.
org.springframework.http.ResponseEntity<Void>	delete(String fileUuid, @Valid DTOFileDelete dto)	Deletes the required file by calling the FileDeleteEvent.
org.springframework.http.ResponseEntity<DTOFile>	get(String fileUuid, Collection<String> fields)	Retrieve the main version of a BOFile by calling the MainVersionFileLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOFile>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOFileFilter filter)	Retrieve the all stored files by calling the FileSearchEvent.
org.springframework.http.ResponseEntity<DTOPresignedURL>	getDownloadPresignedURL(@Valid DTOFileKey dto)	Retrieve the required presigned URL to download the corresponding file.
org.springframework.http.ResponseEntity<DTOPresignedURL>	getUploadPresignedURL(@Valid DTOFileKey dto)	Retrieve the required presigned URL to upload the corresponding file.
protected WebResource	loadWebResource(String uuid, Long version)	Load the required web resource.
org.springframework.http.ResponseEntity<Void>	patch(String fileUuid, @Valid DTOFileUpdate dto)	Updates the required file by calling the FileUpdateEvent.
org.springframework.http.ResponseEntity<DTOFileKey>	post(@Valid DTOFileInsert dto)	Create a new file by calling the FileInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

FileService

public FileService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOFile>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTOFileFilter filter)
                                                                             throws DAValidateException,
DAException

Retrieve the all stored files by calling the FileSearchEvent.

Parameters:

page - the required result page

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOFileFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{fileUuid:[A-Za-z0-9-]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOFile> get(@PathVariable("fileUuid")
 String fileUuid,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields)
                                                     throws DAValidateException,
DAException

Retrieve the main version of a BOFile by calling the MainVersionFileLoadEvent. The main version corresponds to the currently active one or the latest one if the active one is not available.

Parameters:

fileUuid - the file id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded file

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOFileKey> post(@Valid @RequestBody
 @Valid DTOFileInsert dto)
                                                         throws DAValidateException,
DAException

Create a new file by calling the FileInsertEvent.

Parameters:

dto - the DTOFileInsert

Returns:

the standard response containing the new file id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{fileUuid:[A-Za-z0-9-]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("fileUuid")
 String fileUuid,
 @Valid @RequestBody
 @Valid DTOFileUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required file by calling the FileUpdateEvent.

Parameters:

fileUuid - the file id

dto - the DTOFileUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{fileUuid:[A-Za-z0-9-]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("fileUuid")
 String fileUuid,
 @Valid
 @Valid DTOFileDelete dto)
                                                     throws DAValidateException,
DAException

Deletes the required file by calling the FileDeleteEvent.

Parameters:

fileUuid - the file id

dto - the DTOFileDelete

Returns:

the response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

loadWebResource

protected WebResource loadWebResource(String uuid,
 Long version)
                               throws DAValidateException,
DAException

Load the required web resource.

Parameters:

uuid - the uuid

version - the version

Returns:

the corresponding web resource

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getUploadPresignedURL

@GetMapping(value="/upload-urls",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOPresignedURL> getUploadPresignedURL(@Valid
 @Valid DTOFileKey dto)
                                                                               throws DAValidateException,
DAException

Retrieve the required presigned URL to upload the corresponding file.

Parameters:

dto - the dto containing the file uuid and version

Returns:

the response containing the presigned URL

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getDownloadPresignedURL

@GetMapping(value="/download-urls",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOPresignedURL> getDownloadPresignedURL(@Valid
 @Valid DTOFileKey dto)
                                                                                 throws DAValidateException,
DAException

Retrieve the required presigned URL to download the corresponding file.

Parameters:

dto - the dto containing the file uuid and version

Returns:

the response containing the presigned URL

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

activateFile

@PostMapping(value="/{fileUuid:[A-Za-z0-9-]+}/activations",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> activateFile(@PathVariable("fileUuid")
 String fileUuid)
                                                           throws DAValidateException,
DAException

Activates the latest uploaded version of a file. This triggers the file activation process by launching a FileConfirmEvent, which confirms the upload and activates the file, by updating some of its information (such as active flag, byte dimension, etc.).

Parameters:

fileUuid - the file UUID

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception