com.weebly.opus1269.clipman.backup

Class DriveServiceHelper

java.lang.Object

com.weebly.opus1269.clipman.backup.DriveServiceHelper

public class DriveServiceHelper
extends java.lang.Object

Singleton to manage interactions with Google Drive

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	APP_FOLDER App folder on Drive
private java.lang.String	ERR_INTERNAL Error accessing Drive API
private java.lang.String	ERR_PERMISSION No permissions for Drive
private android.content.Context	mAppCtxt Global Application Context
private java.lang.String	MIME_TYPE Mime type of backups
private static DriveServiceHelper	sInstance Static instance
private java.lang.String	TAG Class Indentifier
private int	WAIT_TIME_SECS Timeout for task completion

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DriveServiceHelper(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
private void	checkAppFolderPermission() Check permissions for our appFolder
(package private) Backup	createBackup(java.lang.String filename, byte[] data) Create a new backup
private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.File>	createFile(com.google.api.services.drive.Drive service, java.lang.String fileName, java.util.Map<java.lang.String,java.lang.String> appProperties) Create a zip file in the user's App directory.
(package private) void	deleteBackup(java.lang.String fileId) Delete a backup
private com.google.android.gms.tasks.Task<java.lang.Void>	deleteFile(com.google.api.services.drive.Drive service, java.lang.String fileId) Delete a file on Drive
(package private) BackupContents	getBackupContents(java.lang.String fileId) Get the contents of a backup
java.util.List<Backup>	getBackups() Retrieve all the backups in our appFolder
private com.google.android.gms.tasks.Task<BackupContents>	getContents(com.google.api.services.drive.Drive service, java.lang.String fileId) Get the contents of a backup
private com.google.api.services.drive.Drive	getDriveService() get the DriveService
static DriveServiceHelper	INST(android.content.Context context) Lazily create our instance
private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.FileList>	listFiles(com.google.api.services.drive.Drive service) Get the files in the user's App Data folder
boolean	noAppFolderPermission() No permission for our appFolder
private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.File>	saveContents(com.google.api.services.drive.Drive service, java.lang.String fileId, java.lang.String filename, byte[] contents) Seve a file and its contents
(package private) void	updateBackup(java.lang.String fileId, java.lang.String filename, byte[] data) Update a backup

Methods inherited from class java.lang.Object

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

Field Detail

sInstance

private static DriveServiceHelper sInstance

Static instance

mAppCtxt

private final android.content.Context mAppCtxt

Global Application Context

WAIT_TIME_SECS

private final int WAIT_TIME_SECS

Timeout for task completion

See Also:

Constant Field Values

MIME_TYPE

private final java.lang.String MIME_TYPE

Mime type of backups

See Also:

Constant Field Values

ERR_PERMISSION

private final java.lang.String ERR_PERMISSION

No permissions for Drive

ERR_INTERNAL

private final java.lang.String ERR_INTERNAL

Error accessing Drive API

TAG

private final java.lang.String TAG

Class Indentifier

APP_FOLDER

private final java.lang.String APP_FOLDER

App folder on Drive

See Also:

Constant Field Values

Constructor Detail

DriveServiceHelper

private DriveServiceHelper(@NonNull
                           android.content.Context context)

Method Detail

INST

public static DriveServiceHelper INST(@NonNull
                                      android.content.Context context)

Lazily create our instance

Parameters:

context - any old context

noAppFolderPermission

public boolean noAppFolderPermission()

No permission for our appFolder

getBackups

@NonNull
public java.util.List<Backup> getBackups()
                                            throws java.util.concurrent.ExecutionException,
                                                   java.lang.InterruptedException,
                                                   java.util.concurrent.TimeoutException,
                                                   DriveException

Retrieve all the backups in our appFolder

Returns:

list of backups

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

DriveException

createBackup

@NonNull
Backup createBackup(java.lang.String filename,
                              byte[] data)
                       throws java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException,
                              java.util.concurrent.TimeoutException,
                              DriveException

Create a new backup

Parameters:

filename - name of file

data - contents of file

Returns:

new backup

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

DriveException

updateBackup

void updateBackup(@NonNull
                  java.lang.String fileId,
                  java.lang.String filename,
                  @NonNull
                  byte[] data)
           throws java.util.concurrent.ExecutionException,
                  java.lang.InterruptedException,
                  java.util.concurrent.TimeoutException,
                  DriveException

Update a backup

Parameters:

fileId - file to update

filename - file to update

data - update data

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

DriveException

deleteBackup

void deleteBackup(java.lang.String fileId)
           throws java.util.concurrent.ExecutionException,
                  java.lang.InterruptedException,
                  java.util.concurrent.TimeoutException,
                  DriveException

Delete a backup

Parameters:

fileId - name of file

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

DriveException

getBackupContents

@NonNull
BackupContents getBackupContents(java.lang.String fileId)
                                    throws java.util.concurrent.ExecutionException,
                                           java.lang.InterruptedException,
                                           java.util.concurrent.TimeoutException,
                                           DriveException

Get the contents of a backup

Parameters:

fileId - file to retrieve

Returns:

contents of a backup

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.util.concurrent.TimeoutException

DriveException

createFile

private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.File> createFile(com.google.api.services.drive.Drive service,
                                                                                               java.lang.String fileName,
                                                                                               java.util.Map<java.lang.String,java.lang.String> appProperties)

Create a zip file in the user's App directory.

listFiles

private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.FileList> listFiles(com.google.api.services.drive.Drive service)

Get the files in the user's App Data folder

getContents

private com.google.android.gms.tasks.Task<BackupContents> getContents(com.google.api.services.drive.Drive service,
                                                                      java.lang.String fileId)

Get the contents of a backup

saveContents

private com.google.android.gms.tasks.Task<com.google.api.services.drive.model.File> saveContents(com.google.api.services.drive.Drive service,
                                                                                                 java.lang.String fileId,
                                                                                                 java.lang.String filename,
                                                                                                 byte[] contents)

Seve a file and its contents

deleteFile

private com.google.android.gms.tasks.Task<java.lang.Void> deleteFile(com.google.api.services.drive.Drive service,
                                                                     java.lang.String fileId)

Delete a file on Drive

checkAppFolderPermission

private void checkAppFolderPermission()
                               throws DriveException

Check permissions for our appFolder

Throws:

DriveException

getDriveService

@NonNull
private com.google.api.services.drive.Drive getDriveService()
                                                               throws DriveException

get the DriveService

Throws:

DriveException