com.northconcepts.datapipeline.googledrive

Class GoogleDriveFileSystem

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.internal.lang.FileSystem

com.northconcepts.datapipeline.googledrive.GoogleDriveFileSystem

public class GoogleDriveFileSystem
extends FileSystem

Class for accessing the Google Drive file system.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GOOGLE_FOLDER_TYPE

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
GoogleDriveFileSystem(String appName, String userName, InputStream clientSecrets, File credentialsFolder) Enables access to Google Drive.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Google Drive connection.
String	getFileId(String fileName) Returns the first occurence of the Google Drive File Id with the matching fileName.
String	getFolderId(String folderName) Returns the first occurence of the Google Drive Folder Id with the matching folderName.
List<File>	listFolder(String folderName) Returns a List of all Google Drive files and folders under the specified folder.
List<File>	listRootFolder() Returns a List of all Google Drive files and folders.
void	open() Opens a connection to the Google Drive file system.
InputStream	readFile(String fileName) Reads the first occurence of a Google Drive File with matching fileName.
InputStream	readFile(String folderName, String fileName) Reads the first occurence of a Google Drive File with matching fileName in the specified folderName.
OutputStream	writeFile(String fileName) Writes the file to the Google Drive File System.
OutputStream	writeFile(String folderName, String fileName) Write the file to the specified folder.

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, addExceptionProperties, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getNestedEndpoint, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getRootEndpoint, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription, toString

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Field Detail

GOOGLE_FOLDER_TYPE

public static final String GOOGLE_FOLDER_TYPE

See Also:

Constant Field Values

Constructor Detail

GoogleDriveFileSystem

public GoogleDriveFileSystem(String appName,
                             String userName,
                             InputStream clientSecrets,
                             File credentialsFolder)

Enables access to Google Drive.

Parameters:

appName - application name to use when connecting to Google Drive

userName - the username of the Google Drive account

clientSecrets - the JSON file client secret provided by Google Drive

credentialsFolder - the folder to store the Google Drive Credentials

Method Detail

open

public void open()
          throws DataException

Opens a connection to the Google Drive file system.

Overrides:

open in class Endpoint

Throws:

DataException

close

public void close()
           throws DataException

Closes the Google Drive connection.

Overrides:

close in class Endpoint

Throws:

DataException

listFolder

public List<File> listFolder(String folderName)
                      throws Throwable

Returns a List of all Google Drive files and folders under the specified folder.

Parameters:

folderName - name of the folder

Returns:

the contents as a List or null if none is found

Throws:

Throwable

listRootFolder

public List<File> listRootFolder()
                          throws Throwable

Returns a List of all Google Drive files and folders. Including files in the trash.

Returns:

the contents as a List

Throws:

Throwable

readFile

public InputStream readFile(String fileName)
                     throws Throwable

Reads the first occurence of a Google Drive File with matching fileName. It's possible that multiple files will have the same file name but different file ids.

Parameters:

fileName - the file name to read.

Returns:

an InputStream

Throws:

Throwable

readFile

public InputStream readFile(String folderName,
                            String fileName)
                     throws Throwable

Reads the first occurence of a Google Drive File with matching fileName in the specified folderName. It's possible that multiple files will have the same file name but different file ids.

Parameters:

folderName - the folder the file belongs to

fileName - the name of the file

Returns:

an InputStream

Throws:

Throwable

writeFile

public OutputStream writeFile(String fileName)
                       throws Throwable

Writes the file to the Google Drive File System. It's possible that multiple files will have the same file name but different file ids.

Parameters:

fileName - the name of the file

Returns:

an OutputStream for writing

Throws:

Throwable

writeFile

public OutputStream writeFile(String folderName,
                              String fileName)
                       throws Throwable

Write the file to the specified folder. It's possible in Google Drive that multiple files or folders will have the same name but different file ids.

Parameters:

folderName - the name of the folder

fileName - the name of the file

Returns:

an OutputStream for writing

Throws:

Throwable

getFolderId

public String getFolderId(String folderName)
                   throws Throwable

Returns the first occurence of the Google Drive Folder Id with the matching folderName.

Parameters:

folderName - the name of the folder to search for

Returns:

the folder id or null if none is found

Throws:

Throwable

getFileId

public String getFileId(String fileName)
                 throws Throwable

Returns the first occurence of the Google Drive File Id with the matching fileName.

Parameters:

fileName -

Returns:

the file id of the first occurence of fileName

Throws:

Throwable