(BlazeDS only)
Packagemx.messaging.messages
Classpublic class HTTPRequestMessage
InheritanceHTTPRequestMessage Inheritance AbstractMessage Inheritance Object
Subclasses SOAPMessage

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

HTTP requests are sent to the HTTP endpoint using this message type. An HTTPRequestMessage encapsulates content and header information normally found in HTTP requests made by a browser.


Public Properties
 PropertyDefined By
 Inheritedbody : Object
The body of a message contains the specific data that needs to be delivered to the remote destination.
AbstractMessage
 InheritedclientId : String
The clientId indicates which MessageAgent sent the message.
AbstractMessage
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  contentType : String
Indicates the content type of this message.
HTTPRequestMessage
 Inheriteddestination : String
The message destination.
AbstractMessage
 Inheritedheaders : Object
The headers of a message are an associative array where the key is the header name and the value is the header value.
AbstractMessage
  httpHeaders : Object
Contains specific HTTP headers that should be placed on the request made to the destination.
HTTPRequestMessage
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
  method : String
Indicates what method should be used for the request.
HTTPRequestMessage
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  recordHeaders : Boolean
Only used when going through the proxy, should the proxy send back the request and response headers it used.
HTTPRequestMessage
 Inheritedtimestamp : Number
Provides access to the time stamp for the message.
AbstractMessage
 InheritedtimeToLive : Number
The time to live value of a message indicates how long the message should be considered valid and deliverable.
AbstractMessage
  url : String
Contains the final destination for this request.
HTTPRequestMessage
Public Methods
 MethodDefined By
  
HTTPRequestMessage()
Constructs an uninitialized HTTP request.
HTTPRequestMessage
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CONTENT_TYPE_FORM : String = "application/x-www-form-urlencoded"
[static] Indicates that the content of this message is a form.
HTTPRequestMessage
  CONTENT_TYPE_SOAP_XML : String = "text/xml; charset=utf-8"
[static] Indicates that the content of this message is XML meant for a SOAP request.
HTTPRequestMessage
  CONTENT_TYPE_XML : String = "application/xml"
[static] Indicates that the content of this message is XML.
HTTPRequestMessage
  DELETE_METHOD : String = "DELETE"
[static] Indicates that the method used for this request should be "delete".
HTTPRequestMessage
 InheritedDESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId"
[static] Messages pushed from the server may arrive in a batch, with messages in the batch potentially targeted to different Consumer instances.
AbstractMessage
 InheritedENDPOINT_HEADER : String = "DSEndpoint"
[static] Messages are tagged with the endpoint id for the Channel they are sent over.
AbstractMessage
 InheritedFLEX_CLIENT_ID_HEADER : String = "DSId"
[static] This header is used to transport the global FlexClient Id value in outbound messages once it has been assigned by the server.
AbstractMessage
  GET_METHOD : String = "GET"
[static] Indicates that the method used for this request should be "get".
HTTPRequestMessage
  HEAD_METHOD : String = "HEAD"
[static] Indicates that the method used for this request should be "head".
HTTPRequestMessage
  OPTIONS_METHOD : String = "OPTIONS"
[static] Indicates that the method used for this request should be "options".
HTTPRequestMessage
  POST_METHOD : String = "POST"
[static] Indicates that the method used for this request should be "post".
HTTPRequestMessage
 InheritedPRIORITY_HEADER : String = "DSPriority"
[static] Messages sent by a MessageAgent can have a priority header with a 0-9 numerical value (0 being lowest) and the server can choose to use this numerical value to prioritize messages to clients.
AbstractMessage
  PUT_METHOD : String = "PUT"
[static] Indicates that the method used for this request should be "put".
HTTPRequestMessage
 InheritedREMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset"
[static] Messages that need to set remote credentials for a destination may also need to report the character-set encoding that was used to create the credentials String using this header.
AbstractMessage
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[static] Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header.
AbstractMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[static] Messages sent with a defined request timeout use this header.
AbstractMessage
 InheritedSTATUS_CODE_HEADER : String = "DSStatusCode"
[static] A status code can provide context about the nature of a response message.
AbstractMessage
  TRACE_METHOD : String = "TRACE"
[static] Indicates that the method used for this request should be "trace".
HTTPRequestMessage
Property Detail
contentTypeproperty
public var contentType:String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates the content type of this message. This value must be understood by the destination this request is sent to.

The following example sets the contentType property:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

httpHeadersproperty 
public var httpHeaders:Object

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains specific HTTP headers that should be placed on the request made to the destination.

methodproperty 
method:String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates what method should be used for the request. The only values allowed are:

The following example sets the method property:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";



Implementation
    public function get method():String
    public function set method(value:String):void
recordHeadersproperty 
public var recordHeaders:Boolean

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Only used when going through the proxy, should the proxy send back the request and response headers it used. Defaults to false. Currently only set when using the NetworkMonitor.

urlproperty 
public var url:String

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains the final destination for this request. This is the URL that the content of this message, found in the body property, will be sent to, using the method specified.

The following example sets the url property:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

Constructor Detail
HTTPRequestMessage()Constructor
public function HTTPRequestMessage()

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs an uninitialized HTTP request.

Constant Detail
CONTENT_TYPE_FORMConstant
public static const CONTENT_TYPE_FORM:String = "application/x-www-form-urlencoded"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the content of this message is a form.

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

CONTENT_TYPE_SOAP_XMLConstant 
public static const CONTENT_TYPE_SOAP_XML:String = "text/xml; charset=utf-8"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the content of this message is XML meant for a SOAP request.

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_SOAP_XML;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

CONTENT_TYPE_XMLConstant 
public static const CONTENT_TYPE_XML:String = "application/xml"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the content of this message is XML.

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_XML;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

DELETE_METHODConstant 
public static const DELETE_METHOD:String = "DELETE"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "delete".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.DELETE_METHOD;
          msg.url = "http://my.company.com/login";

GET_METHODConstant 
public static const GET_METHOD:String = "GET"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "get".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.GET_METHOD;
          msg.url = "http://my.company.com/login";

HEAD_METHODConstant 
public static const HEAD_METHOD:String = "HEAD"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "head".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.HEAD_METHOD;
          msg.url = "http://my.company.com/login";

OPTIONS_METHODConstant 
public static const OPTIONS_METHOD:String = "OPTIONS"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "options".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.OPTIONS_METHOD;
          msg.url = "http://my.company.com/login";

POST_METHODConstant 
public static const POST_METHOD:String = "POST"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "post".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.POST_METHOD;
          msg.url = "http://my.company.com/login";

PUT_METHODConstant 
public static const PUT_METHOD:String = "PUT"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "put".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.PUT_METHOD;
          msg.url = "http://my.company.com/login";

TRACE_METHODConstant 
public static const TRACE_METHOD:String = "TRACE"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that the method used for this request should be "trace".

The following example uses this constant:

          var msg:HTTPRequestMessage = new HTTPRequestMessage();
          msg.contentType = HTTPRequestMessage.CONTENT_TYPE_FORM;
          msg.method = HTTPRequestMessage.TRACE_METHOD;
          msg.url = "http://my.company.com/login";




© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00