com.giavaneers.net.cloudstorage

Class GoogleCloudStorageManagerBase

java.lang.Object

com.giavaneers.net.cloudstorage.GoogleCloudStorageManagerBase

public class GoogleCloudStorageManagerBase
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GoogleCloudStorageManagerBase.MediaHttpUploaderProgressHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	applicationName
protected static HttpTransport	httpTransport
protected static java.lang.String	kCLOUD_STORAGE_SCOPE
protected static JsonFactory	kJSON_FACTORY
static java.util.Map<java.lang.String,java.lang.String>	kMIME_TYPE_MAP
protected static int	kWRITE_MAX_RETRIES
protected static java.io.InputStream	privateKeyInputStream
protected static java.lang.String	serviceAccountId
protected static GoogleCloudStorageManagerBase	sharedInstance
protected static Storage	storage

Constructor Summary

Constructors

Constructor and Description
GoogleCloudStorageManagerBase() Constructor
GoogleCloudStorageManagerBase(java.lang.String serviceAccountId, java.io.InputStream privateKeyInputStream, java.lang.String applicationName) Constructor

Method Summary

Modifier and Type	Method and Description
void	deleteFile(java.lang.String targetURL) Delete file from google cloud storage.
void	deleteFile(java.lang.String targetURL, java.lang.String requestToken, java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback) Delete file from google cloud storage.
void	downloadObject(StorageObject src, java.io.File dst) Download object from google cloud storage.
void	downloadPublicFile(java.lang.String src, java.io.File dst) Download public file from google cloud storage, using non-credentialed http request
boolean	fileExists(java.lang.String targetURL, java.lang.String oemName, long length) Check whether target file exists.
long	fileLength(java.lang.String bucketName, java.lang.String objectName) Check whether target file exists.
protected static java.lang.String	getApplicationName() Get application name.
protected static java.io.InputStream	getCredentialJSONPrivateKeyInputStream() Get credential JSON private key input stream
protected static HttpTransport	getHttpTransport() Get http transport.
java.nio.channels.ReadableByteChannel	getReadableByteChannelFromGoogleCloudStorage(java.lang.String targetURL, java.lang.String oemName, long[] rangeReq) Create a new readable byte channel from the specified source url in google cloud storage.
protected static java.lang.String	getServiceAccountId() Get service account email.
protected static Storage	getStorage() Get storage client.
java.util.List<StorageObject>	listBucket(java.lang.String bucketName) Check whether target file exists.
static GoogleCloudStorageManagerBase	sharedInstance() Get shared instance.
void	writeFile(byte[] bytes, java.lang.String targetURL) Write bytes to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found.
protected void	writeFile(java.io.InputStream srcIn, long srcLength, java.lang.String targetURL, int attempt, java.lang.Object requestToken, java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback) Write file to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found.
protected void	writeFile(java.io.InputStream inStream, long inLength, java.lang.String targetURL, java.lang.Object requestToken, java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback) Write file to google cloud storage.
void	writeFile(java.lang.String srcFilePath, java.lang.String targetURL, java.lang.String requestToken, java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback) Write file to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found.

Methods inherited from class java.lang.Object

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

Field Detail

kCLOUD_STORAGE_SCOPE

protected static final java.lang.String kCLOUD_STORAGE_SCOPE

See Also:

Constant Field Values

kJSON_FACTORY

protected static final JsonFactory kJSON_FACTORY

kWRITE_MAX_RETRIES

protected static final int kWRITE_MAX_RETRIES

See Also:

Constant Field Values

kMIME_TYPE_MAP

public static final java.util.Map<java.lang.String,java.lang.String> kMIME_TYPE_MAP

sharedInstance

protected static GoogleCloudStorageManagerBase sharedInstance

httpTransport

protected static HttpTransport httpTransport

serviceAccountId

protected static java.lang.String serviceAccountId

privateKeyInputStream

protected static java.io.InputStream privateKeyInputStream

applicationName

protected static java.lang.String applicationName

storage

protected static Storage storage

Constructor Detail

GoogleCloudStorageManagerBase

public GoogleCloudStorageManagerBase()

Constructor

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

GoogleCloudStorageManagerBase

public GoogleCloudStorageManagerBase(java.lang.String serviceAccountId,
                                     java.io.InputStream privateKeyInputStream,
                                     java.lang.String applicationName)

Constructor

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

Method Detail

deleteFile

public void deleteFile(java.lang.String targetURL)
                throws java.lang.Exception

Delete file from google cloud storage.

Parameters:

targetURL - destination url

Throws:

java.lang.Exception

history:

Tue Dec 16, 2014 10:30:00 (Giavaneers - LBM) created.

example:

deleteFile

public void deleteFile(java.lang.String targetURL,
                       java.lang.String requestToken,
                       java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback)
                throws java.lang.Exception

Delete file from google cloud storage.

Parameters:

targetURL - destination url

Throws:

java.lang.Exception

history:

Tue Dec 16, 2014 10:30:00 (Giavaneers - LBM) created.

example:

downloadObject

public void downloadObject(StorageObject src,
                           java.io.File dst)
                    throws java.lang.Exception

Download object from google cloud storage.

Parameters:

src - source object

dst - destination file

Throws:

java.lang.Exception

history:

Tue Dec 16, 2014 10:30:00 (Giavaneers - LBM) created.

example:

downloadPublicFile

public void downloadPublicFile(java.lang.String src,
                               java.io.File dst)
                        throws java.io.IOException

Download public file from google cloud storage, using non-credentialed http request

Parameters:

src - source url

dst - destination file

Throws:

java.io.IOException

history:

Tue Dec 16, 2014 10:30:00 (Giavaneers - LBM) created.

example:

fileExists

public boolean fileExists(java.lang.String targetURL,
                          java.lang.String oemName,
                          long length)
                   throws java.lang.Exception

Check whether target file exists. If length >= 0, test includes whether target file length is as specified.

Parameters:

targetURL - target url

oemName - oem

length - target file length

Returns:

true iff target file exists

Throws:

java.lang.Exception

history:

Sun Nov 22, 2015 10:30:00 (Giavaneers - LBM) created.

example:

fileLength

public long fileLength(java.lang.String bucketName,
                       java.lang.String objectName)
                throws java.lang.Exception

Check whether target file exists. If length >= 0, test includes whether target file length is as specified.

Parameters:

targetURL - target url

oemName - oem

length - target file length

Returns:

true iff target file exists

Throws:

java.lang.Exception

history:

Sun Nov 22, 2015 10:30:00 (Giavaneers - LBM) created.

example:

getApplicationName

protected static java.lang.String getApplicationName()

Get application name.

Returns:

application name

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

getCredentialJSONPrivateKeyInputStream

protected static java.io.InputStream getCredentialJSONPrivateKeyInputStream()

Get credential JSON private key input stream

Returns:

service account credential

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

getHttpTransport

protected static HttpTransport getHttpTransport()

Get http transport.

Returns:

http transport.

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

getServiceAccountId

protected static java.lang.String getServiceAccountId()

Get service account email.

Returns:

service account email

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

getStorage

protected static Storage getStorage()
                             throws java.lang.Exception

Get storage client.

Returns:

storage client.

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

getReadableByteChannelFromGoogleCloudStorage

public java.nio.channels.ReadableByteChannel getReadableByteChannelFromGoogleCloudStorage(java.lang.String targetURL,
                                                                                          java.lang.String oemName,
                                                                                          long[] rangeReq)
                                                                                   throws java.lang.Exception

Create a new readable byte channel from the specified source url in google cloud storage. Interpret the url which may contain an iWonder API range request query parameter, create a url connection, and return the connection input stream. A range request query parameter is of the form: range={rangeRequestValue}, where {rangeRequestValue} conforms to the standard http range header specification. For example, to fetch bytes 2039 through 4123 inclusive from an iWonder Bundle, "http://bundles.iwonderbundle.com/Bundle.html/?range=2039-4123"

Parameters:

url - source url without any range request param

rsrcName - resource name

connectTimeoutMsec - connection timeout value

readTimeoutMsec - read timeout value

rangeRequest - range request

Returns:

if asynchronous, null; otherwise HttpConnectionWrapper or Exception

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

listBucket

public java.util.List<StorageObject> listBucket(java.lang.String bucketName)
                                         throws java.lang.Exception

Check whether target file exists. If length >= 0, test includes whether target file length is as specified.

Parameters:

targetURL - target url

oemName - oem

length - target file length

Returns:

true iff target file exists

Throws:

java.lang.Exception

history:

Sun Nov 22, 2015 10:30:00 (Giavaneers - LBM) created.

example:

sharedInstance

public static GoogleCloudStorageManagerBase sharedInstance()

Get shared instance.

Returns:

shared instance.

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

writeFile

public void writeFile(java.lang.String srcFilePath,
                      java.lang.String targetURL,
                      java.lang.String requestToken,
                      java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback)
               throws java.lang.Exception

Write file to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found. As a consequence, until a better solution is found, this implementation retries a number of times in the event this error is encountered.

Parameters:

srcFilePath - source filepath

targetURL - destination url

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

writeFile

public void writeFile(byte[] bytes,
                      java.lang.String targetURL)
               throws java.lang.Exception

Write bytes to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found. As a consequence, until a better solution is found, this implementation retries a number of times in the event this error is encountered.

Parameters:

srcFilePath - source filepath

targetURL - destination url

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

writeFile

protected void writeFile(java.io.InputStream srcIn,
                         long srcLength,
                         java.lang.String targetURL,
                         int attempt,
                         java.lang.Object requestToken,
                         java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback)
                  throws java.lang.Exception

Write file to google cloud storage Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found. As a consequence, until a better solution is found, this implementation retries a number of times in the event this error is encountered.

Parameters:

srcFilePath - source filepath

targetURL - destination url

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example:

writeFile

protected void writeFile(java.io.InputStream inStream,
                         long inLength,
                         java.lang.String targetURL,
                         java.lang.Object requestToken,
                         java.util.function.BiConsumer<java.lang.Object,java.lang.Object> callback)
                  throws java.lang.Exception

Write file to google cloud storage. If input stream length is < 0, upload is streamed using chunked encoding and no total upload length is sent to the server. Note that the upload sometimes fails with a SocketTimeoutException which has been reported numerous times across a number of forums without any good explanation or workaround found. As a consequence, until a better solution is found, this implementation retries a number of times in the event this error is encountered.

Parameters:

srcFilePath - source filepath

targetURL - destination url of the form, 'gs://bucketName/objectPathname'

Throws:

java.lang.Exception

history:

Tue Apr 08, 2014 10:30:00 (Giavaneers - LBM) created.

example: