com.brightech.mb.workflow.js

Class JSS3Manager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSS3Manager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable

public class JSS3Manager
extends JSBaseScriptableObject

Can get s3 asset urls by way of an asset id. Is available in workflow context pre-initialized as "s3Manager"

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSS3Manager()

Method Summary

Modifier and Type	Method and Description
java.lang.String	jsFunction_copyAssetsWithPresignedUrl(java.lang.String thePresignedUrl, java.lang.String theFileName)
boolean	jsFunction_copyObject(java.lang.String theCurrentObjectKey, java.lang.String theNewObjectKey) Copy an object in the current S3 Bucket
boolean	jsFunction_copyObjectToAlternateBucket(java.lang.String theCurrentBucket, java.lang.String theCurrentObjectKey, java.lang.String theNewBucket, java.lang.String theNewObjectKey) Copy an object between buckets
int	jsFunction_createPlaceholderWithObjectKey(java.lang.String theUsername, java.lang.String theObjectKey, java.lang.String theFileName, java.lang.String theDestination)
java.lang.String	jsFunction_createXmpSyncedFile(java.lang.String theRelativePath, java.lang.String theOutFilePath, boolean thePutInBucket) get a file from s3 and sync the xmp from the given place holder path
void	jsFunction_deleteObject(java.lang.String theObjectKey)
int	jsFunction_doS3Upload(java.lang.String theUsername, FileBase theFile, java.lang.String theDestination) Upload the file from the workflow to S3 and init placeholder
java.lang.String	jsFunction_doS3UploadAsync(java.lang.String theUsername, FileBase theFile, java.lang.String theDestination) Upload the file from the workflow to S3 and submit request to create a placeholder asset.
java.util.List	jsFunction_getAwsRenditionKeyData(int theAssetID) Returns the AWS form S3 Rendition Object Key as List
void	jsFunction_getFilesFromS3(org.mozilla.javascript.NativeArray theObjectKeys) pull s3 files down to the object key location
java.lang.String	jsFunction_getObjectKey(java.lang.String thePath) get the object key for the droplet with this path
long	jsFunction_getObjectSize(java.lang.String theObjectKey)
java.lang.String	jsFunction_getPlaceHolderPathForKey(java.lang.String theKey, java.lang.String theUsername) get the path for the place holder from the object key
java.lang.String	jsFunction_getS3FilePath(java.lang.String theAssetId, boolean theSyncXmp) Returns the absolute path to the cached file from S3
java.lang.String	jsFunction_getS3Url(int theAssetId) Gets a temporary S3 url for the given asset.
java.lang.String	jsFunction_getTranscodingObjectKey(java.lang.String thePath, java.lang.String theProfile) get the object key for the droplet with this path and the given video profile.
java.lang.String	jsFunction_moveAndSyncS3Objects(java.lang.String theUploadTime, org.mozilla.javascript.NativeArray theObjectKeys, java.lang.String theUsername, int theTotal, boolean theSkipArchives) sync the assets from s3 to MB
boolean	jsFunction_publishRenditionToS3(FileBase theFile, java.lang.String thePresetName, int thePrimaryAssetID) Upload rendition file to S3.
void	jsFunction_putObject(java.lang.String theKey, IFileObject theFile)
void	jsFunction_syncMBtoS3(org.mozilla.javascript.NativeArray theAssetIds) sync files in MB to s3
boolean	jsFunction_unpublishRenditionFromS3(int theAssetID, java.lang.String thePresetNames) Unpublish rendition file from S3.
java.util.List	jsFunction_unzipAndUpload(java.lang.String theTempFileName) Unzipping the files that are already stored in the m-pushtodam folder is performed based on the filename.
boolean	jsFunction_uploadWithToken(java.lang.String theAccessId, java.lang.String theAccessSecret, java.lang.String theSessionToken, java.lang.String theBucket, java.lang.String theObjectKey, java.lang.String theAssetPath) Deprecated.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSS3Manager

public JSS3Manager()

Method Detail

jsFunction_getS3Url

public java.lang.String jsFunction_getS3Url(int theAssetId)

Gets a temporary S3 url for the given asset. NOTE: metadata will not be synced to the link that will be provided (as it is directly from S3).

Parameters:

theAssetId - the asset id to use.

Returns:

a string, which is the temporary url for the associated S3 object.

jsFunction_uploadWithToken

@Deprecated
public boolean jsFunction_uploadWithToken(java.lang.String theAccessId,
                                                       java.lang.String theAccessSecret,
                                                       java.lang.String theSessionToken,
                                                       java.lang.String theBucket,
                                                       java.lang.String theObjectKey,
                                                       java.lang.String theAssetPath)

Deprecated.

upload a file to S3 using temporary credentials

Parameters:

theAccessId - the temp access id

theAccessSecret - the temp secret

theSessionToken - the required session token

theBucket - the bucket name

theObjectKey - the object key(file path in bucket)

theAssetPath - the file to be uploaded

Returns:

true if upload succeeds, false if not

jsFunction_doS3Upload

public int jsFunction_doS3Upload(java.lang.String theUsername,
                                 FileBase theFile,
                                 java.lang.String theDestination)
                          throws jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

Upload the file from the workflow to S3 and init placeholder

Parameters:

theUsername - the upload user

theFile - the file being uploaded

theDestination - the destination folder

Returns:

an asset id that is matched to the placeholder asset

Throws:

jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

jsFunction_copyAssetsWithPresignedUrl

public java.lang.String jsFunction_copyAssetsWithPresignedUrl(java.lang.String thePresignedUrl,
                                                              java.lang.String theFileName)

jsFunction_createPlaceholderWithObjectKey

public int jsFunction_createPlaceholderWithObjectKey(java.lang.String theUsername,
                                                     java.lang.String theObjectKey,
                                                     java.lang.String theFileName,
                                                     java.lang.String theDestination)
                                              throws jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

Throws:

jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

jsFunction_doS3UploadAsync

public java.lang.String jsFunction_doS3UploadAsync(java.lang.String theUsername,
                                                   FileBase theFile,
                                                   java.lang.String theDestination)
                                            throws jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

Upload the file from the workflow to S3 and submit request to create a placeholder asset.

Parameters:

theUsername - the upload user

theFile - the file being uploaded

theDestination - the destination folder

Returns:

the file action id

Throws:

jb.gwt_main_modules.base_widgets.client.exceptions.NotLoggedInException

jsFunction_publishRenditionToS3

public boolean jsFunction_publishRenditionToS3(FileBase theFile,
                                               java.lang.String thePresetName,
                                               int thePrimaryAssetID)
                                        throws com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

Upload rendition file to S3.

Parameters:

theFile - the file being uploaded

thePresetName - the preset Name used for generating object ID and logging metrics

thePrimaryAssetID - the original asset ID used for generating object ID and logging metrics

Returns:

status of upload

Throws:

com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

jsFunction_unpublishRenditionFromS3

public boolean jsFunction_unpublishRenditionFromS3(int theAssetID,
                                                   java.lang.String thePresetNames)
                                            throws com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

Unpublish rendition file from S3.

Parameters:

theAssetID -

thePresetNames -

Returns:

Throws:

com.brightech.xmp.model.xmlmodel.MalformedXmpFieldException

jsFunction_getAwsRenditionKeyData

public java.util.List jsFunction_getAwsRenditionKeyData(int theAssetID)

Returns the AWS form S3 Rendition Object Key as List

Parameters:

theAssetID - the asset for which Rendition Object Key required

Returns:

List of S3 Rendition Object Key

jsFunction_moveAndSyncS3Objects

public java.lang.String jsFunction_moveAndSyncS3Objects(java.lang.String theUploadTime,
                                                        org.mozilla.javascript.NativeArray theObjectKeys,
                                                        java.lang.String theUsername,
                                                        int theTotal,
                                                        boolean theSkipArchives)

sync the assets from s3 to MB

Parameters:

theUploadTime - the progressId

theObjectKeys - the object keys

theUsername - the user

theTotal - the total files in the upload

theSkipArchives - should we sync archives

Returns:

the asset relative paths as a comma-separated string

jsFunction_getObjectKey

public java.lang.String jsFunction_getObjectKey(java.lang.String thePath)

get the object key for the droplet with this path

Parameters:

thePath - the droplets file path

Returns:

the s3 object key

jsFunction_getTranscodingObjectKey

public java.lang.String jsFunction_getTranscodingObjectKey(java.lang.String thePath,
                                                           java.lang.String theProfile)

get the object key for the droplet with this path and the given video profile.

Parameters:

thePath - the droplets file path

theProfile - the video profile

Returns:

the s3 object key

jsFunction_getPlaceHolderPathForKey

public java.lang.String jsFunction_getPlaceHolderPathForKey(java.lang.String theKey,
                                                            java.lang.String theUsername)

get the path for the place holder from the object key

Parameters:

theKey - the object key

theUsername - the user name

Returns:

the path

jsFunction_getFilesFromS3

public void jsFunction_getFilesFromS3(org.mozilla.javascript.NativeArray theObjectKeys)

pull s3 files down to the object key location

Parameters:

theObjectKeys -

jsFunction_syncMBtoS3

public void jsFunction_syncMBtoS3(org.mozilla.javascript.NativeArray theAssetIds)

sync files in MB to s3

Parameters:

theAssetIds -

jsFunction_copyObject

public boolean jsFunction_copyObject(java.lang.String theCurrentObjectKey,
                                     java.lang.String theNewObjectKey)

Copy an object in the current S3 Bucket

Parameters:

theCurrentObjectKey - existing object key

theNewObjectKey - target object key, to be copied to

Returns:

true if copy succeeds

jsFunction_copyObjectToAlternateBucket

public boolean jsFunction_copyObjectToAlternateBucket(java.lang.String theCurrentBucket,
                                                      java.lang.String theCurrentObjectKey,
                                                      java.lang.String theNewBucket,
                                                      java.lang.String theNewObjectKey)

Copy an object between buckets

Parameters:

theCurrentBucket - Source bucket name

theCurrentObjectKey - Source object key in source bucket

theNewBucket - Target bucket name

theNewObjectKey - Target object key in target bucket

Returns:

true if copy succeeds

jsFunction_getObjectSize

public long jsFunction_getObjectSize(java.lang.String theObjectKey)

Parameters:

theObjectKey -

Returns:

jsFunction_deleteObject

public void jsFunction_deleteObject(java.lang.String theObjectKey)

jsFunction_putObject

public void jsFunction_putObject(java.lang.String theKey,
                                 IFileObject theFile)

jsFunction_getS3FilePath

public java.lang.String jsFunction_getS3FilePath(java.lang.String theAssetId,
                                                 boolean theSyncXmp)

Returns the absolute path to the cached file from S3

Parameters:

theAssetId - The asset ID

Returns:

The absolute path to the file

jsFunction_createXmpSyncedFile

public java.lang.String jsFunction_createXmpSyncedFile(java.lang.String theRelativePath,
                                                       java.lang.String theOutFilePath,
                                                       boolean thePutInBucket)

get a file from s3 and sync the xmp from the given place holder path

Parameters:

theRelativePath - the placeholder

theOutFilePath - the destination file

thePutInBucket - should we push the file back to the bucket with the relative path as its key

jsFunction_unzipAndUpload

public java.util.List jsFunction_unzipAndUpload(java.lang.String theTempFileName)

Unzipping the files that are already stored in the m-pushtodam folder is performed based on the filename. The extracted content is then uploaded to the default bucket using multipart upload.

Parameters:

theTempFileName - Name of the zip file which needs to be extracted

Returns: