org.nuxeo.ecm.liveconnect.dropbox

Class DropboxBlobProvider

java.lang.Object

org.nuxeo.ecm.core.blob.AbstractBlobProvider

org.nuxeo.ecm.liveconnect.core.AbstractLiveConnectBlobProvider<DropboxOAuth2ServiceProvider>

org.nuxeo.ecm.liveconnect.dropbox.DropboxBlobProvider

All Implemented Interfaces:

BlobProvider, DocumentBlobProvider, LiveConnectBlobProvider<DropboxOAuth2ServiceProvider>, BatchUpdateBlobProvider

public class DropboxBlobProvider
extends AbstractLiveConnectBlobProvider<DropboxOAuth2ServiceProvider>

Provider for blobs getting information from Dropbox.

Since:

7.3

Field Summary

Fields inherited from class org.nuxeo.ecm.core.blob.AbstractBlobProvider

blobProviderId, properties

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

MAX_RESULT

Constructor Summary

Constructors

Constructor and Description
DropboxBlobProvider()

Method Summary

Modifier and Type	Method and Description
protected InputStream	doGet(URI url) Executes a GET request
ManagedBlob	freezeVersion(ManagedBlob blob, Document doc) Returns a new managed blob pointing to a fixed version of the original 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 String	getCacheName()
protected String	getClientId()
InputStream	getConvertedStream(ManagedBlob blob, String mimeType, DocumentModel doc) Gets an InputStream for a conversion to the given MIME type.
protected com.dropbox.core.v2.DbxClientV2	getDropboxClient(com.google.api.client.auth.oauth2.Credential credential)
protected com.dropbox.core.v2.DbxClientV2	getDropboxClient(String accessToken)
String	getPageProviderNameForUpdate()
InputStream	getStream(ManagedBlob blob) Gets an InputStream for the data of a managed blob.
InputStream	getThumbnail(ManagedBlob blob) Gets an InputStream for a thumbnail of a managed blob.
URI	getURI(ManagedBlob blob, BlobManager.UsageHint usage, javax.servlet.http.HttpServletRequest servletRequest) Gets an URI for the content of a managed blob.
protected LiveConnectFile	retrieveFile(LiveConnectFileInfo fileInfo) Retrieves the file with API.

Methods inherited from class org.nuxeo.ecm.liveconnect.core.AbstractLiveConnectBlobProvider

asURI, buildBlobKey, checkChangesAndUpdateBlob, close, getCredential, getCredential, getCredential, getCredentialFactory, getFile, getFileFromCache, getFromCache, getOAuth2Provider, hasChanged, invalidateInCache, isVersion, performsExternalAccessControl, processDocumentsUpdate, putFileInCache, putInCache, readBlob, toBlob, toBlob, toFileInfo, toFileInfo, writeBlob

Methods inherited from class org.nuxeo.ecm.core.blob.AbstractBlobProvider

getProperties, hasCreateFromKeyPermission, initialize, isTransient, supportsUserUpdate, supportsUserUpdateDefaultFalse, supportsUserUpdateDefaultTrue

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

canConvert, getAppLinks, getBinaryManager, getProperties, hasCreateFromKeyPermission, initialize, isTransient, supportsUserUpdate

Constructor Detail

DropboxBlobProvider

public DropboxBlobProvider()

Method Detail

getCacheName

protected String getCacheName()

Specified by:

getCacheName in class AbstractLiveConnectBlobProvider<DropboxOAuth2ServiceProvider>

getPageProviderNameForUpdate

public String getPageProviderNameForUpdate()

Specified by:

getPageProviderNameForUpdate in class AbstractLiveConnectBlobProvider<DropboxOAuth2ServiceProvider>

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.

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.

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.

Parameters:

blob - the managed blob

Returns:

the stream

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.

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: DocumentBlobProvider

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.

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

freezeVersion

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

Description copied from interface: DocumentBlobProvider

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

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

getDropboxClient

protected com.dropbox.core.v2.DbxClientV2 getDropboxClient(com.google.api.client.auth.oauth2.Credential credential)
                                                    throws IOException

Throws:

IOException

getDropboxClient

protected com.dropbox.core.v2.DbxClientV2 getDropboxClient(String accessToken)
                                                    throws IOException

Throws:

IOException

doGet

protected InputStream doGet(URI url)
                     throws IOException

Executes a GET request

Throws:

IOException

getClientId

protected String getClientId()

retrieveFile

protected LiveConnectFile retrieveFile(LiveConnectFileInfo fileInfo)
                                throws IOException

Description copied from class: AbstractLiveConnectBlobProvider

Retrieves the file with API.

Specified by:

retrieveFile in class AbstractLiveConnectBlobProvider<DropboxOAuth2ServiceProvider>

Parameters:

fileInfo - the file info

Returns:

the file retrieved from API

Throws:

IOException