This documentation is for WSO2 ESB version 4.0.2. View documentation for the latest release.

Adding an Endpoint

Owned by Former user (Deleted)
Last updated: Dec 13, 2011Version comment
3 min read

An endpoint is a specific destination for a message. An endpoint definition within the mediation configuration defines an external service endpoint and any attributes or semantics that should be followed when communicating with that endpoint.

Follow the instructions below to add a new endpoint.

1. Sign in. Enter your user name and password to log on to the ESB Management Console.

2. Click on "Main" in the left menu to access the "Manage" menu.

3. In the "Manage" menu, click on "Endpoints" under "Service Bus."

4. The "Manage Endpoints" page appears.

Select an endpoint you want to add. The available options are:

  • Address Endpoint - Defines the direct URL of the service.
  • Default Endpoint - Defines additional configuration for the default target.
  • WSDL Endpoint - Defines the WSDL, Service and Port.
  • Fail-over Endpoint - Defines the endpoints that the service will try to connect to in case of a failure. This will take place in a round robin manner.
  • Load-Balance Group - Defines groups of endpoints for replicated services. The incoming requests will be directed to these endpoints in a round robin manner. These endpoints automatically handle the fail-over cases as well.
  • Template Endpoint - Allows to create a custom Endpoint template.

5. Specify the required details according to the type of endpoint. For the detailed description of special options see:

Common options are as follows:

Field Name

Description

Suspend Error Codes

A list of error codes. If these error codes are received from the endpoint, the endpoint will be suspended.

Initial Duration (Millis)

The duration that the endpoint is suspended for the first time after the receiving the suspend error codes.

Max Duration (Millis)

The maximum duration that the endpoint is suspended after the receiving the suspend error codes.

Factor

The duration to suspend can vary from the first time suspension to the subsequent time. The factor value decides the suspense duration variance between subsequent suspensions.

On Timeout Error codes

A list of error codes. If these error codes are received from the endpoint, the request will be subjected to a timeout.

Retry

The number of re-tries in case of a timeout, caused by the above listed error codes.

Retry Delay(Millis)

The delay between retries, in milliseconds.

Timeout Action

The action to be done at a timeout situation. You can select from:

  • Never Timeout
  • Discard Message
  • Execute Fault Sequence

Timeout Duration (Mills)

The duration in milliseconds before considering a request as timeout.

WS-Addressing

Adds WS-Addressing headers to the endpoint.

Separate Listener

The listener to the response will be a separate transport stream from the caller.

WS-Security

Adds WS-Security features as described in a policy key (referring to a registry location).

WS-Reliable Messaging

Adds WS-Reliable Messaging features as described in a policy key (referring to a registry location).

6. Add properties to an Endpoint if necessary. Use the "Add Property" link.

7. Fill in the fields:

  • Name - The Endpoint properties name.
  • Value - The Endpoint properties value.
  • Scope - Can be selected as:
    • Synapse
    • Transport
    • axis2-client
    • Axis2
  • Action - Allows to delete a property.

See more information in Properties.

8. Click "Save."