com.brightech.mb.workflow.js

Class JSPreviewManager

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.JSPreviewManager

All Implemented Interfaces:

com.brightech.mb.preview.ITaskConstants, com.brightech.utils.Metrics, 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 JSPreviewManager
extends JSBaseScriptableObject
implements com.brightech.utils.Metrics, com.brightech.mb.preview.ITaskConstants

Provides access to a preview manager for javascript objects Is available in workflow context pre-initialized as "previewManager"

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

Modifier and Type	Field and Description
static com.brightech.xmp.XmpFieldName	kS3OriginalMD5Field

Fields inherited from class com.brightech.xmp.js.ReleasableScriptableObject

myLogger

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface com.brightech.utils.Metrics

kDay, kDurationFormat, kGb, kHour, kHourDurationFormat, kKb, kMb, kMinute, kMinutesInHour, kSecond, kSecondInMinute, kWeek, kYear, kYearInSeconds

Fields inherited from interface com.brightech.mb.preview.ITaskConstants

kConvertCommand, kCutVideoCommand, kEmbeddedTranscoding, kFieldUrl, kFileConversion, kInfoCommand, kMBTaskProtocol, kPageUrl, kPostConvert, kPreConvert, kRecache, kSaveContentCommand, kScriptCommand, kTranscodingUrl, kViewUrl

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSPreviewManager()

Method Summary

Modifier and Type	Method and Description
void	jsFunction_addRequest(java.lang.String theFormat, int theAssetId, User theUser, java.lang.String theOutputPath, java.lang.String theScale, java.lang.String theResolution, java.lang.String theColorspace) Deprecated. use JSPreviewManager.jsFunction_addRequestForAsset(int, User, Parameters) instead
int	jsFunction_addRequestForAsset(int theAssetId, User theUser, Parameters theParameters) Add loading dock request to queue.
int	jsFunction_addRequestForAssetWithPreset(int theAssetId, User theUser, java.lang.String thePresetName, java.lang.String theOutputPath) Adds request to queue with given conversion preset.
java.lang.String	jsFunction_addRequestForFile(java.lang.String theFilePath, java.lang.String theOutPath, java.lang.String theFormat, boolean theWait) Add a request for any file to be converted to a new format.
java.lang.String	jsFunction_addRequestForFileTempOutput(java.lang.String theFilePath, java.lang.String theFormat, boolean theWait) Add a request for any file to be converted to a new format and automatically create a temporary output path.
void	jsFunction_addScriptRequest(ManagedFile theAsset, java.lang.String theOutputPath, java.lang.String theScriptPath, java.lang.Boolean theEditsOriginal, Parameters theParameters) Add a request to have the preview system execute a script asynchronously.
boolean	jsFunction_addViewRequest(int theAssetId, java.lang.String theView) Put a request into the preview system to generate any missing "onDemand" views.
void	jsFunction_clearImageReHashConfig() Reset config attained while reHashing of all images.
void	jsFunction_extractAndWriteContent(int theAssetId) Extracts and writes content for the specified asset.
DuplicateAssets[]	jsFunction_getDuplicates() Returns all duplicate assets
void	jsFunction_regeneratePreview(ManagedFile theFile) Regenerate previews for a specific asset
void	jsFunction_removeCurrentlyProcessingRequests(int theAssetId) Removes any currently processing high-res requests from Asset View.
boolean	jsFunction_setPreviewFromFile(int theAssetId, FileBase theFile, java.lang.String theView) Sets a particular preview for an asset id from a file.
void	jsFunction_updateHashOfImageAsset(boolean theTruncateTable, int theTimeoutLimitInMin, boolean theImageDedupEnabled) All images will be rehashed with this invocation Only if the status of rehash is stopped this will terminate.

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

Field Detail

kS3OriginalMD5Field

public static com.brightech.xmp.XmpFieldName kS3OriginalMD5Field

Constructor Detail

JSPreviewManager

public JSPreviewManager()

Method Detail

jsFunction_regeneratePreview

public void jsFunction_regeneratePreview(ManagedFile theFile)
                                  throws com.brightech.mb.web.fs.FileSystemException

Regenerate previews for a specific asset

Parameters:

theFile - the file to regenerate previews for

Throws:

com.brightech.mb.web.fs.FileSystemException - exception throw if issue w/file

jsFunction_addRequest

@Deprecated
public void jsFunction_addRequest(java.lang.String theFormat,
                                               int theAssetId,
                                               User theUser,
                                               java.lang.String theOutputPath,
                                               java.lang.String theScale,
                                               java.lang.String theResolution,
                                               java.lang.String theColorspace)

Deprecated. use JSPreviewManager.jsFunction_addRequestForAsset(int, User, Parameters) instead

Add loading dock request to queue. Conversion is asynchronously executed.

Parameters:

theFormat - the format, e.g. "JPEG", "PNG", etc. (Refer Conversion Type Appendix in MediaBeacon Documentation for Valid Formats).

theAssetId - the asset ID, an integer.

theUser - the user object.

theOutputPath - the output path If a custom output path is defined, the request will not appear in the loading dock.

theScale - the scale to convert to. E.g. "50%x50%".

theResolution - the resolution to convert to. E.g. "72dpi", "300dpi", or "350x400" (pixels).

theColorspace - the colorspace to convert to. E.g. "RGB".

jsFunction_addScriptRequest

public void jsFunction_addScriptRequest(ManagedFile theAsset,
                                        java.lang.String theOutputPath,
                                        java.lang.String theScriptPath,
                                        java.lang.Boolean theEditsOriginal,
                                        Parameters theParameters)

Add a request to have the preview system execute a script asynchronously. Added to the preview queue, not the loading dock queue.

Parameters:

theAsset - The original asset to generate a preview of.

theOutputPath - The file to output the preview to.

theScriptPath - The script to run.

theEditsOriginal - Does the script edit the original asset?

theParameters - Additional optional parameters to pass to the script worker (these paramters do not necessarily propagate to the script itself).

jsFunction_getDuplicates

public DuplicateAssets[] jsFunction_getDuplicates()

Returns all duplicate assets

Returns:

array of DuplicateAsset object

jsFunction_updateHashOfImageAsset

public void jsFunction_updateHashOfImageAsset(boolean theTruncateTable,
                                              int theTimeoutLimitInMin,
                                              boolean theImageDedupEnabled)

All images will be rehashed with this invocation Only if the status of rehash is stopped this will terminate.

jsFunction_clearImageReHashConfig

public void jsFunction_clearImageReHashConfig()

Reset config attained while reHashing of all images.

jsFunction_addRequestForAsset

public int jsFunction_addRequestForAsset(int theAssetId,
                                         User theUser,
                                         Parameters theParameters)
                                  throws java.lang.InterruptedException

Add loading dock request to queue. Conversion is asynchronously executed.
Required Parameters:
'format' - used to define the format of conversion(Ex: JPEG, PNG, GIF, etc..)
'outputPath' - used to mention the relative path where the converted asset needs to be placed.
'wait' - used to wait until preview is generated for converted asset.
Optional Parameters:
'destinationColorspace' - used to explicitly change the colorspace.(Ex: 'RGB', 'CMYK', 'GRAY')
'resolution' - used to set density(Ex: 72dpi, 300dpi or "350x400" (pixels))
'scale' - used to set the width x height(Ex: 100x100, 640x640)

Parameters:

theAssetId - the asset ID

theUser - the user

theParameters - the parameters for the conversion

Throws:

java.lang.InterruptedException - Thrown if this method is interrupted. Workflows should rethrow this exception if they catch it to ensure that interrupted workflows terminate properly.

jsFunction_addRequestForAssetWithPreset

public int jsFunction_addRequestForAssetWithPreset(int theAssetId,
                                                   User theUser,
                                                   java.lang.String thePresetName,
                                                   java.lang.String theOutputPath)
                                            throws java.lang.InterruptedException

Adds request to queue with given conversion preset.

Parameters:

theAssetId - the asset id

theUser - the user

thePresetName - the preset name

theOutputPath - the output path. Default path will be built if output path is null (optional)

Returns:

the id of converted asset

Throws:

java.lang.InterruptedException - thrown if this method is interrupted

jsFunction_addRequestForFile

public java.lang.String jsFunction_addRequestForFile(java.lang.String theFilePath,
                                                     java.lang.String theOutPath,
                                                     java.lang.String theFormat,
                                                     boolean theWait)
                                              throws java.net.MalformedURLException,
                                                     java.lang.InterruptedException

Add a request for any file to be converted to a new format.

Parameters:

theFilePath - Full path of file to be converted

theOutPath - Full path of conversion output

theFormat - the format, e.g. "JPEG", "PNG", etc. (Refer Conversion Type Appendix in MediaBeacon Documentation for Valid Formats).

theWait - true to wait for processing to complete, false otherwise

Returns:

Download URL for converted file

Throws:

java.net.MalformedURLException - Error creating downoad url

java.lang.InterruptedException - Thrown if this method is interrupted. Workflows should rethrow this exception if they catch it to ensure that interrupted workflows terminate properly.

jsFunction_addRequestForFileTempOutput

public java.lang.String jsFunction_addRequestForFileTempOutput(java.lang.String theFilePath,
                                                               java.lang.String theFormat,
                                                               boolean theWait)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException

Add a request for any file to be converted to a new format and automatically create a temporary output path.

Parameters:

theFilePath - Full path of file to be converted

theFormat - the format, e.g. "JPEG", "PNG", etc. (Refer Conversion Type Appendix in MediaBeacon Documentation for Valid Formats).

theWait - true to wait for processing to complete, false otherwise

Returns:

Download URL for converted file

Throws:

java.io.IOException - Error creating temp file or download url

java.lang.InterruptedException - Thrown if this method is interrupted. Workflows should rethrow this exception if they catch it to ensure that interrupted workflows terminate properly.

jsFunction_addViewRequest

public boolean jsFunction_addViewRequest(int theAssetId,
                                         java.lang.String theView)

Put a request into the preview system to generate any missing "onDemand" views.

Parameters:

theAssetId - the asset id to generate the views for

theView - the specific view to generate (at present, we simply generate all on demand views and save to the db)

Returns:

true if a view task has been added, false otherwise

jsFunction_extractAndWriteContent

public void jsFunction_extractAndWriteContent(int theAssetId)

Extracts and writes content for the specified asset.

Parameters:

theAssetId - the asset ID.

jsFunction_setPreviewFromFile

public boolean jsFunction_setPreviewFromFile(int theAssetId,
                                             FileBase theFile,
                                             java.lang.String theView)
                                      throws java.io.IOException

Sets a particular preview for an asset id from a file.

Parameters:

theAssetId - we are setting the preview on.

theFile - the file we are getting the preview from.

theView - the view we want to set (high, viewex, thumbnails).

Returns:

whether or not the preview set was successful.

Throws:

java.io.IOException

jsFunction_removeCurrentlyProcessingRequests

public void jsFunction_removeCurrentlyProcessingRequests(int theAssetId)

Removes any currently processing high-res requests from Asset View.

Parameters:

theAssetId - the asset id to remove request for