Package org.springframework.social.google.api.drive.impl

Class DriveTemplate

java.lang.Object

org.springframework.social.google.api.impl.AbstractGoogleApiOperations

org.springframework.social.google.api.drive.impl.DriveTemplate

All Implemented Interfaces:

DriveOperations

public class DriveTemplate
extends AbstractGoogleApiOperations
implements DriveOperations

DriveOperations implementation.

Author:

Gabriel Axel

Field Summary

Fields inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

isAuthorized, restTemplate

Constructor Summary

Constructors

Constructor	Description
DriveTemplate(org.springframework.web.client.RestTemplate restTemplate, boolean isAuthorized)

Method Summary

Modifier and Type	Method	Description
FileComment	addComment(String fileId, FileComment comment)	Adds a comment to a file
UserPermission	addPermission(String fileId, UserPermission permission, boolean sendNotificationEmails)	Adds a permission to a file
FileProperty	addProperty(String fileId, FileProperty property)	Adds a new property to a file
CommentReply	addReply(String fileId, String commentId, CommentReply reply)	Adds a reply to a file comment
DriveFile	copy(String id)	Create a copy of a file
DriveFile	copy(String id, String[] parentIds)	Create a copy of a file
DriveFile	copy(String id, String[] parentIds, String title)	Create a copy of a file
DriveFile	createFileMetadata(DriveFile metadata)	Creates an empty file with metadata
DriveFile	createFolder(String parentId, String name)	Creates a folder
void	delete(String id)	Permanently deletes a file
org.springframework.core.io.Resource	downloadFile(String id)	Downloads a file from Google Drive.
org.springframework.core.io.Resource	downloadFile(DriveFile file)	Downloads a file from Google Drive.
DriveFileQueryBuilder	driveFileQuery()	Creates a DriveFileQueryBuilder
FileCommentQueryBuilder	fileCommentQueryBuilder(String fileId)	Returns a FileCommentQueryBuilder for listing the comments of a file
DriveAbout	getAbout()	Get general Google Drive details for the current user
DriveApp	getApp(String id)	Returns an application by its ID
List<DriveApp>	getApps()	Returns the applications authorized by the user to access Google Drive API
FileCommentsPage	getComments(String fileId, String pageToken)	Returns the first default page of comments on a file
DriveFile	getFile(String id)	Retrieves a file by its ID
DriveFilesPage	getFiles(String parent, String pageToken)	Returns the files and folders under a specified folder
List<UserPermission>	getPermissions(String fileId)	Returns the permissions of a file
List<FileProperty>	getProperties(String fileId)	Get the custom properties applied to this file
FileProperty	getProperty(String fileId, String propertyKey)	Get a specific custom property applied to this file
List<FileRevision>	getRevisions(String fileId)	Returns the revisions of a file
DriveFilesPage	getRootFiles(String pageToken)	Returns files and folders under the root folder
DriveFilesPage	getTrashedFiles(String pageToken)	Returns trashed files and folders
DriveFile	hide(String id)	Hides a file
DriveFile	move(String id, String parentId)	Move a file into a different folder
void	removeComment(String fileId, String commentId)	Removes a comment from a file
void	removePermission(String fileId, String permissionId)	Removes a permission from a file
void	removeProperty(String fileId, String propertyKey)	Deletes a property
void	removeReply(String fileId, String commentId, String replyId)	Removes a reply from a file comment
DriveFile	star(String id)	Stars a file
DriveFile	trash(String id)	Moves a file to trash
DriveFile	unhide(String id)	Unhides a file
DriveFile	unstar(String id)	Remove the star from a file
DriveFile	untrash(String id)	Restores a file from trash
FileComment	updateComment(String fileId, String commentId, FileComment comment)	Updates a comment to a file
FileProperty	updateProperty(String fileId, FileProperty property)	Updates a property
CommentReply	updateReply(String fileId, String commentId, String replyId, CommentReply reply)	Updates a reply to a file comment
FileRevision	updateRevision(String fileId, String revisionId, FileRevision revision)	Updates a file revision
UserPermission	updatesPermission(String fileId, String permissionId, UserPermission permission)	Updates a permission to a file
DriveFile	upload(org.springframework.core.io.Resource resource, DriveFile metadata, UploadParameters parameters)	Uploads a file using multipart

Methods inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

deleteEntity, deleteEntity, getEntity, patch, requireAuthorization, saveEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

DriveTemplate

public DriveTemplate(org.springframework.web.client.RestTemplate restTemplate,
                     boolean isAuthorized)

Method Detail

getAbout

public DriveAbout getAbout()

Description copied from interface: DriveOperations

Get general Google Drive details for the current user

Specified by:

getAbout in interface DriveOperations

Returns:

DriveAbout with details for the current user

getApps

public List<DriveApp> getApps()

Description copied from interface: DriveOperations

Returns the applications authorized by the user to access Google Drive API

Specified by:

getApps in interface DriveOperations

Returns:

List of DriveApp for the current user

getApp

public DriveApp getApp(String id)

Description copied from interface: DriveOperations

Returns an application by its ID

Specified by:

getApp in interface DriveOperations

Parameters:

id - The ID of the application

Returns:

DriveApp matching the ID

getFile

public DriveFile getFile(String id)

Description copied from interface: DriveOperations

Retrieves a file by its ID

Specified by:

getFile in interface DriveOperations

Parameters:

id - the ID to retrieve by

Returns:

DriveFile matching the ID

driveFileQuery

public DriveFileQueryBuilder driveFileQuery()

Description copied from interface: DriveOperations

Creates a DriveFileQueryBuilder

Specified by:

driveFileQuery in interface DriveOperations

Returns:

a new DriveFileQueryBuilder

getRootFiles

public DriveFilesPage getRootFiles(String pageToken)

Description copied from interface: DriveOperations

Returns files and folders under the root folder

Specified by:

getRootFiles in interface DriveOperations

Parameters:

pageToken - Page token or null

Returns:

DriveFilesPage

getFiles

public DriveFilesPage getFiles(String parent,
                               String pageToken)

Description copied from interface: DriveOperations

Returns the files and folders under a specified folder

Specified by:

getFiles in interface DriveOperations

Parameters:

parent - folder ID or "root"

pageToken - Page token or null

Returns:

DriveFilesPage

getTrashedFiles

public DriveFilesPage getTrashedFiles(String pageToken)

Description copied from interface: DriveOperations

Returns trashed files and folders

Specified by:

getTrashedFiles in interface DriveOperations

Parameters:

pageToken - Page token or null

Returns:

DriveFilesPage

trash

public DriveFile trash(String id)

Description copied from interface: DriveOperations

Moves a file to trash

Specified by:

trash in interface DriveOperations

Parameters:

id - The ID of the file to trash

Returns:

The updated DriveFile

untrash

public DriveFile untrash(String id)

Description copied from interface: DriveOperations

Restores a file from trash

Specified by:

untrash in interface DriveOperations

Parameters:

id - The ID of the file to untrash return The updated DriveFile

Returns:

The trashed DriveFile

star

public DriveFile star(String id)

Description copied from interface: DriveOperations

Stars a file

Specified by:

star in interface DriveOperations

Parameters:

id - The ID of the file to star

Returns:

The updated DriveFile

unstar

public DriveFile unstar(String id)

Description copied from interface: DriveOperations

Remove the star from a file

Specified by:

unstar in interface DriveOperations

Parameters:

id - The ID of the file to unstar

Returns:

The updated DriveFile

hide

public DriveFile hide(String id)

Description copied from interface: DriveOperations

Hides a file

Specified by:

hide in interface DriveOperations

Parameters:

id - The ID of the file to hide

Returns:

The updated DriveFile

unhide

public DriveFile unhide(String id)

Description copied from interface: DriveOperations

Unhides a file

Specified by:

unhide in interface DriveOperations

Parameters:

id - The ID of the file to unhide

Returns:

The updated DriveFile

delete

public void delete(String id)

Description copied from interface: DriveOperations

Permanently deletes a file

Specified by:

delete in interface DriveOperations

Parameters:

id - The ID of the file to delete

copy

public DriveFile copy(String id)

Description copied from interface: DriveOperations

Create a copy of a file

Specified by:

copy in interface DriveOperations

Parameters:

id - The ID of the source file

Returns:

The newly-created DriveFile copy

copy

public DriveFile copy(String id,
                      String[] parentIds)

Description copied from interface: DriveOperations

Create a copy of a file

Specified by:

copy in interface DriveOperations

Parameters:

id - The ID of the source file

parentIds - Array of parent folder ID to place the file into, or "root"

Returns:

The newly-created DriveFile copy

copy

public DriveFile copy(String id,
                      String[] parentIds,
                      String title)

Description copied from interface: DriveOperations

Create a copy of a file

Specified by:

copy in interface DriveOperations

Parameters:

id - The ID of the source file

parentIds - Array of parent folder ID to place the file into, or "root"

title - The title to apply to the new file

Returns:

The newly-created DriveFile copy

move

public DriveFile move(String id,
                      String parentId)

Description copied from interface: DriveOperations

Move a file into a different folder

Specified by:

move in interface DriveOperations

Parameters:

id - The ID of the file to move

parentId - The parent folder ID to move the file to, or "root"

Returns:

The updated DriveFile

upload

public DriveFile upload(org.springframework.core.io.Resource resource,
                        DriveFile metadata,
                        UploadParameters parameters)

Description copied from interface: DriveOperations

Uploads a file using multipart

Specified by:

upload in interface DriveOperations

Parameters:

resource - Reference to the file's content

metadata - The file's metadata

parameters - Parameters for uploading and processing the file

Returns:

The file resource that was created

createFileMetadata

public DriveFile createFileMetadata(DriveFile metadata)

Description copied from interface: DriveOperations

Creates an empty file with metadata

Specified by:

createFileMetadata in interface DriveOperations

Parameters:

metadata - The file's properties

Returns:

DriveFile representing the created file

createFolder

public DriveFile createFolder(String parentId,
                              String name)

Description copied from interface: DriveOperations

Creates a folder

Specified by:

createFolder in interface DriveOperations

Parameters:

parentId - The parent folder ID or "root"

name - The name of the folder to create

Returns:

DriveFile representing the created folder

getPermissions

public List<UserPermission> getPermissions(String fileId)

Description copied from interface: DriveOperations

Returns the permissions of a file

Specified by:

getPermissions in interface DriveOperations

Parameters:

fileId - The ID of the file

Returns:

List of UserPermission for the file

addPermission

public UserPermission addPermission(String fileId,
                                    UserPermission permission,
                                    boolean sendNotificationEmails)

Description copied from interface: DriveOperations

Adds a permission to a file

Specified by:

addPermission in interface DriveOperations

Parameters:

fileId - The file ID

permission - UserPermission with the permission settings

sendNotificationEmails - Whether to send notification e-mails

Returns:

The created UserPermission

updatesPermission

public UserPermission updatesPermission(String fileId,
                                        String permissionId,
                                        UserPermission permission)

Description copied from interface: DriveOperations

Updates a permission to a file

Specified by:

updatesPermission in interface DriveOperations

Parameters:

fileId - The file ID

permissionId - the ID of the permission

permission - UserPermission with new role and additionalRoles properties

Returns:

The updated UserPermission

removePermission

public void removePermission(String fileId,
                             String permissionId)

Description copied from interface: DriveOperations

Removes a permission from a file

Specified by:

removePermission in interface DriveOperations

Parameters:

fileId - The file ID

permissionId - The ID of the permission

getRevisions

public List<FileRevision> getRevisions(String fileId)

Description copied from interface: DriveOperations

Returns the revisions of a file

Specified by:

getRevisions in interface DriveOperations

Parameters:

fileId - The ID of the file

Returns:

List of FileRevision

updateRevision

public FileRevision updateRevision(String fileId,
                                   String revisionId,
                                   FileRevision revision)

Description copied from interface: DriveOperations

Updates a file revision

Specified by:

updateRevision in interface DriveOperations

Parameters:

fileId - The ID of the file

revisionId - The ID of the revision

revision - FileRevision with new pinned, publishAuto, published and publishedOutsideDomain properties

Returns:

The updated FileRevision

fileCommentQueryBuilder

public FileCommentQueryBuilder fileCommentQueryBuilder(String fileId)

Description copied from interface: DriveOperations

Returns a FileCommentQueryBuilder for listing the comments of a file

Specified by:

fileCommentQueryBuilder in interface DriveOperations

Parameters:

fileId - The ID of the file

Returns:

FileCommentQueryBuilder for the file

getComments

public FileCommentsPage getComments(String fileId,
                                    String pageToken)

Description copied from interface: DriveOperations

Returns the first default page of comments on a file

Specified by:

getComments in interface DriveOperations

Parameters:

fileId - The ID of the file

pageToken - Page token or null

Returns:

Page of comments

addComment

public FileComment addComment(String fileId,
                              FileComment comment)

Description copied from interface: DriveOperations

Adds a comment to a file

Specified by:

addComment in interface DriveOperations

Parameters:

fileId - The ID of the file

comment - The new comment

Returns:

The created FileComment

updateComment

public FileComment updateComment(String fileId,
                                 String commentId,
                                 FileComment comment)

Description copied from interface: DriveOperations

Updates a comment to a file

Specified by:

updateComment in interface DriveOperations

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

comment - Comment with the new content

Returns:

The updated FileComment

removeComment

public void removeComment(String fileId,
                          String commentId)

Description copied from interface: DriveOperations

Removes a comment from a file

Specified by:

removeComment in interface DriveOperations

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

addReply

public CommentReply addReply(String fileId,
                             String commentId,
                             CommentReply reply)

Description copied from interface: DriveOperations

Adds a reply to a file comment

Specified by:

addReply in interface DriveOperations

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

reply - The new reply

Returns:

The created CommentReply

updateReply

public CommentReply updateReply(String fileId,
                                String commentId,
                                String replyId,
                                CommentReply reply)

Description copied from interface: DriveOperations

Updates a reply to a file comment

Specified by:

updateReply in interface DriveOperations

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

replyId - The ID of the reply

reply - Reply with new content

Returns:

The updated CommentReply

removeReply

public void removeReply(String fileId,
                        String commentId,
                        String replyId)

Description copied from interface: DriveOperations

Removes a reply from a file comment

Specified by:

removeReply in interface DriveOperations

Parameters:

fileId - The ID of the file

commentId - The ID of the comment

replyId - The ID of the reply

downloadFile

public org.springframework.core.io.Resource downloadFile(String id)

Description copied from interface: DriveOperations

Downloads a file from Google Drive. This method first sends a request to get the download URL, and then another request to download the file.

Specified by:

downloadFile in interface DriveOperations

Parameters:

id - The file ID

Returns:

Resource abstraction for the file

downloadFile

public org.springframework.core.io.Resource downloadFile(DriveFile file)

Description copied from interface: DriveOperations

Downloads a file from Google Drive. This method uses DriveFile.getDownloadUrl(), which may have expired since the file metadata was fetched.

Specified by:

downloadFile in interface DriveOperations

Parameters:

file - The file metadata

Returns:

Resource abstraction for the file

getProperties

public List<FileProperty> getProperties(String fileId)

Description copied from interface: DriveOperations

Get the custom properties applied to this file

Specified by:

getProperties in interface DriveOperations

Parameters:

fileId - The ID of the file

Returns:

The list of properties defined

getProperty

public FileProperty getProperty(String fileId,
                                String propertyKey)

Description copied from interface: DriveOperations

Get a specific custom property applied to this file

Specified by:

getProperty in interface DriveOperations

Parameters:

fileId - The ID of the file

propertyKey - The key of the property

Returns:

The the property information

addProperty

public FileProperty addProperty(String fileId,
                                FileProperty property)

Description copied from interface: DriveOperations

Adds a new property to a file

Specified by:

addProperty in interface DriveOperations

Parameters:

fileId - The ID of the file

property - Property representation

Returns:

The new FileProperty

updateProperty

public FileProperty updateProperty(String fileId,
                                   FileProperty property)

Description copied from interface: DriveOperations

Updates a property

Specified by:

updateProperty in interface DriveOperations

Parameters:

fileId - The ID of the file

property - Property representation

Returns:

The updated FileProperty

removeProperty

public void removeProperty(String fileId,
                           String propertyKey)

Description copied from interface: DriveOperations

Deletes a property

Specified by:

removeProperty in interface DriveOperations

Parameters:

fileId - The ID of the file

propertyKey - The key of the property