IBM BPM, V8.0.1, All platforms > Programming IBM BPM > Enterprise Service Bus programming > Service gateway > Proxy gateway pattern
Proxy gateway widget
The proxy gateway widget displays a list of proxy groups that exist in the built-in configuration store.
Each proxy group in the list includes information about the installed proxy gateways that are associated with the group. When a proxy gateway is installed on a server, the proxy groups it references are automatically added to the configuration store if they don't already exist. If you uninstall a proxy gateway from the server, the proxy groups it is associated with are not deleted. This prevents the unintentional loss of configuration data for the proxy group when no proxy gateway applications are installed that reference it. You must delete the proxy group if it is no longer needed.
Figure 1.shows the proxy gateway widget in Business Space. It shows what you see when:
- a proxy group is shared by multiple proxy gateways
- a proxy gateway has multiple proxy groups
- a proxy group exists without an associated proxy gateway
Figure 1. Proxy gateway widget in Business Space
Figure 1.shows:
- There are two proxy gateways: PGW1_Gateway and PGW2_Gateway.
- There are four proxy groups: PGW1ProxyGroup, PGW2ProxyGroup, PGW3ProxyGroup, PGWSharedGroup.
- The first row has a proxy group (PGW1ProxyGroup) that is associated with a single proxy gateway (PGW1_Gateway).
- The second row has a proxy group (PGWSharedGroup) shared by multiple proxy gateways (PGW1_Gateway, PGW2_Gateway).
- Rows two and three illustrate a proxy gateway (PGW2_Gateway) that is associated with multiple proxy groups (PGWSharedGroup, PGW2ProxyGroup).
- The fourth row has a proxy group (PGW3ProxyGroup) without an associated proxy gateway.
Use the proxy gateway widget
Figure 2. Select a proxy gateway widget
Figure 2.shows how to select a proxy gateway to edit. To do this you must:
- Select the relevant proxy group row in the table, which displays a pencil icon.
- Click the
(pencil icon) which changes the widget to a new view where you can configure the virtual services for the proxy group.
- If the selected row is for a proxy group without an associated proxy gateway, a
(X icon) is visible where you can delete the proxy group.
When you create a new proxy group in the configuration store, there are no virtual services defined. When you edit it for the first time, the panel shown in Figure 3 is displayed, where you must add a virtual service by filling out the WSDL Location field.
Figure 3. Editing a new proxy group
To add a virtual service, you must enter the URL to the WSDL that is usually available by entering the service endpoint, followed by ?wsdl.
For example:
http://localhost:9080/BankServiceProviderWeb/sca/accountExport1?wsdl
(If the service provider does not support the ?wsdl convention, the WSDL can be loaded from another location such as a registry.)
You must then click Add Service, which opens the panel for defining a virtual service, as shown in Figure 4.
Figure 4. Editing a new proxy group
The information in Figure 4 can be separated into six sections:
- Port Type - The WSDL port type for the virtual service.
- Virtual Service Name - The key that is given to the URL of the export for the associated proxy gateways to create a dedicated URL
for the virtual service. You can change the generated value to something
more relevant.
For example, the default value shown in the image is accountExport1_accountHttpService, which you can change to Account or AccountService.
- Virtual Service URLs - Network addressable endpoints that are exposed for the virtual service via the associated proxy gateways.
- Endpoint URLs - An ordered list of network addressable endpoints used to forward messages for this virtual service. These are available within the Target and AlternateTarget elements of the SMO after a Gateway Endpoint Lookup mediation primitive.
- Enable Virtual Service - must be selected if the virtual service will be available to a Gateway Endpoint Lookup mediation primitive when it queries the built-in configuration store.
- Advanced Service Properties - A series of user defined key value pairs associated with the virtual service. These are available within the EndpointLookupContext of the SMO, after a Gateway Endpoint Lookup mediation primitive.
When you click Save, the widget returns to the original list of virtual services associated with the proxy group.