org.nuxeo.ecm.liveconnect.google.drive

Class GoogleDriveBlobProvider

java.lang.Object

org.nuxeo.ecm.liveconnect.google.drive.GoogleDriveBlobProvider

All Implemented Interfaces:

BlobProvider, BatchUpdateBlobProvider

public class GoogleDriveBlobProvider
extends Object
implements BlobProvider, BatchUpdateBlobProvider

Provider for blobs getting information from Google Drive.

Since:

7.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleDriveBlobProvider.FileInfo Information about a file stored in Google Drive.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BLOB_CONVERSION_BLOB
protected static String	BLOB_CONVERSION_KEY
protected static String	BLOB_CONVERSIONS_FACET
protected static String	BLOB_CONVERSIONS_PROPERTY
static String	CLIENT_ID_PROP
static String	DEFAULT_EXPORT_MIMETYPE
protected static com.google.api.client.util.ObjectParser	JSON_PARSER
static int	PREFERRED_ICON_SIZE
static String	PREFIX
static String	SERVICE_ACCOUNT_ID_PROP
static String	SERVICE_ACCOUNT_P12_PATH_PROP

Fields inherited from interface org.nuxeo.ecm.liveconnect.update.BatchUpdateBlobProvider

MAX_RESULT

Constructor Summary

Constructors

Constructor and Description
GoogleDriveBlobProvider()

Method Summary

Modifier and Type	Method and Description
protected static URI	asURI(String link) Parse a URI.
List<DocumentModel>	checkChangesAndUpdateBlob(List<DocumentModel> docs) Check the given list of document for change and update if needed.
void	close() Closes this blob provider and releases resources that may be held by it.
protected InputStream	doGet(String user, URI url) Executes a GET request with the user's credentials.
protected <T> T	executeAndCache(String cacheKey, com.google.api.services.drive.DriveRequest<T> request, Class<T> aClass) Executes a DriveRequest and caches the unparsed response.
ManagedBlob	freezeVersion(ManagedBlob blob, Document doc) Returns a new managed blob pointing to a fixed version of the original blob.
protected String	getAlternateUrl(ManagedBlob blob)
protected com.google.api.services.drive.model.App	getApp(String user, String appId)
List<AppLink>	getAppLinks(String username, ManagedBlob blob) Returns a list of application links for the given blob.
Map<String,URI>	getAvailableConversions(ManagedBlob blob, BlobManager.UsageHint hint) Gets a map of available MIME type conversions and corresponding URI for a managed blob.
protected ManagedBlob	getBlob(GoogleDriveBlobProvider.FileInfo fileInfo) Gets the blob for a Google Drive file.
String	getBlobPrefix()
protected Cache	getCache()
String	getClientId()
InputStream	getConvertedStream(ManagedBlob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
protected com.google.api.client.auth.oauth2.Credential	getCredential(String user)
protected CredentialFactory	getCredentialFactory()
protected String	getDigest(com.google.api.services.drive.model.File file)
protected String	getDownloadUrl(ManagedBlob blob) Gets the URL to which we can redirect to let the user download the file.
protected String	getEmbedUrl(ManagedBlob blob) Gets the URL to which we can redirect to let the user see a preview of the file.
protected Map<String,String>	getExportLinks(ManagedBlob blob) Gets the export link.
protected com.google.api.services.drive.model.File	getFile(GoogleDriveBlobProvider.FileInfo fileInfo) Retrieves a File resource and caches the unparsed response.
protected GoogleDriveBlobProvider.FileInfo	getFileInfo(ManagedBlob blob) Removes the prefix from the key.
protected String	getKey(GoogleDriveBlobProvider.FileInfo fileInfo) Adds the prefix to the key.
protected OAuth2ServiceProvider	getOAuth2Provider()
String	getPageProviderNameForUpdate()
protected com.google.api.services.drive.model.File	getPartialFile(String user, String fileId, String... fields) Retrieve a partial File resource.
protected com.google.api.services.drive.model.Revision	getRevision(GoogleDriveBlobProvider.FileInfo fileInfo) Retrieves a Revision resource and caches the unparsed response.
protected com.google.api.services.drive.model.RevisionList	getRevisionList(GoogleDriveBlobProvider.FileInfo fileInfo) Retrieves the list of Revision resources for a file.
protected com.google.api.services.drive.Drive	getService(String user)
protected String	getServiceUser(String username)
InputStream	getStream(ManagedBlob blob) Gets an InputStream for the data of a managed blob.
protected InputStream	getStream(ManagedBlob blob, URI uri)
protected String	getStreamUrl(ManagedBlob blob) Gets the URL from which we can stream the content of the file.
InputStream	getThumbnail(ManagedBlob blob) Gets an InputStream for a thumbnail of a managed blob.
protected String	getThumbnailUrl(ManagedBlob blob) Gets the URL from which we can stream a thumbnail.
URI	getURI(ManagedBlob blob, BlobManager.UsageHint usage, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a managed blob.
void	initialize(String blobProviderId, Map<String,String> properties) Initializes the blob provider.
protected boolean	isChanged(Blob blob, com.google.api.services.drive.model.File file)
protected boolean	isDigestChanged(Blob blob, com.google.api.services.drive.model.File file)
protected boolean	isFilenameChanged(Blob blob, com.google.api.services.drive.model.File file)
boolean	isVersion(ManagedBlob blob) Returns true if version of the blob is a version.
Blob	readBlob(BlobManager.BlobInfo blobInfo) Reads a Blob from storage.
protected Blob	retrieveBlobConversion(ManagedBlob blob, String mimeType, DocumentModel doc) Retrieve a stored conversion of the given blob
protected void	storeBlobConversion(Document doc, String blobKey, Blob blob) Store a conversion of the given blob
boolean	supportsWrite() Checks if write is supported
String	writeBlob(Blob blob, Document doc) Writes a Blob to storage and returns information about it.

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

getBinaryManager

Methods inherited from interface org.nuxeo.ecm.liveconnect.update.BatchUpdateBlobProvider

processDocumentsUpdate

Field Detail

PREFERRED_ICON_SIZE

public static final int PREFERRED_ICON_SIZE

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

SERVICE_ACCOUNT_ID_PROP

public static final String SERVICE_ACCOUNT_ID_PROP

See Also:

Constant Field Values

SERVICE_ACCOUNT_P12_PATH_PROP

public static final String SERVICE_ACCOUNT_P12_PATH_PROP

See Also:

Constant Field Values

CLIENT_ID_PROP

public static final String CLIENT_ID_PROP

See Also:

Constant Field Values

DEFAULT_EXPORT_MIMETYPE

public static final String DEFAULT_EXPORT_MIMETYPE

See Also:

Constant Field Values

BLOB_CONVERSIONS_FACET

protected static final String BLOB_CONVERSIONS_FACET

See Also:

Constant Field Values

BLOB_CONVERSIONS_PROPERTY

protected static final String BLOB_CONVERSIONS_PROPERTY

See Also:

Constant Field Values

BLOB_CONVERSION_KEY

protected static final String BLOB_CONVERSION_KEY

See Also:

Constant Field Values

BLOB_CONVERSION_BLOB

protected static final String BLOB_CONVERSION_BLOB

See Also:

Constant Field Values

JSON_PARSER

protected static final com.google.api.client.util.ObjectParser JSON_PARSER

Constructor Detail

GoogleDriveBlobProvider

public GoogleDriveBlobProvider()

Method Detail

initialize

public void initialize(String blobProviderId,
                       Map<String,String> properties)
                throws IOException

Description copied from interface: BlobProvider

Initializes the blob provider.

Specified by:

initialize in interface BlobProvider

Parameters:

blobProviderId - the blob provider id for this binary manager

properties - initialization properties

Throws:

IOException

close

public void close()

Description copied from interface: BlobProvider

Closes this blob provider and releases resources that may be held by it.

Specified by:

close in interface BlobProvider

readBlob

public Blob readBlob(BlobManager.BlobInfo blobInfo)

Description copied from interface: BlobProvider

Reads a Blob from storage.

Specified by:

readBlob in interface BlobProvider

Parameters:

blobInfo - the blob information

Returns:

the blob

supportsWrite

public boolean supportsWrite()

Description copied from interface: BlobProvider

Checks if write is supported

Specified by:

supportsWrite in interface BlobProvider

Returns:

true if write is supported

writeBlob

public String writeBlob(Blob blob,
                        Document doc)

Description copied from interface: BlobProvider

Writes a Blob to storage and returns information about it.

Called to store a user-created blob.

Specified by:

writeBlob in interface BlobProvider

Parameters:

blob - the blob

doc - the document to which this blob belongs

Returns:

the blob key

getURI

public URI getURI(ManagedBlob blob,
                  BlobManager.UsageHint usage,
                  javax.servlet.http.HttpServletRequest servletRequest)
           throws IOException

Description copied from interface: BlobProvider

Gets an URI for the content of a managed blob.

Specified by:

getURI in interface BlobProvider

Parameters:

blob - the managed blob

usage - BlobManager.UsageHint

servletRequest - the servlet request, or null

Returns:

the URI, or null if none available

Throws:

IOException

getAvailableConversions

public Map<String,URI> getAvailableConversions(ManagedBlob blob,
                                               BlobManager.UsageHint hint)
                                        throws IOException

Description copied from interface: BlobProvider

Gets a map of available MIME type conversions and corresponding URI for a managed blob.

Specified by:

getAvailableConversions in interface BlobProvider

Parameters:

blob - the managed blob

hint - BlobManager.UsageHint

Returns:

a map of MIME types and URI, which may be empty

Throws:

IOException

getThumbnail

public InputStream getThumbnail(ManagedBlob blob)
                         throws IOException

Description copied from interface: BlobProvider

Gets an InputStream for a thumbnail of a managed blob.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getThumbnail in interface BlobProvider

Parameters:

blob - the managed blob

Returns:

the stream

Throws:

IOException

getStreamUrl

protected String getStreamUrl(ManagedBlob blob)
                       throws IOException

Gets the URL from which we can stream the content of the file.

Will return null if this is a native Google document.

Throws:

IOException

getDownloadUrl

protected String getDownloadUrl(ManagedBlob blob)
                         throws IOException

Gets the URL to which we can redirect to let the user download the file.

Throws:

IOException

getAlternateUrl

protected String getAlternateUrl(ManagedBlob blob)
                          throws IOException

Throws:

IOException

getEmbedUrl

protected String getEmbedUrl(ManagedBlob blob)
                      throws IOException

Gets the URL to which we can redirect to let the user see a preview of the file.

Throws:

IOException

getThumbnailUrl

protected String getThumbnailUrl(ManagedBlob blob)
                          throws IOException

Gets the URL from which we can stream a thumbnail.

Throws:

IOException

getExportLinks

protected Map<String,String> getExportLinks(ManagedBlob blob)
                                     throws IOException

Gets the export link.

Throws:

IOException

getStream

public InputStream getStream(ManagedBlob blob)
                      throws IOException

Description copied from interface: BlobProvider

Gets an InputStream for the data of a managed blob.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getStream in interface BlobProvider

Parameters:

blob - the managed blob

Returns:

the stream

Throws:

IOException

getConvertedStream

public InputStream getConvertedStream(ManagedBlob blob,
                                      String mimeType,
                                      DocumentModel doc)
                               throws IOException

Description copied from interface: BlobProvider

Gets an InputStream for a conversion to the given MIME type.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getConvertedStream in interface BlobProvider

Parameters:

blob - the managed blob

mimeType - the MIME type to convert to

doc - the document that holds the blob

Returns:

the stream, or null if no conversion is available for the given MIME type

Throws:

IOException

getStream

protected InputStream getStream(ManagedBlob blob,
                                URI uri)
                         throws IOException

Throws:

IOException

getAppLinks

public List<AppLink> getAppLinks(String username,
                                 ManagedBlob blob)
                          throws IOException

Description copied from interface: BlobProvider

Returns a list of application links for the given blob.

Specified by:

getAppLinks in interface BlobProvider

Throws:

IOException

getServiceUser

protected String getServiceUser(String username)

getApp

protected com.google.api.services.drive.model.App getApp(String user,
                                                         String appId)
                                                  throws IOException

Throws:

IOException

freezeVersion

public ManagedBlob freezeVersion(ManagedBlob blob,
                                 Document doc)
                          throws IOException

Description copied from interface: BlobProvider

Returns a new managed blob pointing to a fixed version of the original blob.

Specified by:

freezeVersion in interface BlobProvider

Parameters:

blob - the original managed blob

doc - the document that holds the blob

Returns:

a managed blob with fixed version, or null if no change is needed

Throws:

IOException

storeBlobConversion

protected void storeBlobConversion(Document doc,
                                   String blobKey,
                                   Blob blob)

Store a conversion of the given blob

retrieveBlobConversion

protected Blob retrieveBlobConversion(ManagedBlob blob,
                                      String mimeType,
                                      DocumentModel doc)

Retrieve a stored conversion of the given blob

getBlob

protected ManagedBlob getBlob(GoogleDriveBlobProvider.FileInfo fileInfo)
                       throws IOException

Gets the blob for a Google Drive file.

Parameters:

fileInfo - the file info

Returns:

the blob

Throws:

IOException

getDigest

protected String getDigest(com.google.api.services.drive.model.File file)

isDigestChanged

protected boolean isDigestChanged(Blob blob,
                                  com.google.api.services.drive.model.File file)

isFilenameChanged

protected boolean isFilenameChanged(Blob blob,
                                    com.google.api.services.drive.model.File file)

isChanged

protected boolean isChanged(Blob blob,
                            com.google.api.services.drive.model.File file)

getKey

protected String getKey(GoogleDriveBlobProvider.FileInfo fileInfo)

Adds the prefix to the key.

getFileInfo

protected GoogleDriveBlobProvider.FileInfo getFileInfo(ManagedBlob blob)

Removes the prefix from the key.

getCredential

protected com.google.api.client.auth.oauth2.Credential getCredential(String user)
                                                              throws IOException

Throws:

IOException

getCredentialFactory

protected CredentialFactory getCredentialFactory()

getService

protected com.google.api.services.drive.Drive getService(String user)
                                                  throws IOException

Throws:

IOException

getPartialFile

protected com.google.api.services.drive.model.File getPartialFile(String user,
                                                                  String fileId,
                                                                  String... fields)
                                                           throws IOException

Retrieve a partial File resource.

Throws:

IOException

getFile

protected com.google.api.services.drive.model.File getFile(GoogleDriveBlobProvider.FileInfo fileInfo)
                                                    throws IOException

Retrieves a File resource and caches the unparsed response.

Returns:

a File resource

Throws:

IOException

getRevision

protected com.google.api.services.drive.model.Revision getRevision(GoogleDriveBlobProvider.FileInfo fileInfo)
                                                            throws IOException

Retrieves a Revision resource and caches the unparsed response.

Returns:

a Revision resource

Throws:

IOException

executeAndCache

protected <T> T executeAndCache(String cacheKey,
                                com.google.api.services.drive.DriveRequest<T> request,
                                Class<T> aClass)
                         throws IOException

Executes a DriveRequest and caches the unparsed response.

Throws:

IOException

getRevisionList

protected com.google.api.services.drive.model.RevisionList getRevisionList(GoogleDriveBlobProvider.FileInfo fileInfo)
                                                                    throws IOException

Retrieves the list of Revision resources for a file.

Returns:

a list of Revision resources

Throws:

IOException

doGet

protected InputStream doGet(String user,
                            URI url)
                     throws IOException

Executes a GET request with the user's credentials.

Throws:

IOException

asURI

protected static URI asURI(String link)

Parse a URI.

Returns:

the URI or null if it fails

getCache

protected Cache getCache()

getClientId

public String getClientId()

getOAuth2Provider

protected OAuth2ServiceProvider getOAuth2Provider()

checkChangesAndUpdateBlob

public List<DocumentModel> checkChangesAndUpdateBlob(List<DocumentModel> docs)

Description copied from interface: BatchUpdateBlobProvider

Check the given list of document for change and update if needed. Note that session.save still needs to be called on changed documents.

Specified by:

checkChangesAndUpdateBlob in interface BatchUpdateBlobProvider

Returns:

the list of DocumentModel that have changed

getPageProviderNameForUpdate

public String getPageProviderNameForUpdate()

Specified by:

getPageProviderNameForUpdate in interface BatchUpdateBlobProvider

getBlobPrefix

public String getBlobPrefix()

Specified by:

getBlobPrefix in interface BatchUpdateBlobProvider

isVersion

public boolean isVersion(ManagedBlob blob)

Description copied from interface: BlobProvider

Returns true if version of the blob is a version.

Specified by:

isVersion in interface BlobProvider

Parameters:

blob - the managed blob

Returns:

true if the blob is a version or a revision