Skip to content

Axis2 Properties

Info

The following are Axis2 properties that can be used with the Property mediator and the Property Group mediator.

Axis2 properties allow you to configure the web services engine in WSO2 Micro Integrator, 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 by using the Property mediator with the scope set to axis2 or axis2-client as shown below.

CacheLevel

Parameter Description

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

Parameter Description

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

Parameter Description
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.

Note:

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

Parameter Description

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

Parameter Description

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

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

MercuryLastMessage

Parameter Value
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

Parameter Value
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

Parameter Value
Name setCharacterEncoding
Possible Values false
Default Behavior By default character encoding is enabled in the Micro Integrator.
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

Parameter Value
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"/>

HL7 Properties

HL7_GENERATE_ACK

Parameter Description
Name HL7_GENERATE_ACK
Possible Values true/false
Scope axis2
Description Use this property to disable auto acknowledgement of HL7 messages that are received by the Micro Integrator. By default, auto acknowledgement is enabled in the Micro Integrator. You can disable this by setting this property to 'false'.
Example
<property name="HL7_GENERATE_ACK"  scope="axis2" value="true"</property>

HL7_RESULT_MODE

Parameter Description
Name HL7_RESULT_MODE
Possible Values ACK or NACK
Scope axis2
Description Use this property to specify whether an ACK or NACK should be returned to the messaging client as an acknowledgement. If you select a NACK response, you have the option to specify a custom NACK message that should be sent to the client along with the NACK.
Example
<property name="HL7_RESULT_MODE"  scope="axis2" value="ACK|NACK"</property>

HL7_NACK_MESSAGE

Parameter Description
Name HL7_NACK_MESSAGE
Possible Values User defined string value.
Scope axis2
Description Use this property to set a custom NACK message that should be sent to the HL7 client as an acknowledgement. This property can be used only if the HL7 result mode is set to NACK.
Example
<property name="HL7_NACK_MESSAGE"  scope="axis2" value="error message"</property>

HL7_APPLICATION_ACK

Parameter Description
Name HL7_APPLICATION_ACK
Possible Values true/false
Scope axis2
Description Use this property to specify whether the Micro Integrator should wait for the backend to process the message before sending an acknowledgement (ACK or NACK message) back to the messaging client.
Example
<property name="HL7_APPLICATION_ACK"  scope="axis2" value="true|false"</property>

HL7_RAW_MESSAGE

Parameter Description
Name HL7_RAW_MESSAGE
Possible Values $axis2:HL7_RAW_MESSAGE
Scope axis2
Description Use this property to retrieve the original raw EDI format HL7 message in an InSequence.
Example
<property name="HL7_RAW_MESSAGE"  scope="axis2" value="$axis2:HL7_RAW_MESSAGE"</property>
Top