com.liferay.document.library.opener.google.drive

Interface DLOpenerGoogleDriveManager

Deprecated.

As of Mueller (7.2.x), with no direct replacement

@Deprecated
public interface DLOpenerGoogleDriveManager

Performs operations on a Google Drive file that is related (linked) to a local FileEntry.

When a file entry is linked to a Google Drive file, both represent the same contents. The file entry keeps some state regarding its linked Google Drive file. The methods in this interface automatically perform this linking and unlinking. The links are represented by DLOpenerGoogleDriveFileReference.

Method Summary

Modifier and Type	Method and Description
DLOpenerGoogleDriveFileReference	checkOut(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry) Deprecated. Creates a new file in Google Drive with the same content as a file entry, and returns a reference to that Google Drive file.
DLOpenerGoogleDriveFileReference	create(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry) Deprecated. Creates a new empty Google Drive file that is linked to a file entry, and returns a reference to that Google Drive file.
void	delete(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry) Deprecated. Deletes the Google Drive file linked to a file entry.
java.lang.String	getAuthorizationURL(long companyId, java.lang.String state, java.lang.String redirectUri) Deprecated. Returns the Google Drive authorization URL for use with OAuth 2.
boolean	hasValidCredential(long companyId, long userId) Deprecated. Returns true if the user has a valid credential.
boolean	isConfigured(long companyId) Deprecated. Returns true if the Google Drive connection is configured.
boolean	isGoogleDriveFile(com.liferay.portal.kernel.repository.model.FileEntry fileEntry) Deprecated. Returns true if a file entry is linked to a Google Drive file.
void	requestAuthorizationToken(long companyId, long userId, java.lang.String code, java.lang.String redirectUri) Deprecated. Requests an authorization token.
DLOpenerGoogleDriveFileReference	requestEditAccess(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry) Deprecated. Requests Google Drive permissions to edit a file entry.
default void	setAuthorizationToken(long companyId, long userId, java.lang.String authorizationToken) Deprecated. Sets an authorization token.

Method Detail

checkOut

DLOpenerGoogleDriveFileReference checkOut(long userId,
                                          com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Creates a new file in Google Drive with the same content as a file entry, and returns a reference to that Google Drive file. The Google Drive file's ID is stored alongside the file entry's ID.

Note that this method does not check out the file entry in the portal. To do so, see com.liferay.document.library.kernel.service.DLAppService#checkOutFileEntry( long, ServiceContext).

Parameters:

userId - the primary key of the user performing the operation

fileEntry - the file entry

Returns:

the reference to the Google Drive file

Throws:

com.liferay.portal.kernel.exception.PortalException - if an error occurs while performing the operation

create

DLOpenerGoogleDriveFileReference create(long userId,
                                        com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
                                 throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Creates a new empty Google Drive file that is linked to a file entry, and returns a reference to that Google Drive file.

This operation is similar to checkOut(long, FileEntry), but doesn't copy the file entry's content to Google Drive. When you know the file entry is empty (e.g., you're creating a new one), this operation is much more efficient than checkOut(long, FileEntry).

Parameters:

userId - the primary key of the user performing the operation

fileEntry - the file entry

Returns:

the reference to the new Google Drive file

Throws:

com.liferay.portal.kernel.exception.PortalException

delete

void delete(long userId,
            com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
     throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Deletes the Google Drive file linked to a file entry. Note that this method doesn't delete the file entry; it only deletes the file in Google Drive.

Parameters:

userId - the primary key of the user performing the operation

fileEntry - the file entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getAuthorizationURL

java.lang.String getAuthorizationURL(long companyId,
                                     java.lang.String state,
                                     java.lang.String redirectUri)
                              throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Returns the Google Drive authorization URL for use with OAuth 2.

Parameters:

companyId - the ID of the company

state - the user interaction's current state

redirectUri - the URL to redirect to when authorization completes

Returns:

the authorization URL

Throws:

com.liferay.portal.kernel.exception.PortalException

hasValidCredential

boolean hasValidCredential(long companyId,
                           long userId)
                    throws java.io.IOException,
                           com.liferay.portal.kernel.exception.PortalException

Deprecated.

Returns true if the user has a valid credential. The credential is stored as part of the OAuth 2 authorization flow.

Parameters:

companyId -

userId - the primary key of the user

Returns:

true if the user has a valid credential; false otherwise

Throws:

java.io.IOException - if an error occurs while checking for the credential

com.liferay.portal.kernel.exception.PortalException

isConfigured

boolean isConfigured(long companyId)

Deprecated.

Returns true if the Google Drive connection is configured. If this method returns false, the rest of the method's behavior is undefined.

Parameters:

companyId - the ID of the company

Returns:

true if the Google Drive connection is configured; false otherwise

isGoogleDriveFile

boolean isGoogleDriveFile(com.liferay.portal.kernel.repository.model.FileEntry fileEntry)

Deprecated.

Returns true if a file entry is linked to a Google Drive file.

Parameters:

fileEntry - the file entry

Returns:

true if the file entry is linked to a Google Drive file; false otherwise

requestAuthorizationToken

void requestAuthorizationToken(long companyId,
                               long userId,
                               java.lang.String code,
                               java.lang.String redirectUri)
                        throws java.io.IOException,
                               com.liferay.portal.kernel.exception.PortalException

Deprecated.

Requests an authorization token. This method should be used only as part of the OAuth 2 authorization flow with Google Drive.

Parameters:

companyId -

userId - the primary key of the user in the OAuth 2 authorization flow

code - the code received as part of the OAuth 2 authorization flow

redirectUri - the redirect URI

Throws:

java.io.IOException - if an error occurs during the OAuth 2 authorization flow

com.liferay.portal.kernel.exception.PortalException

requestEditAccess

DLOpenerGoogleDriveFileReference requestEditAccess(long userId,
                                                   com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated.

Requests Google Drive permissions to edit a file entry. If this request is sucessful, this method returns a reference to the Google Drive file.

For this method to succeed, the user must have completed the OAuth 2 authorization flow and have a valid credential (see hasValidCredential(long, long)).

Parameters:

userId - the primary key of the user requesting edit access

fileEntry - the file entry

Returns:

the Google Drive file reference

Throws:

com.liferay.portal.kernel.exception.PortalException - if the user doesn't have permission to edit the file

setAuthorizationToken

default void setAuthorizationToken(long companyId,
                                   long userId,
                                   java.lang.String authorizationToken)
                            throws java.io.IOException,
                                   com.liferay.portal.kernel.exception.PortalException

Deprecated.

Sets an authorization token. This method should be used to skip the OAuth 2 authorization flow with Google Drive if a valid token is already available.

Parameters:

companyId -

userId - the primary key of the user in the OAuth 2 authorization flow

authorizationToken - the authorization token

Throws:

java.io.IOException

com.liferay.portal.kernel.exception.PortalException