UnmanagedFile (MediaBeacon Workflow API)

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

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:

PDF
```
public class UnmanagedFile
extends JSBaseScriptableObject
implements IFileObject
```
The class is for skipping File's method that aren't applicable for files that are out of MBAssets folder.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`kServerTypeAttribute` Server type variable name in the global scope.

Constructor Summary

Constructors
Constructor and Description

UnmanagedFile()

Constructors
Constructor and Description
`UnmanagedFile()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`jsConstructor(java.lang.String thePathName)` Construct a unmanaged file reference to a file that may or may not exist.
`boolean`	`(JavaScript Function) create()` Creates this file and all parent folders.
`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) getRelativePath()` Get the file's path relative to the MediaBeacon asset root.
`boolean`	`(JavaScript Function) writeXmp()` Saves xmp changes to physical file.
`java.lang.String`	`(JavaScript Getter) colorprofile()` Returns the colorprofile format.
`java.lang.String`	`(JavaScript Getter) colorspace()` Returns the colorspace format.
`boolean`	`(JavaScript Getter) exists()` Tests whether the file denoted by this abstract pathname exists.
`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. use getBufferedReader() method instead.
`int`	`(JavaScript Getter) height()` Returns the image height.
`long`	`(JavaScript Getter) lastModified()` Return file modified timestamp in milliseconds
`long`	`(JavaScript Getter) length()` Returns the lenth of the file.
`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()` Returns the file's absolute path.
`java.lang.Double`	`(JavaScript Getter) resolution()` Returns the image resolution.
`int`	`(JavaScript Getter) width()` Returns the image width.
`Xmp`	`(JavaScript Getter) xmp()` Gets XMP block from 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
  - kServerTypeAttribute
```
public static final java.lang.String kServerTypeAttribute
```
    Server type variable name in the global scope.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UnmanagedFile
```
public UnmanagedFile()
```
- Method Detail
  - jsConstructor
```
public void jsConstructor(java.lang.String thePathName)
                   throws java.io.IOException
```
    Construct a unmanaged file reference to a file that may or may not exist. This path can be either absolute or relative to the MediaBeacon asset root folder.
    
    Parameters:
    
    thePathName - the absolute or relative path to the file.
    
    Throws:
    
    java.io.IOException
  - (JavaScript Getter) exists
```
public boolean (JavaScript Getter) exists()
```
    Tests whether the file denoted by this abstract pathname exists.
    
    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
    
    Specified by:
    
    (JavaScript Getter) lastModified in interface IFileObject
    
    Returns:
    
    File modified timestamp in milliseconds
  - (JavaScript Getter) name
```
public java.lang.String (JavaScript Getter) name()
```
    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()
```
    Returns the file's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).
    
    Specified by:
    
    (JavaScript Getter) path in interface IFileObject
    
    Returns:
    
    the file's absolute path. The path will use file separators as appropriate for the file system in use (windows or unix).
  - (JavaScript Function) getRelativePath
```
public java.lang.String (JavaScript Function) getRelativePath()
```
    Get the file's path relative to the MediaBeacon asset root. Returns null if the file is not within the current asset root folder. The path will contain unix-style file separators regardless of what file system hosts the assets.
    
    Returns:
    
    The file's path relative to the MediaBeacon asset root. Returns null if the file is not within the current asset root folder. The path will contain unix-style file separators regardless of what file system hosts the assets.
  - (JavaScript Getter) parent
```
public IFolderObject (JavaScript Getter) parent()
```
    Returns the parent file o directory.
    
    Specified by:
    
    (JavaScript Getter) parent in interface IFileObject
    
    Returns:
    
    the IFileObject represents parent file or directory.
  - (JavaScript Getter) length
```
public long (JavaScript Getter) length()
```
    Returns the lenth of the file.
    
    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) xmp
```
public Xmp (JavaScript Getter) xmp()
```
    Description copied from interface: IFileObject
    
    Gets XMP block from the file.
    
    Specified by:
    
    (JavaScript Getter) xmp in interface IFileObject
    
    Returns:
    
    the Xmp block.
    See Also: Xmp
  (JavaScript Getter) width public int (JavaScript Getter) width() Returns the image width. Specified by: (JavaScript Getter) width in interface IFileObject Returns: the image width in pixels. (JavaScript Getter) height public int (JavaScript Getter) height() Returns the image height. Specified by: (JavaScript Getter) height in interface IFileObject Returns: the image height in pixels. (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 colorspace format. Specified by: (JavaScript Getter) colorspace in interface IFileObject Returns: the colorspace format. (JavaScript Getter) colorprofile public java.lang.String (JavaScript Getter) colorprofile() Returns the colorprofile format. Specified by: (JavaScript Getter) colorprofile in interface IFileObject Returns: the colorprofile format. (JavaScript Getter) resolution public java.lang.Double (JavaScript Getter) resolution() Description copied from interface: IFileObject Returns the image resolution. Specified by: (JavaScript Getter) resolution in interface IFileObject Returns: the image resolution. (JavaScript Getter) getFileContents @Deprecated public java.lang.String (JavaScript Getter) getFileContents() Deprecated. use getBufferedReader() method instead. Returns the file contents. Specified by: (JavaScript Getter) getFileContents in interface IFileObject Returns: the file contents. (JavaScript Function) create public boolean (JavaScript Function) create() throws java.io.IOException Creates this file and all parent folders. Even if the file is within the MediaBeacon asset root folder, no import of the file is triggered by this function, this function only creates the file. However, importantly, the newly created file may still be automatically imported, depending on the configuration of file system events and other requests currently being processed by the system. Returns: true if and only if the directory was created, along with all necessary parent directories; false otherwise Throws: java.io.IOException - If an I/O error occurred (JavaScript Function) writeXmp public boolean (JavaScript Function) writeXmp() Saves xmp changes to physical file. Specified by: (JavaScript Function) writeXmp in interface IFileObject Returns: written successfully? (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 Returns: a BufferedReader Throws: java.io.IOException - if there was an error getting or creating the BufferedReader 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. Creates the file, if it doesn't already exist. Also creates the folder hierarchy if it doesn't already exist. 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 - if there was an error getting or creating the BufferedWriter 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

Class UnmanagedFile

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

Fields inherited from interface org.mozilla.javascript.Scriptable

Constructor Summary

Method Summary

Methods inherited from class org.mozilla.javascript.ScriptableObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.mozilla.javascript.Scriptable

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

Field Detail

kServerTypeAttribute

Constructor Detail

UnmanagedFile

Method Detail

jsConstructor

(JavaScript Getter) exists

(JavaScript Getter) lastModified

(JavaScript Getter) name

(JavaScript Getter) fileNameExtension

(JavaScript Getter) path

(JavaScript Function) getRelativePath

(JavaScript Getter) parent

(JavaScript Getter) length

(JavaScript Getter) xmp

(JavaScript Getter) width

(JavaScript Getter) height

(JavaScript Getter) format

(JavaScript Getter) colorspace

(JavaScript Getter) colorprofile

(JavaScript Getter) resolution

(JavaScript Getter) getFileContents

(JavaScript Function) create

(JavaScript Function) writeXmp

(JavaScript Function) getBufferedReader

(JavaScript Function) getBufferedWriter

(JavaScript Function) getFileOutputStream