com.brightech.mb.workflow.js

Class ManagedFolder

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

All Implemented Interfaces:

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

public class ManagedFolder
extends JSBaseScriptableObject
implements IFolderObject

This class should be used for access to directories managed by MediaBeacon

See Also:

Serialized Form

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

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theRelativePath) Creates a managed folder instance.
java.lang.String	(JavaScript Function) getAbsolutePath() Get the folder's absolute path.
FileAndFolderIterator	(JavaScript Function) getContents(int theDepth) Gets all files and folders in the folder.
boolean	(JavaScript Function) isBundle() Check if the folder is a bundle
void	(JavaScript Function) lock() Creates a MediaBeacon-managed lock on this ManagedFolder.
void	(JavaScript Function) unlock() Unlocks this managed folder.
Bundle	(JavaScript Getter) bundle() Get the bundle control file for a folder
int	(JavaScript Getter) directoryId()
boolean	(JavaScript Getter) exists() Checks if this folder exists on the server's file system.
java.lang.String	(JavaScript Getter) name() Returns the name of the directory.
IFolderObject	(JavaScript Getter) parent() Returns the parent directory.
java.lang.String	(JavaScript Getter) path() Get the folder's path relative to the MediaBeacon asset root folder.

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

Constructor Detail

ManagedFolder

public ManagedFolder()

Method Detail

jsConstructor

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

Creates a managed folder instance.

Parameters:

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

Throws:

InvalidManagedFolderPathException - if the folder is not found or isn't managed by MediaBeacon.

(JavaScript Getter) path

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

Get the folder's path relative to the MediaBeacon asset root folder. Will return an empty string if this is the MediaBeacon asset root folder. The path will contain unix-style file separators regardless of what file system hosts the assets. This path will include a trailing file separator unless it is the asset root folder.

Specified by:

(JavaScript Getter) path in interface IFolderObject

Returns:

Get the folder's path relative to the MediaBeacon asset root folder. Will return an empty string if this is the MediaBeacon asset root folder. The path will contain unix-style file separators regardless of what file system hosts the assets. This path will include a trailing file separator. This path will include a trailing file separator unless it is the asset root folder.

(JavaScript Function) getAbsolutePath

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

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

Returns:

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

(JavaScript Function) lock

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

Creates a MediaBeacon-managed lock on this ManagedFolder. Only one thread may hold a lock on a folder at a time. Therefore this function can be used to prevent modification of a folder by other threads while some block of javascript executes. If the folder 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 folder is locked MediaBeacon will delay or prevent users' actions on the folder. The folder 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 folder to be modified when locked. Locking does not prevent a folder 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 folder 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 ManagedFolder object is stale and the folder it references has been deleted, renamed or moved since this ManagedFolder object was constructed.

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

(JavaScript Function) unlock

public void (JavaScript Function) unlock()

Unlocks this managed folder.

(JavaScript Getter) exists

public boolean (JavaScript Getter) exists()

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

Specified by:

(JavaScript Getter) exists in interface IFolderObject

Returns:

true if the file or directory exists.

(JavaScript Getter) name

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

Returns the name of the directory.

Specified by:

(JavaScript Getter) name in interface IFolderObject

Returns:

returns the name of the file or directory.

(JavaScript Getter) parent

public IFolderObject (JavaScript Getter) parent()

Returns the parent directory.

Specified by:

(JavaScript Getter) parent in interface IFolderObject

Returns:

the IFileObject represents parent file or directory.

(JavaScript Function) isBundle

public boolean (JavaScript Function) isBundle()

Check if the folder is a bundle

Returns:

true if the folder is a bundle, false otherwise

(JavaScript Getter) bundle

public Bundle (JavaScript Getter) bundle()

Get the bundle control file for a folder

Returns:

the bundle control file if it exists, null otherwise

(JavaScript Function) getContents

public FileAndFolderIterator (JavaScript Function) getContents(int theDepth)

Gets all files and folders in the folder.

Parameters:

theDepth - the depth of the recursion, if it is not specified or null then the method returns all files and folders at any depth.

Returns:

the files iterator.

(JavaScript Getter) directoryId

public int (JavaScript Getter) directoryId()