com.brightech.mb.workflow.js

Class AJAX

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.mb.workflow.js.AJAX

All Implemented Interfaces:

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

public class AJAX
extends MBScriptableObject

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

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theUrl, java.lang.Object theObject) Javascript constructor for AJAX object.
boolean	(JavaScript Function) addBinaryChunk(IFileObject theFile, int theChunkIndex, int theChunkSize, java.lang.String theParamKey) Called before execute, this function adds the binary chunk to a multipart POST request
void	(JavaScript Function) execute() Execute the configured AJAX request.
java.lang.String	(JavaScript Function) printRequest() Builds a string form of the Request based on the object passed to the constructor

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

Constructor Detail

AJAX

public AJAX()

Method Detail

jsConstructor

public void jsConstructor(java.lang.String theUrl,
                          java.lang.Object theObject)

Javascript constructor for AJAX object. Note that AJAX requests are synchronous but still use callbacks for functionality The arguments are modeled after jQuery.ajax and should be familiar. (http://api.jquery.com/jQuery.ajax/) data default: none Payload for request. May be key/value pairs for GET request (appended to URL as query string), or raw data for POST. If POSTing multipart/form-data the values can be Unmanaged or Managed Files for upload. contentType (POST method only) default: application/x-www-form-urlencoded (raw) Format of the data. multipart/form-data allows sending files, can also be application/json, etc. dataType default: text (json) Format of expected response. Use "json" to retrieve a JSON object. error default: none Callback function on error response function(theStatus, theData) headers default: none JSON object mapping keys to values to send as headers method default: GET (POST, PUT) password default: none Use with username option for basic HTTP authentication. selfSigned default: false (true) Allows self-signed ssl certificates for testing. success default: none Callback function on successful response function(theStatus, theData) username default: none Use with password option for basic HTTP authentication

Parameters:

theUrl - Target url

theObject - Javascript object of parameters, modeled after jQuery.ajax.

(JavaScript Function) execute

public void (JavaScript Function) execute()

Execute the configured AJAX request. See Constructor for details.

(JavaScript Function) printRequest

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

Builds a string form of the Request based on the object passed to the constructor

Returns:

String representation of the request

(JavaScript Function) addBinaryChunk

public boolean (JavaScript Function) addBinaryChunk(IFileObject theFile,
                                         int theChunkIndex,
                                         int theChunkSize,
                                         java.lang.String theParamKey)
                                  throws java.lang.Exception

Called before execute, this function adds the binary chunk to a multipart POST request

Parameters:

theFile - the file to chunk

theChunkIndex - the index of the chunk starting at 0

theChunkSize - the size of the chunk to send

theParamKey - the Key to associate with the chunk in the request

Returns:

Throws:

java.lang.Exception