Properties provide the means of accessing various types of information regarding a message that passes through the ESB. Furthermore, it is also possible to use properties to control the behavior of the ESB on a given message flow.
Generic properties allow to configure or change the behavior of the message flow as they are processed by the ESB.
By default, the ESB adds a new set of WS-Addressing headers to the messages forwarded from the ESB. If this property is set to "true" on a message, the ESB will forward it without altering its existing WS-Addressing headers.
Once this property is set to 'true' on a message, the ESB will start treating it as a response message. It is generally used to route a request message back to its source as the response. However, currently respond mediator perform the same functionality.
Set this property to "true" on a message to indicate that no response message is expected for it once it is forwarded from the ESB. In other words, the ESB will do an out-only invocation with such messages. It is very important to set this property on messages that are involved in out-only invocations to prevent the ESB from registering unnecessary callbacks for response handling and eventually running out of memory.
Use this property to set a custom error code on a message which can be later processed by a Synapse fault handler. If the Synapse encounters an error during mediation or routing, this property will be automatically populated.
Use this property to set a custom error message on a message which can be later processed by a Synapse fault handler. If the Synapse encounters an error during mediation or routing, this property will be automatically populated.
Use this property to set the exception stacktrace in case of an error. If the ESB encounters an error during mediation or routing, this property will be automatically populated.
Contains the actual exception thrown in case of a runtime error.
Contains the map of transport headers. Automatically populated. Individual values of this map can be accessed using the property mediator in the transport scope.
Message formatter is selected based on this property. This property should have the content type, such as text/xml, application/xml, or application/json.
This property will be in effect only if the messageType property is set. If the messageType is set, the value of Content-Type HTTP header of the outgoing request will be chosen based on this property. Note that this property is required to be set only if the message formatter seeks it in the message formatter implementation.
By default, Synapse removes the SOAP headers of incoming requests that have been processed. If we set this property to 'true', Synapse preserves the SOAP headers.
Server IP/Host name of hosted server
HTTP transport properties allow to control and configure how the HTTP transport processes the ongoing messages.
This property makes the outgoing URL of the ESB a complete URL. This is important when we talk through a Proxy Server.
When set to true, this property forces a 202 HTTP response to the client so that it stops waiting for a response.
Disables the HTTP chunking for outgoing messaging.
This property should be removed if a user want to generate a response from the ESB to a request without an entity body, for example, GET request.
Force HTTP 1.0 for outgoing HTTP messages.
Set the HTTP status code.
Set the HTTP status code.
Disables HTTP keep alive for corresponded connection flow. This Can be use in both inflow and outflow.
The value of this property will be appended to the target URL when sending messages out in a RESTful manner through an address endpoint. This is useful when you need to append a context to the target URL in case of RESTful invocations. If you are using an HTTP endpoint instead of an address endpoint, specify variables in the format of "uri.var.*" instead of using this property.
The value of this property will be set as the HTTP host header of outgoing request.
This property allows the content length to be sent when the ESB sends a request to a back end server. When HTTP 1.1 is used, this property disables chunking and sends the content length. When HTTP 1.0 is used, the property only sends the content length. This property should be set in scenarios where the backend server is not able to accept chunked content.
This property allows the HTTP content length to be copied from an incoming message. It is only valid when the FORCE_HTTP_CONTENT_LENGTH property is used. The COPY_CONTENT_LENGTH_FROM_INCOMING avoids buffering the message in memory for calculating the content length, thus reducing the risk of performance degradation.
Synapse Message Context Properties allow to retrieve the data related to synapse mediation engine information for current message flow.
Returns the current date as a String. Optionally, a date format as per the standard date format may be supplied. e.g. synapse:get-property("SYSTEM_DATE", "yyyy.MM.dd G 'at' HH:mm:ss z") or get-property('SYSTEM_DATE').
Returns the current time in milliseconds.
Returns pox, soap11, soap12 depending on the message. If a message type is unknown this returns soap12.