Packageorg.restfulx.services.as3http
Classpublic class AS3GAEHTTPServiceProvider
InheritanceAS3GAEHTTPServiceProvider Inheritance AS3XMLHTTPServiceProvider Inheritance XMLHTTPServiceProvider

AS3 HTTP Client based GAE XML-over-HTTP service provider. TODO: needs to be able to upload files as well.


Public Properties
 PropertyDefined by
  id : int
[read-only] ID uniquely identifies this service provider.
AS3GAEHTTPServiceProvider
 InheritedrootUrl : String
Root URL that this service provider will prefix to all requests.
XMLHTTPServiceProvider
Protected Properties
 PropertyDefined by
 InheritedcontentType : String
AS3XMLHTTPServiceProvider
 Inheritedserializer : ISerializer
XMLHTTPServiceProvider
 Inheritedstate : ModelsMetadata
XMLHTTPServiceProvider
 InheritedurlSuffix : String
XMLHTTPServiceProvider
Public Methods
 MethodDefined by
  
AS3GAEHTTPServiceProvider(httpRootUrl:String = null)
AS3GAEHTTPServiceProvider
 Inherited
canLazyLoad():Boolean
Indicates if this service provider can perform lazy loading.
XMLHTTPServiceProvider
  
create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: create method.
AS3GAEHTTPServiceProvider
 Inherited
destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: destroy method.
AS3XMLHTTPServiceProvider
 Inherited
hasErrors(object:Object):Boolean
Indicates to the ServiceResponder that this particular run (typically create/update or destroy) has produced errors.
XMLHTTPServiceProvider
 Inherited
index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
RESTful CRUD contract: index method.
AS3XMLHTTPServiceProvider
 Inherited
marshall(object:Object, recursive:Boolean = false):Object
Produces service provider specific model representation suitable for being serialized.
XMLHTTPServiceProvider
 Inherited
show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
RESTful CRUD contract: show method.
AS3XMLHTTPServiceProvider
 Inherited
unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object
The reverse of marshall.
XMLHTTPServiceProvider
  
update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: update method.
AS3GAEHTTPServiceProvider
Protected Methods
 MethodDefined by
 Inherited
addHeaders(request:URLRequest, headers:Object):void
XMLHTTPServiceProvider
 Inherited
addHeadersToHttpRequest(request:HttpRequest):HttpRequest
AS3XMLHTTPServiceProvider
 Inherited
decodeResult(result:Object):Object
XMLHTTPServiceProvider
 Inherited
getCreateOrUpdateHttpClient(object:Object, responder:IResponder, metadata:Object, nestedBy:Array, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):HttpClient
AS3XMLHTTPServiceProvider
 Inherited
getHttpClient(onDataComplete:Function, onError:Function = null):HttpClient
AS3XMLHTTPServiceProvider
 Inherited
getIndexOrShowHttpClient(responder:IResponder):HttpClient
AS3XMLHTTPServiceProvider
 Inherited
getURLLoader():URLLoader
XMLHTTPServiceProvider
 Inherited
getURLRequest(object:Object, nestedBy:Array = null):URLRequest
XMLHTTPServiceProvider
 Inherited
invokeCreateOrUpdateURLRequest(request:URLRequest, responder:IResponder, object:Object, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void
XMLHTTPServiceProvider
 Inherited
invokeMultiPartRequest(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void
XMLHTTPServiceProvider
 Inherited
invokeURLRequest(request:URLRequest, responder:IResponder):void
XMLHTTPServiceProvider
 Inherited
marshallToURLVariables(source:Object):URLVariables
XMLHTTPServiceProvider
 Inherited
marshallToVO(object:Object, recursive:Boolean = false, toDelete:Boolean = false):Object
XMLHTTPServiceProvider
 Inherited
sendOrUpload(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void
XMLHTTPServiceProvider
 Inherited
uploadFile(request:URLRequest, object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):void
XMLHTTPServiceProvider
 Inherited
urlEncodeMetadata(metadata:Object = null):String
XMLHTTPServiceProvider
Public Constants
 ConstantDefined by
  ID : int
[static] service id
AS3GAEHTTPServiceProvider
Property detail
idproperty
id:int  [read-only]

ID uniquely identifies this service provider. This is typically obtained from ServiceManager like so: public static const ID:int = ServiceManager.generateId(); You can then wrap around this with a getter: public function get id():int { return ID; }

Implementation
    public function get id():int

See also

org.restfulx.services.IServiceProvider.id
Constructor detail
AS3GAEHTTPServiceProvider()constructor
public function AS3GAEHTTPServiceProvider(httpRootUrl:String = null)

Parameters
httpRootUrl:String (default = null) — root URL that this service provider will prefix to all requests. By default this will be equal to Rx.httpRootUrl parameter
Method detail
create()method
public override function create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: create method. Same semantics as Rails RESTful controller create.

Parameters
object:Object — object to create (typically a new model instance)
 
responder:IResponder — the responder that must be called on index
 
metadata:Object (default = null) — any metadata that must be appended with the index request
 
nestedBy:Array (default = null) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.
 
recursive:Boolean (default = false) — indicates if recursive create (object + all children) should be performed
 
undoRedoFlag:int (default = 0) — indicates if it's a normal invocation, undo invocation or redo invocation

See also

org.restfulx.services.IServiceProvider.create
update()method 
public override function update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: update method. Same semantics as Rails RESTful controller update.

Parameters
object:Object — object to update (typically an existing model instance)
 
responder:IResponder — the responder that must be called on index
 
metadata:Object (default = null) — any metadata that must be appended with the index request
 
nestedBy:Array (default = null) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.
 
recursive:Boolean (default = false) — indicates if recursive create (object + all children) should be performed
 
undoRedoFlag:int (default = 0) — indicates if it's a normal invocation, undo invocation or redo invocation

See also

org.restfulx.services.IServiceProvider.update
Constant detail
IDconstant
public static const ID:int

service id