Gateway services [Settings]
A gateway service provides the configuration of the web service enablement of a service destination, along with the information that maps to one or more target destinations.
To view this page in the console, click the following path:
When creating a gateway service, you map an existing destination that hosts a target service (either an internal service or an external web service) to a new web service that seems to be provided by the gateway. This approach provides the following benefits:
- The gateway service is made available at a different web address to the target service, so we can replace or relocate the target service
without changing the details for the associated gateway service.
- We can have more than one target service (that is, more than one implementation of the same logical service) for each gateway service.
- The gateway service can be made available on a different service
integration bus to the target service.
- The gateway provides a common interface to the services in each set. Your gateway service users need not know where each underlying service is located, or whether the underlying service is being provided internally or sourced externally, or whether there are multiple target services available for a single gateway service.
Because we can have more than one target service, specify a default target service for use if no target has been specified for the requesting client or selected by using a mediation.
Configuration tab
The Configuration tab shows configuration properties for this object. These property values are preserved even if the runtime environment is stopped then restarted. See the information center task descriptions for information about how to apply configuration changes to the runtime environment.
General Properties
Gateway service name
The name of the gateway service.
This name must be unique, and it must obey the following syntax rules:
- It must not start with "." (a period).
- It must not start or end with a space.
- It must not contain any of the following characters: \ / , # $ @ : ; " * ? < > | = + & % '
| Required | Data type |
|---|---|
| Yes | String |
Description
An optional description of the gateway service.
| Required | Data type |
|---|---|
| No | Text area |
Gateway request destination name
The name of the service destination to be used to process request messages for this gateway service.
| Required | Data type |
|---|---|
| No | String |
Request mediation
The optional name of the mediation that is run to process messages on the request destination.
We can use a mediation to override the default target service. For example, we can specify that requests from a particular client should always be routed to a particular target service whether or not it is the default target service.
| Required | Data type |
|---|---|
| No | drop-down list |
Request mediation bus member
The optional bus member to which the request mediation is assigned.
| Required | Data type |
|---|---|
| No | drop-down list |
Gateway response destination name
The name of the service destination to be used to process response messages for this gateway service.
| Required | Data type |
|---|---|
| No | String |
Response mediation
The optional name of the mediation that is run to process messages at the response destination.
| Required | Data type |
|---|---|
| No | drop-down list |
Response mediation bus member
The optional bus member to which the response mediation is assigned.
| Required | Data type |
|---|---|
| No | drop-down list |
Additional Properties
- Target services
- A target service is one of a set that may be routed to from a gateway service.
- Inbound web service enablement
- Configure the enablement of the gateway service as a web service.
Related concepts
Related tasks
Related information:
Reference topic