com.brightech.mb.workflow.js

Class ManagedFile

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Bundle, Workflow

public class ManagedFile
extends JSBaseScriptableObject
implements IFileObject

This class should be used to access to files managed by MediaBeacon, (not folders). This class acts as a substitute for the File class in panel workflows and overrides physical file access methods to compensate for the fact that portals don't have access to the file system.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kManagedFileClassName The default class name.
static java.lang.String	kServerTypeAttribute Server type variable name in the global scope.

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
ManagedFile()

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theRelativePath) Creates a managed file instance.
boolean	(JavaScript Function) applyStampXml(java.lang.String theXml) Apply XML from XMP Stamp panel to the asset.
java.lang.String	(JavaScript Function) getAbsolutePath() Get the file's absolute path.
BufferedReader	(JavaScript Function) getBufferedReader(java.lang.String theEncoding) Returns a BufferedReader for reading the file contents.
BufferedWriter	(JavaScript Function) getBufferedWriter(boolean theAppend, java.lang.String theEncoding) Returns a BufferedWriter for writing the file contents.
FileOutputStream	(JavaScript Function) getFileOutputStream() Gets a FileOutputStream for writing the file contents.
java.lang.String	(JavaScript Function) getFormattedSize() Get the size of the file with units.
java.lang.String	(JavaScript Function) getImageURL(java.lang.String theViewType) Returns the image URL for the specified view type ("thumbnails" or "viewex").
void	(JavaScript Function) lock() Creates a MediaBeacon-managed lock on this ManagedFile.
void	(JavaScript Function) normalizeXmp() Synchronizes XMP and moves resource / sidecar into data fork of file.
void	(JavaScript Function) releaseXmp() Releases the fetched XMP object (if it's been fetched) so its memory can be reclaimed.
void	(JavaScript Function) unlock() Unlocks this managed file.
boolean	(JavaScript Function) writeXmp() Saves xmp changes to the asset (db and file system).
int	(JavaScript Getter) assetId() Returns the asset ID.
java.lang.String	(JavaScript Getter) colorprofile() Returns the image colorprofile
java.lang.String	(JavaScript Getter) colorspace() Returns the image colorspace
java.lang.String	(JavaScript Getter) encodedAssetId() Returns the encoded asset ID.
boolean	(JavaScript Getter) exists() Checks if this file exists on the server's file system.
IFileObject	(JavaScript Getter) file() Returns itself, needed for backwards-compatability.
java.lang.String	(JavaScript Getter) fileNameExtension() Returns the file name extension by parsing the file's name.
java.lang.String	(JavaScript Getter) format() Returns the image format
java.lang.String	(JavaScript Getter) getFileContents() Deprecated.
java.lang.String	(JavaScript Getter) getXmlFileContents() Get the file contents as a string, stripping away invalid Xml characters.
int	(JavaScript Getter) height() Returns the image height
long	(JavaScript Getter) lastModified() Return file modified timestamp in milliseconds.
long	(JavaScript Getter) length() Get the file's content length.
java.lang.String	(JavaScript Getter) name() Returns the name of the file or directory.
IFolderObject	(JavaScript Getter) parent() Returns the parent file o directory.
java.lang.String	(JavaScript Getter) path() Get the file's path relative to the MediaBeacon asset root.
long	(JavaScript Getter) rawLength() Get the raw file size, without metadata
java.lang.Double	(JavaScript Getter) resolution() Get image resolution.
int	(JavaScript Getter) width() Returns the image width
Xmp	(JavaScript Getter) xmp() Gets XMP object.
void	(JavaScript Setter) xmp(java.lang.Object theXmp) Writes the given Xmp object or xmp string to the file

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

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

contextCreated, contextReleased

Field Detail

kManagedFileClassName

public static final java.lang.String kManagedFileClassName

The default class name.

See Also:

Constant Field Values

kServerTypeAttribute

public static final java.lang.String kServerTypeAttribute

Server type variable name in the global scope.

See Also:

Constant Field Values

Constructor Detail

ManagedFile

public ManagedFile()

Method Detail

(JavaScript Getter) assetId

public int (JavaScript Getter) assetId()

Returns the asset ID.

Returns:

the asset ID.

(JavaScript Getter) encodedAssetId

public java.lang.String (JavaScript Getter) encodedAssetId()

Returns the encoded asset ID.

Returns:

the encoded asset ID.

(JavaScript Getter) file

public IFileObject (JavaScript Getter) file()

Returns itself, needed for backwards-compatability.

Returns:

the IFileObject.

See Also:

IFileObject

jsConstructor

public void jsConstructor(java.lang.String theRelativePath)
                   throws InvalidManagedFilePathException

Creates a managed file instance.

Parameters:

theRelativePath - The path, relative to the MediaBeacon asset root, to a file currently managed by MediaBeacon. This path should contain unix-style file separators regardless of what file system hosts the assets.

Throws:

InvalidManagedFilePathException - if the file does not exist or isn't managed by MediaBeacon.

(JavaScript Function) lock

public void (JavaScript Function) lock()
                     throws ConcurentActionsException,
                            java.lang.InterruptedException

Creates a MediaBeacon-managed lock on this ManagedFile. Only one thread may hold a lock on a file at a time. Therefore this function can be used to prevent modification of a file by other threads while some logic executes. If the file is already locked by some other thread, this call will block for up to a system property-configurable amount of time while waiting to obtain the lock. While a file is locked MediaBeacon will delay or prevent users' actions on the file. The file is unlocked at the end of the current execution of a workflow or when (JavaScript Function) unlock() is called. Important note: It is still possible for the file to be modified when locked. Locking does not prevent a file from being modified or removed on the file system or by some external software. Also, a workflow or plugin can take an action on a file without first obtaining a lock on it.

Throws:

ConcurentActionsException - if unable to obtain a lock within the system property-configurable amount of time. Also thrown if this ManagedFile object is stale and the file it references has been deleted, renamed or moved since this ManagedFile object was constructed.

java.lang.InterruptedException - if the thread was interrupted while waiting for the lock.

(JavaScript Function) unlock

public void (JavaScript Function) unlock()

Unlocks this managed file.

(JavaScript Getter) exists

public boolean (JavaScript Getter) exists()

Checks if this file exists on the server's file system.

Specified by:

(JavaScript Getter) exists in interface IFileObject

Returns:

true if the file or directory exists.

(JavaScript Getter) lastModified

public long (JavaScript Getter) lastModified()

Return file modified timestamp in milliseconds. Should not be used on C3ntrifuge nodes, as it requires filesystem access.

Specified by:

(JavaScript Getter) lastModified in interface IFileObject

Returns:

File modified timestamp in milliseconds

(JavaScript Getter) name

public java.lang.String (JavaScript Getter) name()

Description copied from interface: IFileObject

Returns the name of the file or directory.

Specified by:

(JavaScript Getter) name in interface IFileObject

Returns:

returns the name of the file or directory.

(JavaScript Getter) fileNameExtension

public java.lang.String (JavaScript Getter) fileNameExtension()

Returns the file name extension by parsing the file's name.

Specified by:

(JavaScript Getter) fileNameExtension in interface IFileObject

Returns:

the file name extension.

(JavaScript Getter) path

public java.lang.String (JavaScript Getter) path()

Get the file's path relative to the MediaBeacon asset root. The path will contain unix-style file separators regardless of what file system hosts the assets.

Specified by:

(JavaScript Getter) path in interface IFileObject

Returns:

The file's path relative to the MediaBeacon asset root. The path will contain unix-style file separators regardless of what file system hosts the assets.

(JavaScript Function) getAbsolutePath

public java.lang.String (JavaScript Function) getAbsolutePath()

Get the file's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).

Returns:

The file's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).

(JavaScript Getter) parent

public IFolderObject (JavaScript Getter) parent()

Description copied from interface: IFileObject

Returns the parent file o directory.

Specified by:

(JavaScript Getter) parent in interface IFileObject

Returns:

the IFileObject represents parent file or directory.

(JavaScript Function) getFormattedSize

public java.lang.String (JavaScript Function) getFormattedSize()

Get the size of the file with units.

(JavaScript Getter) length

public long (JavaScript Getter) length()

Get the file's content length.

Specified by:

(JavaScript Getter) length in interface IFileObject

Returns:

The length, in bytes, of the file denoted by this abstract pathname, or 0L if the file does not exist.

(JavaScript Getter) rawLength

public long (JavaScript Getter) rawLength()

Get the raw file size, without metadata

(JavaScript Getter) getFileContents

@Deprecated
public java.lang.String (JavaScript Getter) getFileContents()

Deprecated.

Get the file's content as a string.

Specified by:

(JavaScript Getter) getFileContents in interface IFileObject

Returns:

the file contents.

(JavaScript Function) getBufferedReader

public BufferedReader (JavaScript Function) getBufferedReader(java.lang.String theEncoding)
                                            throws java.io.IOException

Returns a BufferedReader for reading the file contents.

Specified by:

(JavaScript Function) getBufferedReader in interface IFileObject

Parameters:

theEncoding - default is UTF-8, can pass others (like UTF-16)

Returns:

a BufferedReader

Throws:

java.io.IOException

See Also:

BufferedReader

(JavaScript Function) getBufferedWriter

public BufferedWriter (JavaScript Function) getBufferedWriter(boolean theAppend,
                                                   java.lang.String theEncoding)
                                            throws java.io.IOException

Returns a BufferedWriter for writing the file contents.

Specified by:

(JavaScript Function) getBufferedWriter in interface IFileObject

Parameters:

theAppend - true if file should be opened for append

theEncoding - default is UTF-8, can pass others (like UTF-16)

Returns:

a BufferedWriter

Throws:

java.io.IOException

See Also:

BufferedWriter

(JavaScript Function) getFileOutputStream

public FileOutputStream (JavaScript Function) getFileOutputStream()
                                                throws java.io.IOException

Gets a FileOutputStream for writing the file contents.

Specified by:

(JavaScript Function) getFileOutputStream in interface IFileObject

Returns:

a FileOutputStream

Throws:

java.io.IOException

(JavaScript Getter) getXmlFileContents

public java.lang.String (JavaScript Getter) getXmlFileContents()

Get the file contents as a string, stripping away invalid Xml characters.

Returns:

String with non-valid Xml characters removed.

(JavaScript Function) applyStampXml

public boolean (JavaScript Function) applyStampXml(java.lang.String theXml)

Apply XML from XMP Stamp panel to the asset.

Parameters:

theXml - the stamper XML

Returns:

true on success, false on error

(JavaScript Getter) xmp

public Xmp (JavaScript Getter) xmp()

Gets XMP object. Fetches XMP from the database if needed.

Specified by:

(JavaScript Getter) xmp in interface IFileObject

Returns:

XMP manipulation object

See Also:

Xmp

(JavaScript Setter) xmp

public void (JavaScript Setter) xmp(java.lang.Object theXmp)

Writes the given Xmp object or xmp string to the file

Parameters:

theXmp -

(JavaScript Function) normalizeXmp

public void (JavaScript Function) normalizeXmp()

Synchronizes XMP and moves resource / sidecar into data fork of file. Should be run with "Requires File System Access" checked.

(JavaScript Function) writeXmp

public boolean (JavaScript Function) writeXmp()

Saves xmp changes to the asset (db and file system).

Specified by:

(JavaScript Function) writeXmp in interface IFileObject

Returns:

written successfully?

(JavaScript Function) releaseXmp

public void (JavaScript Function) releaseXmp()

Releases the fetched XMP object (if it's been fetched) so its memory can be reclaimed. Note: Doesn't write the XMP object, so any unwritten changes will be lost.

(JavaScript Getter) width

public int (JavaScript Getter) width()

Returns the image width

Specified by:

(JavaScript Getter) width in interface IFileObject

Returns:

the image width

(JavaScript Getter) height

public int (JavaScript Getter) height()

Returns the image height

Specified by:

(JavaScript Getter) height in interface IFileObject

Returns:

the image height

(JavaScript Getter) format

public java.lang.String (JavaScript Getter) format()

Returns the image format

Specified by:

(JavaScript Getter) format in interface IFileObject

Returns:

the image format

(JavaScript Getter) colorspace

public java.lang.String (JavaScript Getter) colorspace()

Returns the image colorspace

Specified by:

(JavaScript Getter) colorspace in interface IFileObject

Returns:

the image colorspace

(JavaScript Getter) colorprofile

public java.lang.String (JavaScript Getter) colorprofile()

Returns the image colorprofile

Specified by:

(JavaScript Getter) colorprofile in interface IFileObject

Returns:

the image colorprofile

(JavaScript Getter) resolution

public java.lang.Double (JavaScript Getter) resolution()

Get image resolution.

Specified by:

(JavaScript Getter) resolution in interface IFileObject

Returns:

The image resolution, as a Double.

(JavaScript Function) getImageURL

public java.lang.String (JavaScript Function) getImageURL(java.lang.String theViewType)

Returns the image URL for the specified view type ("thumbnails" or "viewex").

Parameters:

theViewType - the view type ("thumbnails" or "viewex").

Returns:

the URL, or null if this ManagedFile has no image URL.