|Table of Contents|
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|rest|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> <responseAction>discard|fault</responseAction> </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>
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.
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.
You can test the availability of the given URL on the fly by just clicking the "Test" button.
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.
- 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).
The rest of the fields are general for Address, WSDL, Default endpoints. See the description of common options in Adding an Endpoint.
QoS for the Endpoint
QoS for the endpoint
QoS (Quality of Service) aspects such as WS-Security and WS-Addressing may be enabled on messages send sent to an endpoint using enableRM, using
enableSec and and
enableAddressing elements elements. Optionally, the WS-RM and WS-Security policies could be specified using the
policy attribute attribute.
This enables WS-Security for the message which goes for is sent to the endpoint. The optional
enableAddressing [version="final | submission"] [seperateListener=" true | false"]
This enables WS-Addressing for the message which goes for is sent to the endpoint. User can specify to have separate listener with version final or submission.
The parameters available to configure an endpoint time out are as follows.
duration that should elapse before the end point is timed out.
This parameter is used to specify the action to perform once an endpoint has timed out. The available options are as follows.
A lesser value may have a higher overhead on the system.
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.
|A comma separated error code list which can be returned by the endpoint|
Marking an endpoint for suspension
markForSuspension element contains the following parameters which affect the suspension of a endpoint which would be timed out after a specified time duration.
This parameter is used to specify one or more error codes which can cause the endpoint to be marked for suspension when they are returned by the endpoint. Multiple error codes can be specified separated by comas. See SynpaseConstant class for a possible list of available error codes.
Number of retries before go into suspended state.
The number of times the endpoint should be allowed to retry sending the response before it is marked for suspension.
The delay between each try.
the endpoint on
Leaf endpoints(Address and WSDL) endpoint can be put into suspended state if it is they are detected as failed endpoints. An endpoint that fails may be suspended When an endpoint is in in suspended state for a specified time duration after such following a failure, during which it cannot process any new messages will not be processed through the endpoint. The amount of time waiting before next attempt follows the following formulafollowing formula determines the wait time before the next attempt.
next suspension time period = Max (Initial Suspension duration * (progression factor*
*), 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 is the number of tries carried out after the endpoint is "Suspended". As suspended. The increase in the try count increases, causes an increase in the next suspension time period will also increase. This increase time period is bound to a maximum duration.
The parameters available to configure a suspension of an endpoint due to failure are as follows.
A comma separated error code list which can be returned by the endpoint.
Initial duration(in milliseconds) to suspend the endpointThis parameter is used to specify one or more error codes which can cause the endpoint to be suspended when they are returned from the endpoint. Multiple error codes can be specified, separated by commas.
|initialDuration||The number of milliseconds after which the endpoint should be suspended when it is being suspended for the first time.|
|progressionFactor||The progression factor for the geometric series. See the above formula for a more detailed description.|
Maximum The maximum duration (in milliseconds) to suspend the endpoint.
Following are the sample address URI
vfs:file:///home/user/directory\ vfs:file">file:///home/user/file\ vfs:
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.
|Name||The unique name of the endpoint.|
|Address||The 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.
|Add Property||This section is used to add properties to an endpoint.|
Description of the Address Endpoint in WSO2 ESB.