Lookup REST Service - 8.0

Talend ESB Infrastructure Services Configuration Guide

Version
8.0
Language
English
Product
Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend ESB
Talend Runtime
Content
Design and Development
Installation and Upgrade
Last publication date
2024-03-13

The Lookup REST interface diagrammed below retrieves from the Service Registry:

  • WSDL documents for a service specified by name

  • WSDL documents for a service specified by name, merged with provider policies

  • WSDL documents for a service specified by name, merged with consumer policy specified by consumer policy alias

  • WS-Policy resources applied to the WSDL subject under the scope of a specified service

  • WS-Policy resources applied to the WSDL subject under the scope of a specified service and consumer policy alias

Where:

  • {baseUri} refers to the service base URI, http://localhost:8040/services/registry/lookup by default with Talend Runtime

  • {serviceQName} refers to the service QName in {namespace}name string format

  • {consumerPolicyAlias} refers to the parameter which can be specified to request consumer policy

  • {withMergedPolicy} refers to the parameter to use to lookup WSDL document merged with the applied policies

The default URL for accessing the service WADL is http://localhost:8040/services/registry/lookup?_wadl.

WSDL and WS-Policy lookups are both handled via GET requests using this interface.

  • To lookup a WSDL by {serviceQName}, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/wsdl/{serviceQName}

    For example, to get the WSDL for service with name {http://services.talend.org/ReservationService}ReservationServiceProvider, execute a GET request using address:

    http://localhost:8040/services/registry/lookup/wsdl/%257Bhttp%253A%252F%252Fservices.talend.org%252FReservationService%257DReservationServiceProvider
  • WS-Policy Lookup returns policy documents as a multipart HTTP response. For example, to lookup policies for a service with name {http://services.talend.org/CRMService}CRMServiceProvider, execute a GET request on address:

    http://localhost:8040/services/registry/lookup/policy/%257Bhttp%253A%252F%252Fservices.talend.org%252FCRMService%257DCRMServiceProvider

But in case, a non native ESB Java consumer is used (for example, a .NET consumer), it becomes more interesting to get the WSDL with all Policies merged into the WSDL from the Service Registry Lookup service. This enhancement of the Service Registry Lookup is provided as additional options for lookup which the consumer must explicitly call. It is also possible for the consumer to asked, via the consumer policy alias, to get an explicit consumer policy merged into the WSDL for the service.

Below are the new enhanced lookup services:

  • To lookup a WSDL by {serviceQName} merged with provider policies, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/wsdl/{serviceQName}?mergeWithPolicies=true
  • To lookup a WSDL by {serviceQName} merged with consumer policies by {consumerPolicyAlias}, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/wsdl/{serviceQName}?mergeWithPolicies=true&consumerPolicyAlias={consumerPolicyAlias}
  • To lookup provider policies by {serviceQName}, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/policy/provider/{serviceQName}
  • To lookup default consumer policies by {serviceQName}, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/policy/consumer/{serviceQName}
  • To lookup consumer policies by {serviceQName} and {consumerPolicyAlias}, run a GET request on the following address:

    http://localhost:8040/services/registry/lookup/policy/consumer/{serviceQName}?consumerPolicyAlias={consumerPolicyAlias}