This documentation is for WSO2 Enterprise Service Bus version 4.9.0 . View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

This section describes how to manage endpoints. The actions that can be carried out for an endpoint are as follows.

Adding an endpoint

An endpoint can be added as follows.

  1. Open the ESB management console.
  2. Click Endpoints under Service Bus in the left navigator to open the Manage Endpoints page.
  3. Click on the Add Endpoint tab.
  4. Click on the endpoint type you want to add. Available types are as follows.
    • Address Endpoint  - Defines the direct URL of the service.
    • Default Endpoint  - Defines additional configuration for the default target.
    • Failover Group  - 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.
    • HTTP Endpoint - Defines a URI template based REST service endpoint.
    • Load Balance Endpoint  - 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.
    • Recipient List Group -  Defines the list of endpoints a message will be routed to.
    • Template Endpoint  - Allows to create a custom Endpoint template.
    • WSDL Endpoint  - Defines the WSDL, Service and Port.

    Enter the required information for the endpoint depending on the type you selected. Click on the relevant link above to find detailed information on how to configure the endpoint you selected.
  5. Click Show Advanced Options if you want to configure advanced settings for the endpoint. Available advanced options are as follows. 

    Field Name

    Description

    Suspend Error Codes

    This parameter allows you to select one or more error codes from the List of Values. If any of the selected errors is received from the endpoint, the endpoint will be suspended.

    Initial Duration (in mili seconds))

    The time duration for which the endpoint will be suspended, when one or more suspend error codes are received from it for the first time.

    Max Duration (Millis)

    The maximum time duration for which the endpoint is suspended when suspend error codes are received from it.

    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(in milliseconds)

    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 (in milliseconds)

    The duration in milliseconds before considering a request to be subjected to a time-out.

    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).

    Non Retry Error Codes
    Retry Error CodesWhen adding a child endpoint to a failover endpoint or load-balance endpoint, you can specify the error codes that trigger this node to be retried instead of suspended when that error is encountered. This is useful when you know that certain errors are transient and that the node will become available again shortly. Note that if you specify an error code as a Retry code on one node in the group but specify that same code as a Non Retry error code on another node in the group, it will be treated as a Non Retry error code for all nodes in the group.
  6. Click Add Property if you want to add any properties to an endpoint. The page will expand to display the following parameters. 
     

    Parameter NameDescription
    NameThe name of the endpoint property.
    ValueThe value of the endpoint property.
    ScopeThe scope of the property. Possible values are as follows.
    • Synapse
    • Transport
    • Axis2
    • axis2-client

    See XPath Extension Functions for more information about these scopes.

    ActionThis parameter allows you to delete a property.

    See Properties Reference for more information on properties that you can add to the endpoint.

  7. Click Save & Close to save the endpoint in the synapse configuration, or click Save in Registry if you want to save it as a dynamic endpoint in the Registry.

Editing an endpoint

After you add an endpoint, you can edit its attributes or semantics that are followed when communicating with that endpoint. An endpoint can be edited as follows.

  1. Open the ESB management console.
  2. Click Endpoints under Service Bus in the left navigator to open the Manage Endpoints page.
  3. Click on the Defined Endpoints tab if the endpoint you want to edit is saved in the synapse configuration. Click on the Dynamic Endpoints tab if the endpoint you want to edit is saved in the Registry. The existing endpoints saved in the synapse configuration/registry will be displayed.
  4. Click Edit for the required endpoint. Make the required modifications. See Adding an Endpoint for more information.
  5. Click Save & Close to save the endpoint in the synapse configuration, or click Save in Registry if you want to save it as a dynamic endpoint in the Registry.

Deleting an endpoint

An endpoint can be deleted as follows.

  1. Open the ESB management console.
  2. Click Endpoints under Service Bus in the left navigator to open the Manage Endpoints page.
  3. Click on the Defined Endpoints tab if the endpoint you want to delete is saved in the synapse configuration. Click on the Dynamic Endpoints tab if the endpoint you want to delete is saved in the Registry. The existing endpoints saved in the synapse configuration/registry will be displayed.
  4. Click Delete for the required endpoint. Then click Yes in the message which appears to confirm whether you want to proceed deleting the endpoint.

Enabling/Disabling statistics

Statistics can be enabled or disabled as required for Address endpoints and WSDL endpoints. Note that this action can be carried out only for  defined endpoints, which are endpoints saved in the Synapse configuration. You cannot enable statistics for  dynamic endpoints, which are saved in the Registry

Statistics can be enabled/disabled as follows.

  1. Open the ESB management console.
  2. Click Endpoints under Service Bus in the left navigator to open the Manage Endpoints page.
  3. Click on the Defined Endpoints tab. The Enable Statistics link will be displayed for endpoints with statistics currently disabled. The Disable Statistics link will be displayed for endpoints with statistics currently enabled.
  4. If you want to enable statistics for an endpoint, click Enable Statistics in the relevant row. If you want to disable statistics for an endpoint, click Disable Statistics in the relevant row.

Switching on/off

Having many active endpoints may result in heavy traffic, and thereby cause performance degradation. In order to prevent that, you can temporarily switch off some endpoints and switch them on again when you need them in an active state. Note that this action can be carried out only for  defined endpoints, which are endpoints saved in the Synapse configuration. You cannot enable statistics for  dynamic endpoints, which are saved in the Registry

An endpoint can be switched on/off as follows.

  1. Open the ESB management console.
  2. Click Endpoints under Service Bus in the left navigator to open the Manage Endpoints page.
  3. Click on the Defined Endpoints tab. The Switch On link will be displayed for endpoints which are currently switched off. The Switch Off  link will be displayed for endpoints which are currently switched on.
  4. If you want to activate an endpoint, click Switch On in the relevant row. If you want to deactivate an endpoint, click Switch Off in the relevant row.
  • No labels