Adding outbound endpoints

Define an outbound endpoint that represents the destination for HTTP or Java™ Message Service (JMS) messages. When you define the endpoint, you must ensure that it references an outbound binding, and either a URL, or a JMS connection factory and destination. If necessary, you can also set advanced properties on an outbound endpoint.

About this task

You use the completion menu of the Connectivity Definition editor to specify the required elements in the .cdef file.

An outbound HTTP endpoint requires these elements:
define outbound type endpoint 'endpoint_name' 
   with 
      description "endpoint_description",
   using 
      binding 'referenced_binding', 
   url "endpoint_url".

An outbound JMS endpoint requires these elements:

define outbound JMS endpoint 'endpoint_name' 
   with 
      description "endpoint_description",
   using 
      binding 'referenced_binding', 
   connection factory "connection_factory",
   destination "destination".

The endpoint is part of a solution and the .cdef file that you create is stored in the connectivity folder in the solution project. If your solution includes multiple endpoints, after you complete the first endpoint definition you must repeat steps 2 - 6 for each additional endpoint.

There are several ways in which you can create and maintain endpoint and binding definitions in .cdef files, depending on the complexity of your project. You can define all related assets in a single .cdef file, but you must define assets that require partitioning in separate .cdef files:

  • For simple projects, you can create one .cdef file for inbound assets, and one .cdef file for outbound assets. Because inbound and outbound assets never reference each other, the use of two .cdef files provides a simple way of partitioning.
  • For more complex projects that contain several bindings, you can define each binding in its own .cdef file. You can also include the endpoint assets that use that binding, in the same .cdef file.

Procedure

  1. Open the .cdef file.
  2. Specify the endpoint name.
  3. Optional: Specify the description.
  4. Specify the binding name.
    The value is the name of the binding for which this endpoint sends messages.
  5. For an HTTP outbound endpoint, specify the URL. For a JMS outbound endpoint, specify the connection factory and JMS destination.
    • If creating an HTTP outbound endpoint, you must specify the URL on which this endpoint sends messages. You can also specify the host name and port as part of the URL. If you specify these values, they are treated as reference information, and do not change the runtime behavior.
  6. Optional: If required, set custom properties on the outbound endpoint.
    For example, you might want to specify outbound JMS messages as bytes instead of text.
  7. Save your work.

Example

An outbound HTTP endpoint:
define outbound HTTP endpoint 'insuranceClaimsOutbound' 
   with 
      description "Outbound insurance claims endpoint",
   using 
      binding 'insuranceClaims', 
   url "http://claims.example.org/claims/outbound".
Outbound JMS endpoint:
define outbound JMS endpoint 'insuranceClaimsOutbound' 
   with 
      description "Outbound insurance claims endpoint",
   using 
      binding 'insuranceClaims', 
   connection factory "jms/ClaimsConnectionFactory", 
   destination "ClaimsQueue".

What to do next

Create the connectivity configuration files, and then deploy your connectivity configuration. For more information about creating connectivity configuration files, see Creating connectivity configuration files.