Adding a port to a Service - Cloud

Talend Cloud API Services Platform Studio User Guide

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Design and Development
EnrichPlatform
Talend Management Console
Talend Studio

About this task

A port defines an individual endpoint by specifying a single address for a binding. The port contains a Binding attribute that references a binding and an address element that provides a specification for the endpoint.

Services are used to group sets of related ports together. Ports within a Service have the following relationship:

  • None of the ports communicate with each other (for example, the output of one port is not the input of another).

  • If a Service has several ports that share a port type, but employ different bindings or addresses, the ports are alternatives. Each port provides semantically equivalent behavior (within the transport and message format limitations imposed by each binding).

  • You can determine a Service's port types by examining its ports. Using this information, a user can determine if a given machine supports all the operations needed to complete a given task.

To add a port to a Service, complete the following steps:

Procedure

  1. In the design workspace, right click the Service you want to add a port to and select Add Port in the contextual menu.
  2. The Port Wizard displays. Fill in the Name for the port. The name of the port should provide it with a unique name among all the ports defined within the Service.
  3. Select a Binding for the port. For more information on how to set a binding, see Setting a binding.
  4. Select a Protocol for the port from the Protocol list and enter the address of the port into the Address field that appears.
  5. Click Finish to validate the creation. The port is added to the Service and its Properties view displays.
  6. To select the new port, click the port in the service object. You can change the information you entered about this port any time in the General tab of its Properties view.
  7. Type any information about the port you want the user to read in the Documentation tab of the Properties view.
  8. To manage extensions, click the Extensions tab. You can either add, sort, or remove extensions.

Results

You can create a new binding for your port or re-use an existing one. A binding defines the message format and protocol details for operations and messages defined by a particular port type. For more information, see Setting a binding.