Packagemx.messaging.messages
Classpublic class SOAPMessage
InheritanceSOAPMessage Inheritance HTTPRequestMessage Inheritance AbstractMessage Inheritance Object

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

SOAPMessages are similar to HTTPRequestMessages. However, they always contain a SOAP XML envelope request body that will always be sent using HTTP POST. They also allow a SOAP action to be specified.


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
 InheritedcontentType : 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
 InheritedhttpHeaders : 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
 Inheritedmethod : String
Indicates what method should be used for the request.
HTTPRequestMessage
 InheritedrecordHeaders : 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
 Inheritedurl : String
Contains the final destination for this request.
HTTPRequestMessage
Public Methods
 MethodDefined By
  
SOAPMessage()
Constructs an uninitialized SOAPMessage.
SOAPMessage
  
getSOAPAction():String
Provides access to the name of the remote method/operation that will be called.
SOAPMessage
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
Public Constants
 ConstantDefined By
 InheritedCONTENT_TYPE_FORM : String = application/x-www-form-urlencoded
[static] Indicates that the content of this message is a form.
HTTPRequestMessage
 InheritedCONTENT_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
 InheritedCONTENT_TYPE_XML : String = application/xml
[static] Indicates that the content of this message is XML.
HTTPRequestMessage
 InheritedDELETE_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
 InheritedGET_METHOD : String = GET
[static] Indicates that the method used for this request should be "get".
HTTPRequestMessage
 InheritedHEAD_METHOD : String = HEAD
[static] Indicates that the method used for this request should be "head".
HTTPRequestMessage
 InheritedOPTIONS_METHOD : String = OPTIONS
[static] Indicates that the method used for this request should be "options".
HTTPRequestMessage
 InheritedPOST_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
 InheritedPUT_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
  SOAP_ACTION_HEADER : String = SOAPAction
[static] The HTTP header that stores the SOAP action for the SOAPMessage.
SOAPMessage
 InheritedSTATUS_CODE_HEADER : String = DSStatusCode
[static] A status code can provide context about the nature of a response message.
AbstractMessage
 InheritedTRACE_METHOD : String = TRACE
[static] Indicates that the method used for this request should be "trace".
HTTPRequestMessage
Constructor Detail
SOAPMessage()Constructor
public function SOAPMessage()

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

Constructs an uninitialized SOAPMessage.

Method Detail
getSOAPAction()method
public function getSOAPAction():String

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

Provides access to the name of the remote method/operation that will be called.

Returns
String — Returns the name of the remote method/operation that will be called.
Constant Detail
SOAP_ACTION_HEADERConstant
public static const SOAP_ACTION_HEADER:String = SOAPAction

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

The HTTP header that stores the SOAP action for the SOAPMessage.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00