fr.gouv.vitam.workspace.client

Class WorkspaceClient

java.lang.Object

fr.gouv.vitam.common.client.DefaultClient

fr.gouv.vitam.workspace.client.WorkspaceClient

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, AutoCloseable

public class WorkspaceClient
extends DefaultClient

Workspace client which calls rest services

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INTERNAL_SERVER_ERROR

Fields inherited from interface fr.gouv.vitam.common.client.BasicClient

STATUS_URL

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	bulkGetObjects(String containerName, List<String> objectURIs)
boolean	checkObject(String containerName, String objectId, String digest, DigestType digestAlgorithm) Check object
void	checkStatus() Check the status from the service
void	checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers) Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate
void	close() Close the underneath http client
void	compress(String containerName, CompressInformation compressInformation) Compress
RequestResponse<String>	computeObjectDigest(String containerName, String objectName, DigestType algo) Compute digest for an object
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response) Helper when an error occurs on client usage side to consume response however
long	countObjects(String containerName) Count the number of object in a container
void	createContainer(String containerName) Create container
protected VitamClientException	createExceptionFromResponse(javax.ws.rs.core.Response response) Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.
void	createFolder(String containerName, String folderName) Create a folder
void	deleteContainer(String containerName, boolean recursive) Delete container
void	deleteFolder(String containerName, String folderName) Delete folder
void	deleteObject(String containerName, String objectName) Delete object
protected javax.ws.rs.client.Client	getClient(boolean chunked)
RequestResponse<ContainerInformation>	getContainerInformation(String containerName)
RequestResponse<List<URI>>	getListUriDigitalObjectFromFolder(String containerName, String folderName) Get List of digital object
javax.ws.rs.core.Response	getObject(String containerName, String objectName) Get Object
javax.ws.rs.core.Response	getObject(String containerName, String objectName, long offset, Long maxChunkSize) Get Object at a specific offset and max specific size
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	getObjectInformation(String containerName, String objectName) Get Object Information
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
boolean	isExistingContainer(String containerName) Check if container exists
boolean	isExistingFolder(String containerName, String folderName) Check if folder exists
boolean	isExistingObject(String containerName, String objectName) Check if obejct is existing
protected Future<javax.ws.rs.core.Response>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform an Async HTTP request to the server with full control of action on caller
protected <T> Future<T>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, javax.ws.rs.client.InvocationCallback<T> callback) Perform an Async HTTP request to the server with callback
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, boolean chunkedMode) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, javax.ws.rs.core.MultivaluedMap<String,Object> queryParams, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
void	purgeOldFilesInContainer(String containerName, TimeToLive timeToLive)
void	putObject(String containerName, String objectName, InputStream stream) Put object
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response) This method consume everything (in particular InpuStream) and close the response.
String	toString()
void	uncompressObject(String containerName, String folderName, String archiveType, InputStream inputStreamObject) Uncompress object

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_SERVER_ERROR

protected static final String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

Method Detail

createContainer

public void createContainer(String containerName)
                     throws ContentAddressableStorageServerException

Create container

Parameters:

containerName - the container name

Throws:

ContentAddressableStorageServerException - in case of any other error

deleteContainer

public void deleteContainer(String containerName,
                            boolean recursive)
                     throws ContentAddressableStorageNotFoundException,
                            ContentAddressableStorageServerException

Delete container

Parameters:

containerName - the container name

recursive - true if should be deleted recursively

Throws:

ContentAddressableStorageNotFoundException - if the container could not be found

ContentAddressableStorageServerException - in case of any other error

isExistingContainer

public boolean isExistingContainer(String containerName)
                            throws ContentAddressableStorageServerException

Check if container exists

Parameters:

containerName - the container name

Returns:

true if it exists, false if not

Throws:

ContentAddressableStorageServerException - in case of any error

countObjects

public long countObjects(String containerName)
                  throws ContentAddressableStorageNotFoundException,
                         ContentAddressableStorageServerException

Count the number of object in a container

Parameters:

containerName - the container name

Returns:

the number of objects

Throws:

ContentAddressableStorageNotFoundException - in case the container could not be found

ContentAddressableStorageServerException - in case of any other error

createFolder

public void createFolder(String containerName,
                         String folderName)
                  throws ContentAddressableStorageAlreadyExistException,
                         ContentAddressableStorageServerException

Create a folder

Parameters:

containerName - the container name

folderName - the folder name

Throws:

ContentAddressableStorageAlreadyExistException - in case the folder already exists

ContentAddressableStorageServerException - in case of any other error

deleteFolder

public void deleteFolder(String containerName,
                         String folderName)
                  throws ContentAddressableStorageNotFoundException,
                         ContentAddressableStorageServerException

Delete folder

Parameters:

containerName - the container name

folderName - the folder name

Throws:

ContentAddressableStorageNotFoundException - if the folder does not exist

ContentAddressableStorageServerException - in case of any other error

isExistingFolder

public boolean isExistingFolder(String containerName,
                                String folderName)
                         throws ContentAddressableStorageServerException

Check if folder exists

Parameters:

containerName - the container name

folderName - the folder name

Returns:

true if it exists, false if not

Throws:

ContentAddressableStorageServerException - in case of error

putObject

public void putObject(String containerName,
                      String objectName,
                      InputStream stream)
               throws ContentAddressableStorageServerException

Put object

Parameters:

containerName - the container name

objectName - the object name

stream - the input stream to be put

Throws:

ContentAddressableStorageServerException - in case of error

getObject

public javax.ws.rs.core.Response getObject(String containerName,
                                           String objectName)
                                    throws ContentAddressableStorageNotFoundException,
                                           ContentAddressableStorageServerException

Get Object

Parameters:

containerName - the container name

objectName - the object name

Returns:

the original Response

Throws:

ContentAddressableStorageNotFoundException - in case the object couldnt be found

ContentAddressableStorageServerException - in case of any other error

getObject

public javax.ws.rs.core.Response getObject(String containerName,
                                           String objectName,
                                           long offset,
                                           Long maxChunkSize)
                                    throws ContentAddressableStorageNotFoundException,
                                           ContentAddressableStorageServerException

Get Object at a specific offset and max specific size

Parameters:

containerName - the container name

objectName - the object name

offset - the start offset

maxChunkSize - max chunk size to retrieve

Returns:

the original Response

Throws:

ContentAddressableStorageNotFoundException - in case the object couldnt be found

ContentAddressableStorageServerException - in case of any other error

bulkGetObjects

public javax.ws.rs.core.Response bulkGetObjects(String containerName,
                                                List<String> objectURIs)
                                         throws ContentAddressableStorageServerException,
                                                ContentAddressableStorageNotFoundException

Throws:

ContentAddressableStorageServerException

ContentAddressableStorageNotFoundException

deleteObject

public void deleteObject(String containerName,
                         String objectName)
                  throws ContentAddressableStorageNotFoundException,
                         ContentAddressableStorageServerException

Delete object

Parameters:

containerName - the name of the container

objectName - the name of object

Throws:

ContentAddressableStorageNotFoundException - in case the object could not be found

ContentAddressableStorageServerException - in case of any other error

isExistingObject

public boolean isExistingObject(String containerName,
                                String objectName)
                         throws ContentAddressableStorageServerException

Check if obejct is existing

Parameters:

containerName - the container name

objectName - the object name

Returns:

true if it exist, false if not

Throws:

ContentAddressableStorageServerException - in case of error

getListUriDigitalObjectFromFolder

public RequestResponse<List<URI>> getListUriDigitalObjectFromFolder(String containerName,
                                                                    String folderName)
                                                             throws ContentAddressableStorageServerException

Get List of digital object

Parameters:

containerName - the container name

folderName - the folder name

Returns:

a list of URI

Throws:

ContentAddressableStorageServerException - in case of error

compress

public void compress(String containerName,
                     CompressInformation compressInformation)
              throws ContentAddressableStorageServerException

Compress

Parameters:

containerName - the container name

compressInformation - information on compression

Throws:

ContentAddressableStorageServerException

uncompressObject

public void uncompressObject(String containerName,
                             String folderName,
                             String archiveType,
                             InputStream inputStreamObject)
                      throws ContentAddressableStorageException

Uncompress object

Parameters:

containerName - the name of the container

folderName - the folder name

archiveType - the archive type

inputStreamObject - the input stream to be uncompress

Throws:

ContentAddressableStorageException - in case of error

computeObjectDigest

public RequestResponse<String> computeObjectDigest(String containerName,
                                                   String objectName,
                                                   DigestType algo)
                                            throws ContentAddressableStorageException

Compute digest for an object

Parameters:

containerName - the container name

objectName - the object name

algo - the digest type

Returns:

the computed digest

Throws:

ContentAddressableStorageException - in case of error

getContainerInformation

public RequestResponse<ContainerInformation> getContainerInformation(String containerName)
                                                              throws ContentAddressableStorageNotFoundException,
                                                                     ContentAddressableStorageServerException

Parameters:

containerName - the container name

Returns:

information on the container

Throws:

ContentAddressableStorageNotFoundException - in case the container could not be found

ContentAddressableStorageServerException - in case of any other error

getObjectInformation

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> getObjectInformation(String containerName,
                                                                                     String objectName)
                                                                              throws ContentAddressableStorageNotFoundException,
                                                                                     ContentAddressableStorageServerException

Get Object Information

Parameters:

containerName - the container name

objectName - the object name

Returns:

object information

Throws:

ContentAddressableStorageNotFoundException - in case the object couldnt be found

ContentAddressableStorageServerException - in case of any other error

checkObject

public boolean checkObject(String containerName,
                           String objectId,
                           String digest,
                           DigestType digestAlgorithm)
                    throws ContentAddressableStorageException

Check object

Parameters:

containerName - the name of the container

objectId - the object id

digest - the digest

digestAlgorithm - the digest algorithm

Returns:

true if the object matches

Throws:

ContentAddressableStorageException - in case the object couldnt be found

purgeOldFilesInContainer

public void purgeOldFilesInContainer(String containerName,
                                     TimeToLive timeToLive)
                              throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

staticConsumeAnyEntityAndClose

public static void staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)

This method consume everything (in particular InpuStream) and close the response.

Parameters:

response -

getClient

protected javax.ws.rs.client.Client getClient(boolean chunked)
                                       throws IllegalStateException

Throws:

IllegalStateException

consumeAnyEntityAndClose

public final void consumeAnyEntityAndClose(javax.ws.rs.core.Response response)

Description copied from interface: MockOrRestClient

Helper when an error occurs on client usage side to consume response however

Specified by:

consumeAnyEntityAndClose in interface MockOrRestClient

checkStatus

public void checkStatus()
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

checkStatus

public void checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> queryParams,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

queryParams - query parameters to add to get request, my be null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept,
                                                   boolean chunkedMode)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

chunkedMode - True use default client, else False use non Chunked mode client

Returns:

the response from the server

Throws:

VitamClientInternalException

performAsyncRequest

protected <T> Future<T> performAsyncRequest(String httpMethod,
                                            String path,
                                            javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                            Object body,
                                            javax.ws.rs.core.MediaType contentType,
                                            javax.ws.rs.core.MediaType accept,
                                            javax.ws.rs.client.InvocationCallback<T> callback)
                                     throws VitamClientInternalException

Perform an Async HTTP request to the server with callback

Type Parameters:

T - the type of the Future result (generally Response)

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

callback -

Returns:

the response from the server as Future

Throws:

VitamClientInternalException

performAsyncRequest

protected Future<javax.ws.rs.core.Response> performAsyncRequest(String httpMethod,
                                                                String path,
                                                                javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                                Object body,
                                                                javax.ws.rs.core.MediaType contentType,
                                                                javax.ws.rs.core.MediaType accept)
                                                         throws VitamClientInternalException

Perform an Async HTTP request to the server with full control of action on caller

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server as a Future

Throws:

VitamClientInternalException

createExceptionFromResponse

protected VitamClientException createExceptionFromResponse(javax.ws.rs.core.Response response)

Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.

Parameters:

response - response

Returns:

VitamClientException exception thrown for the response

getResourcePath

public String getResourcePath()

Description copied from interface: MockOrRestClient

Get the resource path of the server.

Specified by:

getResourcePath in interface MockOrRestClient

Returns:

the resource path as string

getServiceUrl

public String getServiceUrl()

Description copied from interface: MockOrRestClient

Get the service URL

Specified by:

getServiceUrl in interface MockOrRestClient

Returns:

the service URL

close

public void close()

Description copied from interface: MockOrRestClient

Close the underneath http client

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object