Address Endpoint

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

XML Configuration

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

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

    <timeout>
        <duration>timeout duration in milliseconds</duration>
        <action>discard|fault</action>
    </timeout>?

    <markForSuspension>
        [<errorCodes>xxx,yyy</errorCodes>]
        <retriesBeforeSuspension>m</retriesBeforeSuspension>
        <retryDelay>d</retryDelay>
    </markForSuspension>

    <suspendOnFailure>
        [<errorCodes>xxx,yyy</errorCodes>]
        <initialDuration>n</initialDuration>
        <progressionFactor>r</progressionFactor>
        <maximumDuration>l</maximumDuration>
    </suspendOnFailure>
</address>

Address Endpoint Attributes

UI Configuration

1. In the "Add Endpoint" tab, click "Address Endpoint" (See Adding an Endpoint). The "Address Endpoint" page appears with its default view.

The following fields are specific to the Address Endpoint:

• Name - The unique name of the endpoint.
• Address - The URL of the endpoint.

2. In case you want to configure the advanced options, click on the "Show Advanced Options" drop down pane.

3. Then the page with all the available Address Endpoint options appears.

4. Specific Address Endpoint details are as follows:

• Format - The message format for the endpoint. The available values are:
  • Leave As-Is - No transformation is done to the outgoing message.
  • SOAP 1.1 - Transforming message to SOAP 1.1.
  • SOAP 1.2 - Transforming message to SOAP 1.2.
  • Plain Old XML (POX) - Transforming to plain old XML format.
  • Representational State Transfer (REST) - Transforming to HTTP Get Request.
  • GET
• Optimize - Optimization for the message, which transfers binary data. The available values are:
  • Leave As-Is - No special Optimization. Keep the original message.
  • SwA - Optimized as a SwA (SOAP with Attachment) message.
  • MTOM - Optimized as a MTOM (message transmission optimization mechanism).

QoS for the Endpoint

QoS (Quility of service) aspects such as WS-RM(WS-Reliable messaging), WS-Security and WS-Addressing may be enabled on messages send to an endpoint using enableRM, enableSec and enableAddressing elements. Optionally, the WS-RM and WS-Security policies could be specified using policy attribute.

QoS Configuration

Endpoint Timeout

Address(and also WSDL) endpoints can timeout if the response fails to arrive at Synapse by a predefined timeout duration specified in seconds. 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 synapse.properties 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.

Timeout Configuration

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

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

Following are the sample address URI definitions.