Packagecom.kaazing.gateway.amqp.client
Classpublic class AmqpProperties

AmqpProperties class is used to specify the pre-defined properties as per AMQP 0-9-1 specification. This class provides type-safe convenience getters and setters for the pre-defined or standard AMQP properties.

The value of the "headers" property is of type AmqpArguments. Kaazing AMQP implementation uses AmqpArguments to encode the "table". Similarly, Kaazing AMQP implementation decodes the "table" and constructs an instance of AmqpArguments.

See also

com.kaazing.gateway.amqp.client.AmqpArguments


Public Properties
 PropertyDefined by
  appId : String
Returns the value of "appId" property.
AmqpProperties
  contentEncoding : String
Returns the value of "contentEncoding" property.
AmqpProperties
  contentType : String
Returns the value of "contentType" property.
AmqpProperties
  correlationId : String
Returns the value of "correlationId" property.
AmqpProperties
  deliveryMode : int
Returns the value of "deliveryMode" property.
AmqpProperties
  expiration : String
Returns the value of "expiration" property.
AmqpProperties
  headers : AmqpArguments
Returns the value of "headers" property.
AmqpProperties
  messageId : String
Returns the value of "messageId" property.
AmqpProperties
  priority : int
Returns the value of "priority" property.
AmqpProperties
  properties : Dictionary
[read-only] Gets the properties as Dictionary by shallow copying the values.
AmqpProperties
  replyTo : String
Returns the value of "replyTo" property.
AmqpProperties
  timestamp : Date

Returns the value of "timestamp" property converted to Date.

AmqpProperties
  type : String
Returns the value of "type" property.
AmqpProperties
  userId : String
Returns the value of "userId" property.
AmqpProperties
Public Methods
 MethodDefined by
  
AmqpProperties
  
[static] internal use
AmqpProperties
  
toString():String
AmqpProperties
Public Constants
 ConstantDefined by
  AMQP_PROP_APP_ID : String = "appId"
[static]
AmqpProperties
  AMQP_PROP_CONTENT_ENCODING : String = "contentEncoding"
[static]
AmqpProperties
  AMQP_PROP_CONTENT_TYPE : String = "contentType"
[static]
AmqpProperties
  AMQP_PROP_CORRELATION_ID : String = "correlationId"
[static]
AmqpProperties
  AMQP_PROP_DELIVERY_MODE : String = "deliveryMode"
[static]
AmqpProperties
  AMQP_PROP_EXPIRATION : String = "expiration"
[static]
AmqpProperties
  AMQP_PROP_HEADERS : String = "headers"
[static]
AmqpProperties
  AMQP_PROP_MESSAGE_ID : String = "messageId"
[static]
AmqpProperties
  AMQP_PROP_PRIORITY : String = "priority"
[static]
AmqpProperties
  AMQP_PROP_REPLY_TO : String = "replyTo"
[static]
AmqpProperties
  AMQP_PROP_TIMESTAMP : String = "timestamp"
[static]
AmqpProperties
  AMQP_PROP_TYPE : String = "type"
[static]
AmqpProperties
  AMQP_PROP_USER_ID : String = "userId"
[static]
AmqpProperties
  APPLICATION_OCTET_STREAM : String = "application/octet-stream"
[static] The content type property for octet-stream content
AmqpProperties
  TEXT_PLAIN : String = "text/plain"
[static] The content type property for plain text content
AmqpProperties
Property detail
appIdproperty
appId:String  [read-write]

Returns the value of "appId" property. A null is returned if the property is not set.

Implementation
    public function get appId():String
    public function set appId(value:String):void
contentEncodingproperty 
contentEncoding:String  [read-write]

Returns the value of "contentEncoding" property. A null is returned if the property is not set.

Implementation
    public function get contentEncoding():String
    public function set contentEncoding(value:String):void
contentTypeproperty 
contentType:String  [read-write]

Returns the value of "contentType" property. A null is returned if the property is not set.

Implementation
    public function get contentType():String
    public function set contentType(value:String):void
correlationIdproperty 
correlationId:String  [read-write]

Returns the value of "correlationId" property. A null is returned if the property is not set.

Implementation
    public function get correlationId():String
    public function set correlationId(value:String):void
deliveryModeproperty 
deliveryMode:int  [read-write]

Returns the value of "deliveryMode" property. -1 is returned if the property is not set. If deliveryMode is 1, then it indicates non-persistent mode. If deliveryMode is 2, then it indicates a persistent mode.

Implementation
    public function get deliveryMode():int
    public function set deliveryMode(value:int):void
expirationproperty 
expiration:String  [read-write]

Returns the value of "expiration" property. A null is returned if the property is not set.

Implementation
    public function get expiration():String
    public function set expiration(value:String):void
headersproperty 
headers:AmqpArguments  [read-write]

Returns the value of "headers" property. A null is returned if the property is not set.

Implementation
    public function get headers():AmqpArguments
    public function set headers(value:AmqpArguments):void
messageIdproperty 
messageId:String  [read-write]

Returns the value of "messageId" property. A null is returned if the property is not set.

Implementation
    public function get messageId():String
    public function set messageId(value:String):void
priorityproperty 
priority:int  [read-write]

Returns the value of "priority" property. A null is returned if the property is not set.

Implementation
    public function get priority():int
    public function set priority(value:int):void
propertiesproperty 
properties:Dictionary  [read-only]

Gets the properties as Dictionary by shallow copying the values.

Implementation
    public function get properties():Dictionary
replyToproperty 
replyTo:String  [read-write]

Returns the value of "replyTo" property. A null is returned if the property is not set.

Implementation
    public function get replyTo():String
    public function set replyTo(value:String):void
timestampproperty 
timestamp:Date  [read-write]

Returns the value of "timestamp" property converted to Date. A null is returned if the property is not set.

As per the amqp 0-9-1 spec, timestamp property value is 64 bit. But in flash, Number type does not preserve 64-bit long int. The IEEE-754 standard (http://en.wikipedia.org/wiki/Double_precision_floating-point_format) which Flash follows correctly, specifies that the "integer" section of a double is 53 bits long (sign bit included) which is equal to: 4,503,599,627,370,496. So the current timestamp decoder takes into account only 48 bits which will be able to address date-times for a foreseeable future.

Implementation
    public function get timestamp():Date
    public function set timestamp(value:Date):void
typeproperty 
type:String  [read-write]

Returns the value of "type" property. A null is returned if the property is not set.

Implementation
    public function get type():String
    public function set type(value:String):void
userIdproperty 
userId:String  [read-write]

Returns the value of "userId" property. A null is returned if the property is not set.

Implementation
    public function get userId():String
    public function set userId(value:String):void
Constructor detail
AmqpProperties()constructor
public function AmqpProperties()
Method detail
CreateAmqpPropertiesFromObject()method
public static function CreateAmqpPropertiesFromObject(properties:Object):AmqpProperties

internal use

Parameters
properties:Object

Returns
AmqpProperties
toString()method 
public function toString():String

Returns
String
Constant detail
AMQP_PROP_APP_IDconstant
public static const AMQP_PROP_APP_ID:String = "appId"
AMQP_PROP_CONTENT_ENCODINGconstant 
public static const AMQP_PROP_CONTENT_ENCODING:String = "contentEncoding"
AMQP_PROP_CONTENT_TYPEconstant 
public static const AMQP_PROP_CONTENT_TYPE:String = "contentType"
AMQP_PROP_CORRELATION_IDconstant 
public static const AMQP_PROP_CORRELATION_ID:String = "correlationId"
AMQP_PROP_DELIVERY_MODEconstant 
public static const AMQP_PROP_DELIVERY_MODE:String = "deliveryMode"
AMQP_PROP_EXPIRATIONconstant 
public static const AMQP_PROP_EXPIRATION:String = "expiration"
AMQP_PROP_HEADERSconstant 
public static const AMQP_PROP_HEADERS:String = "headers"
AMQP_PROP_MESSAGE_IDconstant 
public static const AMQP_PROP_MESSAGE_ID:String = "messageId"
AMQP_PROP_PRIORITYconstant 
public static const AMQP_PROP_PRIORITY:String = "priority"
AMQP_PROP_REPLY_TOconstant 
public static const AMQP_PROP_REPLY_TO:String = "replyTo"
AMQP_PROP_TIMESTAMPconstant 
public static const AMQP_PROP_TIMESTAMP:String = "timestamp"
AMQP_PROP_TYPEconstant 
public static const AMQP_PROP_TYPE:String = "type"
AMQP_PROP_USER_IDconstant 
public static const AMQP_PROP_USER_ID:String = "userId"
APPLICATION_OCTET_STREAMconstant 
public static const APPLICATION_OCTET_STREAM:String = "application/octet-stream"

The content type property for octet-stream content

TEXT_PLAINconstant 
public static const TEXT_PLAIN:String = "text/plain"

The content type property for plain text content