FUSE ESB 4.2 XML Configuration Reference

http://servicemix.apache.org/eip/1.0
element async-bridge

Model
<async-bridge
  endpoint = string
  id = ID
  interfaceName = QName
  lockManager = string
  requestCorrId = string
  responseCorrId = string
  responseCorrIdProperty = string
  service = QName
  store = string
  storeFactory = string
  target = string
  timeout = long
  timerManager = string
  useRobustInOnly = boolean
  wsdlExchangeTarget = string
  wsdlResource = string
  (any attribute from any namespace other than http://servicemix.apache.org/eip/1.0)>
lockManager?, store?, storeFactory?, target?, timerManager?, wsdlExchangeTarget?, (any element from any namespace other than http://servicemix.apache.org/eip/1.0)
</async-bridge>
Disallowed substitutions (block)
none (extensions, restrictions and substitutions are allowed)
Substitution group exclusion (final)
none (extensions and restrictions are allowed)
Content Type
element-only content, not nillable.
Usage
This element can be the root element of XML instance documents.
This element can be the child of element component/endpoints.
Documentation
        The async bridge pattern is used to bridge an In-Out exchange with two In-Only
(or Robust-In-Only) exchanges. This pattern is the opposite of the {@link Pipeline}.
<br/>
The AsyncBridge uses a correlation identifier to be able to correlate the received
In-Out exchange, the In-Only sent as the request and the In-Only received as the response.
Defaults values are provided to configure those correlation ids. The default behavior
is to use the exchange id of the incoming In-Out exchange as the correlation id and set
it on the request exchange. The same property with the same value should be present on the
response exchange in order for the AsyncBridge to work. ServiceMix components usually take
care of propagating such properties, but failing to propagate it will result in errors.
      

Nested Element Summary
sequence
anonymous type derived from anyTypelockManager optional
          The lock manager to use for this endpoint.
anonymous type derived from anyTypestore optional
          Configure the store to use.
anonymous type derived from anyTypestoreFactory optional
          The store factory to use when creating a store.
anonymous type derived from anyTypetarget optional
          The target which will be used to send an In-Only or Robust-In-Only exchange to.
anonymous type derived from anyTypetimerManager optional
          The timer manager to use for this endpoint.
anonymous type derived from anyTypewsdlExchangeTarget optional
          An exchange target pointing to a JBI endpoint that will be used to load the WSDL describing this endpoint.


Attribute Summary
stringendpoint
           The name of the endpoint.
IDid
           
QNameinterfaceName
           The qualified name of the interface exposed by the endpoint.
stringlockManager
          The lock manager to use for this endpoint.
stringrequestCorrId
          The expression used to compute the correlation id used to correlate the response and the request.
stringresponseCorrId
          The expression used to compute the correlation id from the response exchange.
stringresponseCorrIdProperty
           Name of the property used by default to compute the correlation id on the response exchange.
QNameservice
           The qualified name of the service the endpoint exposes.
stringstore
          Configure the store to use.
stringstoreFactory
          The store factory to use when creating a store.
stringtarget
          The target which will be used to send an In-Only or Robust-In-Only exchange to.
longtimeout
          The timeout property controls the amount of time that the async bridge will wait for the response after having sent the request.
stringtimerManager
          The timer manager to use for this endpoint.
booleanuseRobustInOnly
          Boolean flag to control if In-Only or Robust-In-Only exchange should be used when sending the request.
stringwsdlExchangeTarget
          An exchange target pointing to a JBI endpoint that will be used to load the WSDL describing this endpoint.
stringwsdlResource
          When specified, this spring resource will be used to load the WSDL that will be exposed as a description for this endpoint.

Attribute Detail

endpoint

Documentation
            The name of the endpoint.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

id

Definition

Defined with global type ID

Model
ID
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

interfaceName

Documentation
            The qualified name of the interface exposed by the endpoint.
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

lockManager

Documentation
            The lock manager to use for this endpoint. If none is explicitely specified
a default implementation will be provided.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

requestCorrId

Documentation
            The expression used to compute the correlation id used to correlate the response and
the request. The default behavior is to use the exchange id of the incoming In-Out
exchange as the correlation id.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

responseCorrId

Documentation
            The expression used to compute the correlation id from the response exchange.
The value computed by this expression must match the one from the {@link #setRequestCorrId}
expression. The default value is null, but if no specific expression is configured,
an expression will be created which will extract the response correlation id from the
{@link #setResponseCorrIdProperty(String)} property on the exchange.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

responseCorrIdProperty

Documentation
            Name of the property used by default to compute the correlation id on the response
exchange.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

service

Documentation
            The qualified name of the service the endpoint exposes.
          
Definition

Defined with global type QName

Model
QName
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

store

Documentation
            Configure the store to use. If none is explicitely configured,
the storeFactory will be used to create one.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

storeFactory

Documentation
            The store factory to use when creating a store. If no factory
is explicitely defined, an in-memory only factory will be created.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

target

Documentation
            The target which will be used to send an In-Only or Robust-In-Only exchange to.
When receiving an In-Out exchange, the async bridge will create an In-Only request
and send it to the specified target. It then expects another In-Only exchange to
come back as the response, which will be set as the Out message on the In-Out exchange.
This property is mandatory and must be set to a valid target.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

timeout

Documentation
            The timeout property controls the amount of time that the async bridge will wait for the response
after having sent the request. The default value is 0 which means that no timeout apply. If set
to a non zero value, a timer will be started when after the request is sent. When the timer
expires, the In-Out exchange will be sent back with an error status and a
{@link java.util.concurrent.TimeoutException} as the cause of the error.
The value represents the number of milliseconds to wait.
          
Definition

Defined with global type long

Model
long
Attribute Usage
optional
Fundamental Facets
equality, numeric, bounded, totaly ordered, countable infinite value space
White Space Processing
collapse

timerManager

Documentation
            The timer manager to use for this endpoint. If none is explicitely configured,
a default implementation will be provided.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

useRobustInOnly

Documentation
            Boolean flag to control if In-Only or Robust-In-Only exchange should be used
when sending the request. The default value is <code>false</code> which means
that an In-Only exchange will be used. When using a Robust-In-Only exchange and
when a fault is received, this fault will be sent back to the consumer on the In-Out
exchange and the response exchange (if any) would be discarded.
For both In-Only and Robust-In-Only, if the request exchange comes back with an Error
status, this error will be conveyed back to the consumer in the same way.
          
Definition

Defined with global type boolean

Model
boolean
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, finit value space
White Space Processing
collapse

wsdlExchangeTarget

Documentation
            An exchange target pointing to a JBI endpoint that
will be used to load the WSDL describing this endpoint.
This can be used when the endpoint proxies another endpoint
so that the same WSDL definition will be exposed."
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

wsdlResource

Documentation
            When specified, this spring resource will be used to load the
WSDL that will be exposed as a description for this endpoint.
This property can be used to explicitely define the WSDL to be
exposed by this endpoint. This property takes precedence over
the wsdlExchangeTarget property.
          
Definition

Defined with global type string

Model
string
Attribute Usage
optional
Fundamental Facets
equality, non-numeric, unbounded, unordered, countable infinite value space
White Space Processing
collapse

FUSE ESB 4.2 XML Configuration Reference

FUSE ESB 4.2 XML Configuration Reference