eu.europeana.cloud.mcs.driver

Class FileServiceClient

java.lang.Object

eu.europeana.cloud.mcs.driver.FileServiceClient

public class FileServiceClient
extends Object

Exposes API related to files.

Constructor Summary

Constructors

Constructor and Description
FileServiceClient(String baseUrl) Constructs a FileServiceClient
FileServiceClient(String baseUrl, String username, String password) Creates instance of FileServiceClient.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFile(String cloudId, String representationName, String version, String fileName) Deletes existed file.
InputStream	getFile(String fileUrl) Function returns file content.
InputStream	getFile(String cloudId, String representationName, String version, String fileName) Function returns file content.
InputStream	getFile(String cloudId, String representationName, String version, String fileName, String range) Function returns file content.
URI	getFileUri(String cloudId, String representationName, String version, String fileName) Retrieve file uri from parameters.
URI	modifyFile(String fileUrl, InputStream data, String mediaType)
URI	modyfiyFile(String cloudId, String representationName, String version, InputStream data, String mediaType, String fileName, String expectedMd5) Modifies existed file with checking checksum.
static Map<String,String>	parseFileUri(String uri) Retrieve parts of file uri.
URI	uploadFile(String versionUrl, InputStream data, String mediaType) Uploads file content without checking checksum.
URI	uploadFile(String cloudId, String representationName, String version, InputStream data, String mediaType) Uploads file content without checking checksum.
URI	uploadFile(String cloudId, String representationName, String version, InputStream data, String mediaType, String expectedMd5) Uploads file content with checking checksum.
URI	uploadFile(String cloudId, String representationName, String version, String fileName, InputStream data, String mediaType) Uploads file content without checking checksum.
FileServiceClient	useAuthorizationHeader(String headerValue) Client will use provided authorization header for all requests;

Methods inherited from class java.lang.Object

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

Constructor Detail

FileServiceClient

public FileServiceClient(String baseUrl)

Constructs a FileServiceClient

Parameters:

baseUrl - url of the MCS Rest Service

FileServiceClient

public FileServiceClient(String baseUrl,
                 String username,
                 String password)

Creates instance of FileServiceClient. Same as FileServiceClient(String) but includes username and password to perform authenticated requests.

Parameters:

baseUrl - URL of the MCS Rest Service

Method Detail

getFile

public InputStream getFile(String cloudId,
                  String representationName,
                  String version,
                  String fileName)
                    throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                           eu.europeana.cloud.service.mcs.exception.FileNotExistsException,
                           DriverException,
                           eu.europeana.cloud.service.mcs.exception.MCSException

Function returns file content.

Parameters:

cloudId - id of returned file.

representationName - representation name of returned file.

version - version of returned file.

fileName - name of file.

Returns:

InputStream returned content.

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - when requested representation (or representation version) does not exist.

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

getFile

public InputStream getFile(String cloudId,
                  String representationName,
                  String version,
                  String fileName,
                  String range)
                    throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                           eu.europeana.cloud.service.mcs.exception.FileNotExistsException,
                           eu.europeana.cloud.service.mcs.exception.WrongContentRangeException,
                           DriverException,
                           eu.europeana.cloud.service.mcs.exception.MCSException

Function returns file content. By setting range parameter one can retrieve only a part of content.

Parameters:

cloudId - id of returned file.

representationName - representation name of returned file.

version - version of returned file.

fileName - name of file.

range - range of bytes to return. Range header can be found in Hypertext Transfer Protocol HTTP/1.1, section 14.35 Range).

Returns:

InputStream returned content.

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException - when requested representation (or representation version) does not exist.

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

getFile

public InputStream getFile(String fileUrl)
                    throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                           eu.europeana.cloud.service.mcs.exception.FileNotExistsException,
                           eu.europeana.cloud.service.mcs.exception.WrongContentRangeException,
                           DriverException,
                           eu.europeana.cloud.service.mcs.exception.MCSException,
                           IOException

Function returns file content.

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException

eu.europeana.cloud.service.mcs.exception.FileNotExistsException

eu.europeana.cloud.service.mcs.exception.WrongContentRangeException

DriverException

eu.europeana.cloud.service.mcs.exception.MCSException

IOException

uploadFile

public URI uploadFile(String cloudId,
             String representationName,
             String version,
             InputStream data,
             String mediaType,
             String expectedMd5)
               throws IOException,
                      eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                      eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                      DriverException,
                      eu.europeana.cloud.service.mcs.exception.MCSException

Uploads file content with checking checksum.

Parameters:

cloudId - id of uploaded file.

representationName - representation name of uploaded file.

version - version of uploaded file.

data - InputStream (content) of uploaded file.

mediaType - mediaType of uploaded file.

expectedMd5 - expected MD5 checksum.

Returns:

URI to uploaded file.

Throws:

IOException - when incorrect MD5 checksum.

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

uploadFile

public URI uploadFile(String cloudId,
             String representationName,
             String version,
             InputStream data,
             String mediaType)
               throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                      eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                      DriverException,
                      eu.europeana.cloud.service.mcs.exception.MCSException

Uploads file content without checking checksum.

Parameters:

cloudId - id of uploaded file.

representationName - representation name of uploaded file.

version - version of uploaded file.

data - InputStream (content) of uploaded file.

mediaType - mediaType of uploaded file.

Returns:

URI of uploaded file.

Throws:

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

uploadFile

public URI uploadFile(String cloudId,
             String representationName,
             String version,
             String fileName,
             InputStream data,
             String mediaType)
               throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                      eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                      DriverException,
                      eu.europeana.cloud.service.mcs.exception.MCSException

Uploads file content without checking checksum.

Parameters:

cloudId - id of uploaded file.

representationName - representation name of uploaded file.

version - version of uploaded file.

data - InputStream (content) of uploaded file.

mediaType - mediaType of uploaded file.

fileName - user file name

Returns:

URI of uploaded file.

Throws:

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

uploadFile

public URI uploadFile(String versionUrl,
             InputStream data,
             String mediaType)
               throws eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                      eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                      DriverException,
                      eu.europeana.cloud.service.mcs.exception.MCSException

Uploads file content without checking checksum.

Parameters:

versionUrl - Path to the version where the file will be uploaded to. For example: "http://ecloud.eanadev.org:8080/ecloud-service-mcs/records/L9WSPSMVQ85/representations/edm/versions/b17c4f60-70d0-11e4-8fe1-00163eefc9c8"

Throws:

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException

DriverException

eu.europeana.cloud.service.mcs.exception.MCSException

modyfiyFile

public URI modyfiyFile(String cloudId,
              String representationName,
              String version,
              InputStream data,
              String mediaType,
              String fileName,
              String expectedMd5)
                throws IOException,
                       eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                       eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                       DriverException,
                       eu.europeana.cloud.service.mcs.exception.MCSException

Modifies existed file with checking checksum.

Parameters:

cloudId - id of modifying file.

representationName - representation name of modifying file.

version - version of modifying file.

data - InputStream (content) of modifying file.

mediaType - mediaType of modifying file.

fileName - name of modifying file.

expectedMd5 - expected MD5 checksum.

Returns:

URI to modified file.

Throws:

IOException - when checksum is incorrect.

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

modifyFile

public URI modifyFile(String fileUrl,
             InputStream data,
             String mediaType)
               throws IOException,
                      eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException,
                      eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException,
                      DriverException,
                      eu.europeana.cloud.service.mcs.exception.MCSException

Throws:

IOException

eu.europeana.cloud.service.mcs.exception.RepresentationNotExistsException

eu.europeana.cloud.service.mcs.exception.CannotModifyPersistentRepresentationException

DriverException

eu.europeana.cloud.service.mcs.exception.MCSException

deleteFile

public void deleteFile(String cloudId,
              String representationName,
              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,
                       DriverException,
                       eu.europeana.cloud.service.mcs.exception.MCSException

Deletes existed file.

Parameters:

cloudId - id of deleting file.

representationName - representation name of deleting file.

version - version of deleting file.

fileName - name of deleting file.

Throws:

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

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

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

DriverException - call to service has not succeeded because of server side error.

eu.europeana.cloud.service.mcs.exception.MCSException - on unexpected situations.

getFileUri

public URI getFileUri(String cloudId,
             String representationName,
             String version,
             String fileName)

Retrieve file uri from parameters.

Parameters:

cloudId - id of file.

representationName - representation name of file.

version - version of file.

fileName - name of file.

Returns:

file URI

parseFileUri

public static Map<String,String> parseFileUri(String uri)

Retrieve parts of file uri.

Examples: From this string "http://ecloud.eanadev.org:8080/ecloud-service-mcs/records/L9WSPSMVQ85/representations/edm/versions/b17c4f60-70d0/files" Retrieve: {"CLOUDID": "L9WSPSMVQ85", "REPRESENTATIONNAME": "edm", "VERSION": "b17c4f60-70d0", "FILENAME": null }

From this string "http://ecloud.eanadev.org:8080/ecloud-service-mcs/records/L9WSPSMVQ85/representations/edm/versions/b17c4f60-70d0/files/file1" Retrieve: {"CLOUDID": "L9WSPSMVQ85", "REPRESENTATIONNAME": "edm", "VERSION": "b17c4f60-70d0", "FILENAME": "file1" }

Parameters:

uri - Address of file/files

Returns:

Map with indexes: CLOUDID, REPRESENTATIONNAME, VERSION, FILENAME(potentially null)

useAuthorizationHeader

public FileServiceClient useAuthorizationHeader(String headerValue)

Client will use provided authorization header for all requests;

Parameters:

headerValue - authorization header value

Returns: