Endpoint Management - User Guide

Endpoint Management

Use the Endpoint Management feature to add, remove and change endpoints. The endpoints defined here can be used when you are designing proxy services.

  1. In the navigator, under Manage/Mediation, click Endpoints. The Manage Endpoints page appears.
  2. In the Add Endpoint list, select the endpoint you want to add. The available options are:
    • Address Endpoint - Defines the direct URL of the service
    • 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.
Selections for Endpoints

Figure 1: Selections for Endpoints

    Adding an Address Endpoint

    1. In the Add Endpoint list, click Address Endpoint. The Address Endpoint page appears.
    2. Figure 2: Configuring Address Endpoint
    3. Enter the required details in the fields. The following fields are specific to the Address Endpoint.
      • Name: The unique name for the endpoint
      • Address: The URL of the endpoint.
      • 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/GET) - 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)

    Note : The rest of the fields are general to all endpoints. Common Field Descriptions.

    Adding a WSDL Endpoint

    1. In the Add Endpoint list, click WSDL Endpoint. The WSDL Endpoint page appears.
      Figure 3: Configuring WSDL Endpoint
    2. Enter the required details in the fields. The following fields are specific to the WSDL Endpoint.�
      • Name: A unique name for the endpoint.
      • Specify As: The method to specify the WSDL. The available values are:
        • In-lined WSDL: Paste the WSDL in the text box that appears when this option is selected.
        • URI: Activates the WSDL URI field.
      • WSDL URI: The URI of the WSDL.
      • Service: The�service�selected from the available services for the WSDL.
      • Port: The port selected for the service specified in the above field. In a WSDL, an endpoint is bound to each port inside each service.

    Note: The rest of the fields are general to all endpoints. Common Field Descriptions.

      Adding a Fail-Over Endpoint

      1. In the Add Endpoint list, click Fail-Over Endpoint. The Failover Endpoint page appears.
      2. In the Endpoint Name field, enter a name for the endpoint.
      3. Click root. A shortcut menu with the available endpoints appears.
        Configuring Fail-over EndpointFigure 4: Adding Fail-over Endpoint

      4. Click on the endpoint you want to add as a failover endpoint.A tab with the fields relevant to the selected endpoint appears.
      5. Enter the details and click Save. Field Descriptions The following screenshot displays�adding a Address endpoint to the fail-over endpoint list.
        Configuring Fail-over EndpointFigure 5: Configuring Fail-over Endpoint You can add fail-over and load-balance endpoints interchangeably to as many levels as you want. The above screenshot is a possible arrangement of endpoints prepared for demonstration purposes.

      Adding a Load-Balance Group Endpoint

      1. In the Add Endpoint list, click Load Balance Group Endpoint. The Load Balance Group Endpoint page appears.
      2. Enter the required details in the fields. The following fields are specific to the Load-balance Group Endpoint.�
        • Endpoint Name: A unique name for the endpoint.
        • Session Management: A session management method from the load balancing group. The possible values are.
          • None: Session management is not used.
          • Transport: Session management is done on the transport level using HTTP cookies.
          • SOAP: Session management is done using SOAP sessions.
          • Client ID: Session management is done using an ID sent by the client.
        • Session Timeout(ms): Session timeout in milliseconds.
        Configuring Load balance Endpoint

        Figure 6: Configuring Load balance Group Endpoint

      3. Click root. A shortcut menu with the available endpoints appears
      4. Click on the endpoint you want to add as a load-balance group endpoint.A tab with the fields relevant to the selected endpoint appears.
      5. Enter the details and click Save. You can add as many endpoints as you need to the load balancing group. Field Descriptions
      6. Note : Please refer to the�Fail-over endpoint section on this guide for explanations and screen shots about how you can design the load balancing and fail-over endpoints in multiple levels

      Description of Fields Common to All Endpoints

      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 re-tries, in milli seconds.
      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 milli seconds 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).

      For more information please refer to the WSO2 library