Package org.nuxeo.ecm.core.storage.gcp

Class GoogleStorageBinaryManager

java.lang.Object

org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

org.nuxeo.ecm.blob.AbstractCloudBinaryManager

org.nuxeo.ecm.core.storage.gcp.GoogleStorageBinaryManager

All Implemented Interfaces:

BinaryManager, BlobProvider

@Deprecated(since="2023.9")
public class GoogleStorageBinaryManager
extends AbstractCloudBinaryManager

Deprecated.

since 2023.9, use GoogleStorageBlobProvider instead

A Binary Manager that stores binaries as Google Storage BLOBs

The BLOBs are cached locally on first access for efficiency.

Because the BLOB length can be accessed independently of the binary stream, it is also cached in a simple text file if accessed before the stream. Related to GCP credentials, here are the options:

• nuxeo.gcp.credentials=/path/to/file.json
• nuxeo.gcp.credentials=file.json (located in nxserver/config)
• If nothing is set, Nuxeo will look into 'gcp-credentials.json' file by default (located in nxserver/config)

Since:

10.10-HF12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GoogleStorageBinaryManager.GCPFileStorage	Deprecated.
static class	GoogleStorageBinaryManager.GoogleStorageBinaryGarbageCollector	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.cloud.storage.Bucket	bucket	Deprecated.
static final String	BUCKET_NAME_PROPERTY	Deprecated.
static final String	BUCKET_PREFIX_PROPERTY	Deprecated.
protected String	bucketName	Deprecated.
protected String	bucketPrefix	Deprecated.
protected int	chunkSize	Deprecated.
static final int	DEFAULT_UPLOAD_CHUNK_SIZE	Deprecated. Default is taken from BaseWriteChannel.
static final String	DELIMITER	Deprecated.
static final String	GCP_JSON_FILE	Deprecated.
static final String	GOOGLE_APPLICATION_CREDENTIALS	Deprecated.
static final String	GOOGLE_PLATFORM_SCOPE	Deprecated.
static final String	GOOGLE_STORAGE_SCOPE	Deprecated.
static final String	PROJECT_ID_PROPERTY	Deprecated.
protected com.google.cloud.storage.Storage	storage	Deprecated.
static final String	SYSTEM_PROPERTY_PREFIX	Deprecated.
static final String	UPLOAD_CHUNK_SIZE_PROPERTY	Deprecated.

Fields inherited from class org.nuxeo.ecm.blob.AbstractCloudBinaryManager

CACHE_COUNT_PROPERTY, CACHE_MIN_AGE_PROPERTY, CACHE_SIZE_PROPERTY, DEFAULT_CACHE_COUNT, DEFAULT_CACHE_MIN_AGE, DEFAULT_CACHE_SIZE, DEFAULT_DIRECTDOWNLOAD, DEFAULT_DIRECTDOWNLOAD_EXPIRE, DIGEST_ALGORITHM_PROPERTY, directDownload, DIRECTDOWNLOAD_EXPIRE_PROPERTY, DIRECTDOWNLOAD_PROPERTY, directDownloadExpire, namespace, transientFlag

Fields inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

cachedir, fileCache, fileStorage

Fields inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

blobProviderId, DEFAULT_DEPTH, DEFAULT_DIGEST, descriptor, digestPattern, DIGESTS_BY_LENGTH, garbageCollector, MAX_BUF_SIZE, MD5_DIGEST, MD5_DIGEST_LENGTH, MIN_BUF_SIZE, properties, SHA1_DIGEST, SHA1_DIGEST_LENGTH, SHA256_DIGEST, SHA256_DIGEST_LENGTH

Fields inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryManager

PROP_KEY, PROP_PATH

Constructor Summary

Constructors

Constructor	Description
GoogleStorageBinaryManager()	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	deleteBucket(String bucketName)	Deprecated. Deletes a bucket (and all its blobs) with the given bucketName.
com.google.cloud.storage.Bucket	getBucket()	Deprecated.
protected FileStorage	getFileStorage()	Deprecated.
com.google.cloud.storage.Bucket	getOrCreateBucket(String bucketName)	Deprecated. Gets or creates a bucket with the given bucketName.
protected String	getSystemPropertyPrefix()	Deprecated. Gets the prefix used for configuration using system properties.
protected BinaryGarbageCollector	instantiateGarbageCollector()	Deprecated.
protected static boolean	isMD5(String digest)	Deprecated.
void	removeBinaries(Collection<String> digests)	Deprecated. Remove definitively a set of binaries
protected void	removeBinary(String digest)	Deprecated.
protected void	setupCloudClient()	Deprecated. Configure Cloud client using properties

Methods inherited from class org.nuxeo.ecm.blob.AbstractCloudBinaryManager

getBinaryManager, getBooleanProperty, getContentDispositionHeader, getContentTypeHeader, getDefaultDigestAlgorithm, getIntProperty, getIntProperty, getProperties, getProperty, getProperty, getRemoteUri, getSystemPropertyName, getURI, initialize, isDirectDownload, isTransient, performsExternalAccessControl, readBlob, supportsUserUpdate, supportsUserUpdateDefaultTrue, writeBlob

Methods inherited from class org.nuxeo.ecm.core.blob.binary.CachingBinaryManager

close, getBinary, getBinary, getFile, initializeCache, initializeCache, initializeCache

Methods inherited from class org.nuxeo.ecm.core.blob.binary.AbstractBinaryManager

computeDigestPattern, getBinary, getDescriptor, getDigestAlgorithm, getGarbageCollector, isValidDigest, setDescriptor, storeAndDigest, toHexString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.blob.BlobProvider

allowByteRange, allowDirectDownload, canConvert, close, deleteBlob, getAppLinks, getAvailableConversions, getBinaryGarbageCollector, getFile, getStatus, getStream, getStream, getThumbnail, hasCreateFromKeyPermission, isColdStorageMode, isRecordMode, isTransactional, isVersion, readBlob, supportsSync, updateBlob, writeBlob

Field Details

BUCKET_NAME_PROPERTY

public static final String BUCKET_NAME_PROPERTY

Deprecated.

See Also:

• Constant Field Values

BUCKET_PREFIX_PROPERTY

public static final String BUCKET_PREFIX_PROPERTY

Deprecated.

See Also:

• Constant Field Values

UPLOAD_CHUNK_SIZE_PROPERTY

public static final String UPLOAD_CHUNK_SIZE_PROPERTY

Deprecated.

Since:

11.4

See Also:

• Constant Field Values

DEFAULT_UPLOAD_CHUNK_SIZE

public static final int DEFAULT_UPLOAD_CHUNK_SIZE

Deprecated.

Default is taken from BaseWriteChannel.

Since:

11.4

See Also:

• Constant Field Values

PROJECT_ID_PROPERTY

public static final String PROJECT_ID_PROPERTY

Deprecated.

See Also:

• Constant Field Values

GOOGLE_APPLICATION_CREDENTIALS

public static final String GOOGLE_APPLICATION_CREDENTIALS

Deprecated.

See Also:

• Constant Field Values

GOOGLE_PLATFORM_SCOPE

public static final String GOOGLE_PLATFORM_SCOPE

Deprecated.

See Also:

• Constant Field Values

GOOGLE_STORAGE_SCOPE

public static final String GOOGLE_STORAGE_SCOPE

Deprecated.

See Also:

• Constant Field Values

SYSTEM_PROPERTY_PREFIX

public static final String SYSTEM_PROPERTY_PREFIX

Deprecated.

See Also:

• Constant Field Values

DELIMITER

public static final String DELIMITER

Deprecated.

See Also:

• Constant Field Values

GCP_JSON_FILE

public static final String GCP_JSON_FILE

Deprecated.

See Also:

• Constant Field Values

bucketName

protected String bucketName

Deprecated.

bucketPrefix

protected String bucketPrefix

Deprecated.

bucket

protected com.google.cloud.storage.Bucket bucket

Deprecated.

storage

protected com.google.cloud.storage.Storage storage

Deprecated.

chunkSize

protected int chunkSize

Deprecated.

Since:

11.4

Constructor Details

GoogleStorageBinaryManager

public GoogleStorageBinaryManager()

Deprecated.

Method Details

setupCloudClient

protected void setupCloudClient()

Deprecated.

Description copied from class: AbstractCloudBinaryManager

Configure Cloud client using properties

Specified by:

setupCloudClient in class AbstractCloudBinaryManager

getOrCreateBucket

public com.google.cloud.storage.Bucket getOrCreateBucket(String bucketName)

Deprecated.

Gets or creates a bucket with the given bucketName.

Returns:

the bucket instance.

deleteBucket

public boolean deleteBucket(String bucketName)

Deprecated.

Deletes a bucket (and all its blobs) with the given bucketName.

Returns:

boolean if bucket has been deleted or not.

getBucket

public com.google.cloud.storage.Bucket getBucket()

Deprecated.

getFileStorage

protected FileStorage getFileStorage()

Deprecated.

Specified by:

getFileStorage in class AbstractCloudBinaryManager

getSystemPropertyPrefix

protected String getSystemPropertyPrefix()

Deprecated.

Description copied from class: AbstractCloudBinaryManager

Gets the prefix used for configuration using system properties.

Specified by:

getSystemPropertyPrefix in class AbstractCloudBinaryManager

isMD5

protected static boolean isMD5(String digest)

Deprecated.

instantiateGarbageCollector

protected BinaryGarbageCollector instantiateGarbageCollector()

Deprecated.

Specified by:

instantiateGarbageCollector in class AbstractCloudBinaryManager

removeBinaries

public void removeBinaries(Collection<String> digests)

Deprecated.

Description copied from interface: BinaryManager

Remove definitively a set of binaries

Specified by:

removeBinaries in interface BinaryManager

Specified by:

removeBinaries in class AbstractCloudBinaryManager

Parameters:

digests - a set of digests, must not be null.

removeBinary

protected void removeBinary(String digest)

Deprecated.