JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.datatransfer
Class AdfRestXhrFactory

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.datatransfer.AdfRestXhrFactory

public class AdfRestXhrFactory
extends AdfObject

CLIENT_ID_LIST_KEY

public static Object CLIENT_ID_LIST_KEY

_instances

private static Object _instances

URL_KEY

public static Object URL_KEY

AdfRestXhrFactory

public AdfRestXhrFactory()

AdfRestXhrFactory is a factory class that creates (if needed) and returns {XMLHttpRequest} instances. This is an abstract class. Subclasses should invoke #register method to be the implementation of this class. Multiple instances of {AdfRestXhrFactory} can be registered. Each factory's getXhr method should return null if it won't handle the XHR for the passed in parameters. If all of the factories' getXhr method returns null, the base framework provided object will be used.

getXhr

public XMLHttpRequest getXhr(Object xhr,
                             Object properties)

Returns a {XMLHttpRequest} object to be used for REST calls. If the implementation doesn't handle XHR for the passed in parameters, it should return null.

Parameters:

xhr
properties

Return:

XMLHttpRequest - A wrapped XHR object that delegates to the passed in {XMLHttpRequest} object, or a configured passed in {XMLHttpRequest} object

__getXhr

static Object __getXhr(Object xhr,
                        Object properties)

Parameters:

xhr
properties

Return:

Object

register

public static Object register(Object instance)

Registers the instance provided as a {AdfRestXhrFactory} for the application

Parameters:

instance

Return:

Object