eu.europeana.cloud.service.mcs.rest

Class FileResource

java.lang.Object

eu.europeana.cloud.service.mcs.rest.FileResource

@Component
@Scope(value="request")
public class FileResource
extends Object

Resource to manage representation version's files with their content.

Constructor Summary

Constructors

Constructor and Description
FileResource()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFile(String globalId, String schema, String version, String fileName) Deletes file from representation version.
javax.ws.rs.core.Response	getFile(String globalId, String schema, String version, String fileName, String range) Returns file content.
javax.ws.rs.core.Response	sendFile(javax.ws.rs.core.UriInfo uriInfo, String globalId, String schema, String version, String fileName, String mimeType, InputStream data) Updates a file in a representation version.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResource

public FileResource()

Method Detail

sendFile

@PreAuthorize(value="hasPermission(#globalId.concat(\'/\').concat(#schema).concat(\'/\').concat(#version), \'eu.europeana.cloud.common.model.Representation\', write)")
public javax.ws.rs.core.Response sendFile(@Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              String globalId,
                                              String schema,
                                              String version,
                                              String fileName,
                                              String mimeType,
                                              InputStream data)
                                   throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                          eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                                          eu.europeana.cloud.service.mcs.exception.FileNotExistsException

Updates a file in a representation version. MD5 of the uploaded data is returned as a tag. Consumes multipart content - form data:

• "mimeType" - file mime type
• "data" - binary stream of file content (required).

Write permissions required.

Parameters:

globalId - cloud id of the record in which the file will be updated (required)

schema - schema of representation (required)

version - a specific version of the representation(required)

fileName - the name of the file(required)

mimeType - mime type of file

data - binary stream of file content (required)

Returns:

URI of the uploaded content file in content-location

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - representation does not exist in specified version.

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException - specified representation version is persistent and modifying its files is not allowed.

eu.europeana.cloud.service.mcs.exception.FileNotExistsException - specified file does not exist.

getFile

@PreAuthorize(value="hasPermission(#globalId.concat(\'/\').concat(#schema).concat(\'/\').concat(#version), \'eu.europeana.cloud.common.model.Representation\', read)")
public javax.ws.rs.core.Response getFile(String globalId,
                                             String schema,
                                             String version,
                                             String fileName,
                                             @HeaderParam(value="Range")
                                             String range)
                                  throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                                         eu.europeana.cloud.service.mcs.exception.FileNotExistsException,
                                         eu.europeana.cloud.service.mcs.exception.WrongContentRangeException

Returns file content. Basic support for HTTP "Range" header is implemented for retrieving only a part of content . (Description of Range header can be found in Hypertext Transfer Protocol HTTP/1.1, section 14.35 Range). For instance:

• Range: bytes=10-15 - retrieve bytes from 10 to 15 of content
• Range: bytes=10- - skip 10 first bytes of content

Read permissions required.

Parameters:

globalId - cloud id of the record (required).

schema - schema of representation (required).

version - a specific version of the representation(required).

fileName - the name of the file(required).

range - range of bytes to return (optional)

Returns:

file content

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - representation does not exist in the specified version.

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - representation does not exist in the specified version.

eu.europeana.cloud.service.mcs.exception.WrongContentRangeException - wrong value in "Range" header

eu.europeana.cloud.service.mcs.exception.FileNotExistsException - representation version does not have file with the specified name.

deleteFile

@PreAuthorize(value="hasPermission(#globalId.concat(\'/\').concat(#schema).concat(\'/\').concat(#version), \'eu.europeana.cloud.common.model.Representation\', delete)")
public void deleteFile(String globalId,
                           String schema,
                           String version,
                           String fileName)
                throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                       eu.europeana.cloud.service.mcs.exception.FileNotExistsException,
                       eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException

Deletes file from representation version. Delete permissions required.

Parameters:

globalId - cloud id of the record (required).

schema - schema of representation (required).

version - a specific version of the representation(required).

fileName - the name of the file(required).

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - representation does not exist in the specified version.

eu.europeana.cloud.service.mcs.exception.FileNotExistsException - representation version does not have file with the specified name.

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException - specified representation version is persistent and deleting its files is not allowed.