All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

The Address endpoint is an endpoint defined by specifying the EPR (Endpoint Reference) and other attributes of the configuration.

XML Configuration


You can configure the Address Endpoint using XML. Click on the Switch to source view link in the Address Endpoint page.

<address uri="endpoint address" [format="soap11|soap12|pox|get"] [optimize="mtom|swa"]
    [encoding="charset encoding"]
    [statistics="enable|disable"] [trace="enable|disable"]>

    <enableSec [policy="key"]/>?
    <enableAddressing [version="final|submission"] [separateListener="true|false"]/>?

        <duration>timeout duration in milliseconds</duration>


Address Endpoint Attributes




EPR of the target endpoint.


Message format for the endpoint.


Method to optimize the attachments.


The charset encoding to use for the endpoint.


This enables statistics for the endpoint.


This enables trace for the endpoint.

UI Configuration

The following page is opened by clicking Address Endpoint in the Add Endpoint tab of the Manage Endpoints page.

The parameters available to configure the endpoint are as follows.

Parameter NameDescription
NameThe unique name of the endpoint.
AddressThe URL of the endpoint. You can test the availability of the given URL by clicking Test.
Show Advanced Options

This section is used to enter advanced settings for the endpoint. The advanced options specific for the Address endpoint are as follows.

  • Format- The message format for the endpoint. The available values are as follows.
    • Leave As-Is: If this is selected, no transformation is done to the outgoing message.
    • SOAP 1.1: If this is selected the message is transformed to SOAP 1.1.
    • SOAP 1.2: If this is selected the message is transformed to SOAP 1.2.
    • Plain Old XML (POX): If this is selected the message is transformed to plain old XML format.
    • Representational State Transfer (REST) - If this is selected, the message is transformed to REST.
    • GET: If this is selected, the message is transformed to a HTTP Get Request.
  • Optimize- Optimization for the message, which transfers binary data. The available values are as follows.
    • Leave As-Is - If this is selected, there will be no special optimization. The original message will be kept.
    • SwA - If this is selected, the message is optimized as a SwA (SOAP with Attachment) message.
    • MTOM - If this is selected, the message is optimized using a MTOM (message transmission optimization mechanism).


The rest of the advanced options are common for Address, WSDL, Default endpoints. See the description of common options in Managing Endpoints.

Add PropertyThis section is used to add properties to an endpoint.

QoS for the Endpoint

QoS (Quality of Service) aspects such as WS-Security and WS-Addressing may be enabled on messages sent to an endpoint using enableSec and enableAddressing elements. Optionally, the WS-Security policies could be specified using the policy attribute.

QoS Configuration

enableSec [policy="key"]

This enables WS-Security for the message which is sent to the endpoint. The optional policy attribute specifies the WS-Security policy.

enableAddressing [version="final | submission"] [seperateListener=" true | false"]

This enables WS-Addressing for the message which is sent to the endpoint. User can specify to have separate listener with version final or submission.

Endpoint Timeout

A time out may occur for an Address endpoint if the response fails to arrive at Synapse within a time duration specified in milliseconds. The timeout action specifies whether to discard response that arrives later, or to trigger a fault. Synapse has a periodic timeout handler that triggers itself at each 15 seconds interval. Thus endpoint timeout will have a +/- erroce on trigger time. Though this can be minimized by setting a System property synapse.timeout_handler_interval (This property can be set in synpase property file which is located in conf directory inside repository once you unzipped WSO2 ESB ) to a millisecond duration below the desired endpoint timeout.


A lesser value may have a higher overhead on the system.

Timeout Configuration


Timeout duration in milliseconds.


Once a timeout occurs the action to perform, available options are discard (discard the response which arrives late) or fault (trigger a fault) .

Marking Endpoint for Suspension

As described before (see description on Timeout state above) this configuration element describes the configuration for a timeout endpoint.

markForSuspension Configuration


A comma separated error code list which can be returned by the endpoint. See SynpaseConstant class for a possible list of error codes.


Number of retries before go into suspended state.


The delay between each try.

Suspending Endpoint on Failure

Leaf endpoints(Address and WSDL) endpoint can be put into suspended state if it is detected as failed. An endpoint that fails may be suspended for a specified duration after such a failure, during which new messages will not be processed through the endpoint. The amount of time waiting before next attempt follows the following formula.

next suspension time period = Max (Initial Suspension duration * (progression factor* try count*), Maximum Duration)

All the variables in the above formula are configuration values used to calculate the try count. Try count means, how many tries occurred after the endpoint is "Suspended". As the try count increases, the next suspension time period will also increase. This increase is bound to a maximum duration.

suspendOnFailure configuration


A comma separated error code list which can be returned by the endpoint.


Initial duration(in milliseconds) to suspend the endpoint.


The progression factor for the geometric series. See above formula for a more detailed description.


Maximum duration(in milliseconds) to suspend the endpoint.

Following are the sample address URI definitions.


Sample Address






[email protected]


vfs:file:///home/user/directory\ vfs:file:///home/user/file\ vfs:



  • No labels