Package 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, java.lang.AutoCloseable

public class WorkspaceClient
extends DefaultClient

Field Summary

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

STATUS_URL

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	bulkGetObjects(java.lang.String containerName, java.util.List<java.lang.String> objectURIs)
void	checkStatus()	Check the status from the service
void	checkStatus(javax.ws.rs.core.MultivaluedHashMap<java.lang.String,java.lang.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(java.lang.String containerName, CompressInformation compressInformation)
java.lang.String	computeObjectDigest(java.lang.String containerName, java.lang.String objectName, DigestType algo)
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response)	Helper when an error occurs on client usage side to consume response however
void	createContainer(java.lang.String containerName)
void	createFolder(java.lang.String containerName, java.lang.String folderName)
void	deleteContainer(java.lang.String containerName, boolean deleteRecursive)
void	deleteFolder(java.lang.String containerName, java.lang.String folderName)
void	deleteObject(java.lang.String containerName, java.lang.String objectName)
javax.ws.rs.client.Client	getChunkedClient()
javax.ws.rs.client.Client	getClient()
VitamClientFactory<?>	getClientFactory()
RequestResponse<java.util.Map<java.lang.String,FileParams>>	getFilesWithParamsFromFolder(java.lang.String containerName, java.lang.String folderName)
com.fasterxml.jackson.databind.JsonNode	getFreespacePercent()
RequestResponse<java.util.List<java.net.URI>>	getListUriDigitalObjectFromFolder(java.lang.String containerName, java.lang.String folderName)
javax.ws.rs.core.Response	getObject(java.lang.String containerName, java.lang.String objectName)
javax.ws.rs.core.Response	getObject(java.lang.String containerName, java.lang.String objectName, long offset, java.lang.Long maxChunkSize)
java.lang.String	getResourcePath()	Get the resource path of the server.
java.lang.String	getServiceUrl()	Get the service URL
boolean	isExistingContainer(java.lang.String containerName)
boolean	isExistingFolder(java.lang.String containerName, java.lang.String folderName)
boolean	isExistingObject(java.lang.String containerName, java.lang.String objectName)
javax.ws.rs.core.Response	make(VitamRequestBuilder request)
javax.ws.rs.core.Response	makeSpecifyingUrl(VitamRequestBuilder request)
void	purgeOldFilesInContainer(java.lang.String containerName, TimeToLive timeToLive)
void	putAtomicObject(java.lang.String containerName, java.lang.String objectName, java.io.InputStream stream, long size)
void	putObject(java.lang.String containerName, java.lang.String objectName, java.io.InputStream stream)
void	putObject(java.lang.String containerName, java.lang.String objectName, java.lang.Object object)
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)	This method consume everything (in particular InputStream) and close the response.
java.lang.String	toString()
void	uncompressObject(java.lang.String containerName, java.lang.String folderName, java.lang.String archiveType, java.io.InputStream inputStreamObject)

Methods inherited from class java.lang.Object

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

Method Detail

getFreespacePercent

public com.fasterxml.jackson.databind.JsonNode getFreespacePercent()
                                                            throws VitamClientException

Throws:

VitamClientException

createContainer

public void createContainer(java.lang.String containerName)
                     throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

deleteContainer

public void deleteContainer(java.lang.String containerName,
                            boolean deleteRecursive)
                     throws ContentAddressableStorageNotFoundException,
                            ContentAddressableStorageServerException

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

isExistingContainer

public boolean isExistingContainer(java.lang.String containerName)
                            throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

createFolder

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

Throws:

ContentAddressableStorageAlreadyExistException

ContentAddressableStorageServerException

deleteFolder

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

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

isExistingFolder

public boolean isExistingFolder(java.lang.String containerName,
                                java.lang.String folderName)
                         throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

putObject

public void putObject(java.lang.String containerName,
                      java.lang.String objectName,
                      java.io.InputStream stream)
               throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

putObject

public void putObject(java.lang.String containerName,
                      java.lang.String objectName,
                      java.lang.Object object)
               throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

putAtomicObject

public void putAtomicObject(java.lang.String containerName,
                            java.lang.String objectName,
                            java.io.InputStream stream,
                            long size)
                     throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

getObject

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

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

getObject

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

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

bulkGetObjects

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

Throws:

ContentAddressableStorageServerException

ContentAddressableStorageNotFoundException

deleteObject

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

Throws:

ContentAddressableStorageNotFoundException

ContentAddressableStorageServerException

isExistingObject

public boolean isExistingObject(java.lang.String containerName,
                                java.lang.String objectName)
                         throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

getListUriDigitalObjectFromFolder

public RequestResponse<java.util.List<java.net.URI>> getListUriDigitalObjectFromFolder(java.lang.String containerName,
                                                                                       java.lang.String folderName)
                                                                                throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

getFilesWithParamsFromFolder

public RequestResponse<java.util.Map<java.lang.String,FileParams>> getFilesWithParamsFromFolder(java.lang.String containerName,
                                                                                                      java.lang.String folderName)
                                                                                               throws ContentAddressableStorageServerException

Throws:

ContentAddressableStorageServerException

compress

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

Throws:

ContentAddressableStorageServerException

uncompressObject

public void uncompressObject(java.lang.String containerName,
                             java.lang.String folderName,
                             java.lang.String archiveType,
                             java.io.InputStream inputStreamObject)
                      throws ContentAddressableStorageException

Throws:

ContentAddressableStorageException

computeObjectDigest

public java.lang.String computeObjectDigest(java.lang.String containerName,
                                            java.lang.String objectName,
                                            DigestType algo)
                                     throws ContentAddressableStorageException

Throws:

ContentAddressableStorageException

purgeOldFilesInContainer

public void purgeOldFilesInContainer(java.lang.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 InputStream) and close the response.

Parameters:

response -

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<java.lang.String,java.lang.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

getResourcePath

public java.lang.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 java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

makeSpecifyingUrl

public javax.ws.rs.core.Response makeSpecifyingUrl(VitamRequestBuilder request)
                                            throws VitamClientInternalException

Throws:

VitamClientInternalException

make

public javax.ws.rs.core.Response make(VitamRequestBuilder request)
                               throws VitamClientInternalException

Throws:

VitamClientInternalException

getClientFactory

public VitamClientFactory<?> getClientFactory()

getClient

public javax.ws.rs.client.Client getClient()

getChunkedClient

public javax.ws.rs.client.Client getChunkedClient()