Use the Web services gateway to map an existing service - either
an inbound or an outbound service - to a new Web service that appears to be
provided by the gateway. The gateway service acts as a proxy: your gateway
service users need not know whether the underlying service is being provided
internally or externally.
Before you begin
For a high-level task view of how you configure the
Web services gateway as part of an overall SIBus Web services configuration,
see Enabling Web services through service integration technologies.
You
configure each gateway service for a specific gateway instance, so you must create a
gateway instance before you can configure any gateway services for
it.
The gateway service WSDL is created from the WSDL for the first
target service. If the target service is an external Web service, it already
has an associated WSDL. If it is an internal service:
This topic also assumes that:
You can create a new gateway service through the administrative
console as described in this task, or you can create a new gateway service through the command line.
Why and when to perform this task
A gateway service is
the Web interface for an underlying service (the target service). The gateway
service is made available at a different location to the target service, so
you can replace or relocate the target service without changing the details
for the associated gateway service. You can also have more than one target
service (that is, more than one implementation of the same logical service)
for each gateway service. For more information, see Target
services and gateway services.
The target service can be either
an externally-provided Web service, or a service that is available internally
to your organization, and it can be located at a destination that is on a
different bus to the gateway service. If the target service is an internal
service, the new gateway service is always created based upon the template
WSDL for the service and the bus destination at which it is available. If
it is an externally-provided Web service, the new gateway service is usually
created based upon the externally-published WSDL for the service, and at a
new bus destination. However if the target is an externally-provided Web service
that is already available at a bus destination (for example because it has
previously been configured as an outbound service) then you should provide
the destination details as part of the new gateway service creation process.
Otherwise the same external Web service is made available at two different
destinations.
You can control and monitor access to your gateway services
in the following ways:
- You can control which groups of users can access a particular gateway
service by making the service available only through a particular gateway instance.
- You can associate JAX-RPC handler lists with ports, so that the handlers
can monitor activity at the port, and take appropriate action depending upon
the sender and content of each message that passes through the port.
- You can set the level of security to be applied to messages (the WS-Security
binding). The security level can be set independently for request and response
messages.
When you create a new gateway service, you configure a single
target service as a new Web service that seems to be provided by the gateway.
After you create your new gateway service, you can add more target services
(that is, more implementations of the same logical service) by modifying the existing gateway service configuration.
To
create a new gateway service through the administrative console, complete
the following steps. For more information about the new gateway service properties,
see Gateway services
settings.
Steps for this task
- Start the administrative console.
- In the navigation pane, click bus_nameinstance_name. The gateway
services collection form is displayed.
- Click New. A panel is displayed
through which you select the first target service for your new gateway service.
- Choose one of the two methods to create your gateway service (either
through a WSDL-defined Web service provider or a Service destination)
then click Next.
Note: If the target service
is an internal service, or an externally-provided Web service that is already
available at a destination, select Service destination. If the target
service is an externally-provided Web service that is not already available
at a bus destination, select WSDL-defined Web service provider and
the target service is configured to a new destination.
The
New gateway service wizard is displayed for the service creation method that
you selected.
- Optional: If you selected WSDL-defined Web service
provider, complete the following steps:
- Specify the gateway service name, gateway service destinations
and mediations.
Note: - Choose a gateway service name that is unique across all gateway and proxy
services within the current gateway instance. If you enter a name that is
not unique, an error message is displayed.
- You need not provide gateway destination names. If you leave either of
these fields blank, a default name is generated for you when the wizard completes
its operation. The default names are not displayed on the panel. They are
constructed as follows:
- The request destination name is the same as the gateway service name.
For example: myGatewayService.
- The reply destination name is the same as the request destination name,
followed by "Reply". For example: myGatewayServiceReply.
- The lists of available mediations contain all mediations that are currently
deployed to this service integration bus. If you have created a mediation and deployed it to the bus, then it is available
for selection in both these lists. If you do not want to use a mediation with
this gateway service, select none from either or both selection
lists.
- Bus members are application servers or clusters that are added to this
bus. The Request mediation bus member and the Response mediation
bus member properties define the bus members to which the corresponding
mediation is assigned. If you change the Request mediation or the Response
mediation property value to (none), you should also change
the corresponding bus member property value to (none). If
you want to use a mediation, assign it to a bus member. If you do not do this,
the administrative console displays an error message.
- Locate the target service WSDL.
- Select the service from the WSDL.
Note: - This option is needed in case there is more than one service in the WSDL.
The field is filled in for you by default. If there is only one service in
the WSDL, accept the default.
- There needs to be at least one port defined in the service you select.
- Select the ports that are to be enabled for this service.
Note: - The list of available ports is the set of ports that are described in
the WSDL file.
- Select at least one port.
- Name the outbound service, the service destination and all of
the port destinations.
Note: - Default names are generated, but you can rename them. The default names
are unique within the current service integration bus. Any replacement names
that you choose must be similarly unique. If you enter a name that is not
unique, an error message is displayed.
- If you have created a port selection mediation and deployed it to the
bus, then it is available for selection in the list of mediations. If you
do not want to use a port selection mediation with this gateway service, select none from
the selection list. This list contains all mediations, including port selection
mediations, that are currently deployed to this service integration bus.
- The list of available ports is a subset of the ports that are described
in the WSDL file. You chose this subset in the previous step.
- Assign each port destination and (optionally) the port selection
mediation to a bus member.
Note: - The option to assign a port selection mediation to a bus member is only
displayed if you selected a mediation in the previous step.
- Select endpoint listeners for the inbound configuration of this
gateway service.
- Define any UDDI publication properties.
- Optional: If you selected Service destination,
complete the following steps:
- Specify the gateway service name, gateway and target service
destinations and mediations.
Note: - Choose a gateway service name that is unique across all gateway and proxy
services within the current gateway instance. If you enter a name that is
not unique, an error message is displayed.
- The target service need not be available on the same bus as the gateway
service, so specify the bus and associated service destination at which the
target service is available.
- The Target bus name field lists all available buses. The Target
destination name field lists all available destinations. When you choose
a bus and an associated destination, choose a destination that is available
on the bus that you select. If you do not do this, the administrative console
displays an error message.
- You need not provide gateway destination names. If you leave either of
these fields blank, a default name is generated for you when the wizard completes
its operation. The default names are not displayed on the panel. They are
constructed as follows:
- The request destination name is the same as the gateway service name.
For example: myGatewayService.
- The reply destination name is the same as the request destination name,
followed by "Reply". For example: myGatewayServiceReply.
- The lists of available mediations contain all mediations that are currently
deployed to this bus. If you have created a mediation and deployed it to the bus, then it is available
for selection in both these lists. If you do not want to use a mediation with
this gateway service, select none from either or both selection
lists.
- The Request mediation bus member and the Response mediation
bus member properties define the bus members to which the corresponding
mediation is assigned. If you change the Request mediation or the Response
mediation property value to (none), you should also change
the corresponding bus member property value to (none). To
use a mediation, assign it to a bus member. If you do not do this, the administrative
console displays an error message.
- Select the WSDL location.
Note: For an internal service,
the template WSDL is the service-specific WSDL file that describes the service
that is directly available at a service destination.
- Select the service from the WSDL.
Note: - This option is needed in case there is more than one service in the WSDL.
The field is filled in for you by default. If there is only one service in
the WSDL, accept the default.
- There needs to be at least one port defined in the service you select.
- Select endpoint listeners for the inbound configuration of this
gateway service.
- Define any UDDI publication properties.
- If the target service is an external Web service, the option Outbound
Web service enablement is available in the additional properties section.
Click this option to modify the outbound service configuration for this target
service. For more information, see Modifying an
existing outbound service configuration.
- Click Finish.
If the processing completes successfully, the list of gateway services
for this gateway instance is updated to include the new gateway service. Otherwise,
an error message is displayed.
To modify your new gateway service, or to add additional target services
(that is, additional implementations of the same logical service) to your
gateway service, see
Modifying an existing gateway service configuration. To
set the level of security to be applied to messages (the WS-Security binding),
see
Configuring secure transmission of SOAP messages using WS-Security.