Axis2 Properties

Axis2 properties allow you to configure the web services engine in the ESB profile, such as specifying how to cache JMS objects, setting the minimum and maximum threads for consuming messages, and forcing outgoing HTTP/S messages to use HTTP 1.0. You can access some of these properties through the Property mediator with the scope set to axis2 or axis2-client as shown below.

CacheLevel

Name	CacheLevel
Possible Values	none, connection, session, consumer, producer, auto
Description	This property determines which JMS objects should be cached. JMS objects are cached so that they can be reused in the subsequent invocations. Each caching level can be described as follows: `none`: No JMS object will be cached. `connection` `:` JMS connection objects will be cached. `session`: JMS connection and session objects will be cached. `consumer`: JMS connection, session and consumer objects will be cached. `producer`: JMS connection, session and producer objects will be cached. `auto`: An appropriate caching level will be used depending on the transaction strategy.
Example	<parameter name="transport.jms.CacheLevel">consumer</parameter>

ConcurrentConsumers

Name	ConcurrentConsumers
Possible Values	integer
Description	The minimum number of threads for message consuming. The value specified for this property is the initial number of threads started. As the number of messages to be consumed increases, number of threads are also increased to match the load until the total number of threads equals the value specified for the `transport.jms.MaxConcurrentConsumers` property.
Example	<parameter name="transport.jms.ConcurrentConsumers"locked="false">50</parameter>

HTTP_ETAG

Name	HTTP_ETAG
Possible Values	true/false
Scope	axis2
Description	This property determines whether the HTTP Etag should be enabled for the request or not. HTTP Etag is a mechanism provided by HTTP for Web cache validation.
Example	<property name="HTTP_ETAG" scope="axis2" type="BOOLEAN" value="true"/>

JMS_COORELATION_ID

Name	JMS_COORELATION_ID
Possible Values	String
Scope	axis2
Description	The JMS coorelation ID is used to match responses with specific requests. This property can be used to set the JMS coorrelation ID as a dynamic or a hard coded value in a request. As a result, responses with the matching JMS correlation IDs will be matched with the request.
Example	<property name="JMS_COORELATION_ID" action="set" scope="axis2" expression="$header/wsa:MessageID" xmlns:sam="http://sample.esb.org/>

MaxConcurrentConsumers

Name	MaxConcurrentConsumers
Possible Values	integer
Description	The maximum number of threads that can be added for message consuming. See ConcurrentConsumers.
Example	<parameter name="transport.jms.MaxConcurrentConsumers"locked="false">50</parameter>

MercurySequenceKey

Name	MercurySequenceKey
Possible Values	integer
Description	Can be an identifier specifying a Mercury internal sequence key.

MercuryLastMessage

Name	MercuryLastMessage
Possible Values	true/false
Description	When set to "true", it will make this the last message and terminate the sequence.

FORCE_HTTP_1.0

Name	FORCE_HTTP_1.0
Possible Values	true/false
Scope	axis2-client
Description	Forces outgoing http/s messages to use HTTP 1.0 (instead of the default 1.1).

setCharacterEncoding

Name	setCharacterEncoding
Possible Values	false
Default Behavior	By default character encoding is enabled in the ESB profile.
Scope	axis2
Description	This property can be used to remove character encode. Note that if this property is set to 'false', the 'CHARACTER_SET_ENCODING' property cannot be used.
Example	`<property name="setCharacterEncoding" value="false" scope="axis2" type="STRING"/>`

CHARACTER_SET_ENCODING

Name	CHARACTER_SET_ENCODING
Possible Values	Any valid encoding standard (E.g., UTF-8, UTF-16 etc.)
Default Behavior	N/A
Scope	axis2
Description	Specifies the encoding type used for the content of the files processed by the transport. Note that this property cannot be used if the 'setCharacterEncoding' property is set to 'false'.
Example	`<property name="CHARACTER_SET_ENCODING" value="UTF-8" scope="axis2" type="STRING"/>`

DISABLE_COOKIE

Name	`DISABLE_COOKIE`
Possible Values	true
Default Behavior	false
Scope	axis2
Description	Remove cookie header from blocking request calls that passes through the HTTPS Servlet transport (for GET and POST HTTP methods).
Example	<property name="DISABLE_COOKIE" value="true" scope="axis2" type="BOOLEAN"/>

DECODE_MULTIPART_DATA

Name	DECODE_MULTIPART_DATA
Possible Values	true, false
Default Behavior	false
Scope	axis2
Description	Specifies whether to decode multipart messages when the message is built in a content aware mediation scenario. Otherwise, the outgoing message will be in the encoded form.
Example	`<property name="DECODE_MULTIPART_DATA" value="true" scope="axis2" action="set" type="BOOLEAN"/>`