Routing Rule Step (Context-Based Routing, SOAP Virtual Service)
If you have a native service that is hosted at two or more endpoints, you can use the Context-Based routing protocol to route specific types of messages to specific endpoints according to the context-based routing rules you create.
A routing rule specifies where the requests should be routed, and the criteria by which they should be routed there. For example, requests can be routed according to certain consumers, certain dates/times, or according to requests that exceed/fall below a specified metric (Total Count, Success Count, Fault Count, etc.). You can create one or more rules. For example, you might use this capability to route requests from certain high-priority consumers to endpoints on a fast machine.
To configure the Routing Rule step for Context-Based routing:
1. Click the virtual service name in the CloudStreams Governance view.
2. Expand the In Sequence step in the editor.
3. Click Routing Rule and complete the following fields in the Properties view.
Name
You can optionally change the step name from Routing Rule to any other name. There are no naming convention restrictions.
Type
(Read-only field.) Routing Rule.
Protocol
(Read-only field.) HTTP.
Routing Type
Select Context-Based.
Rule Name
Assign a name to the rule.
Then, click the icon next to this field and complete the Configure Routing Rule dialog box as follows:
Choose one of the following:
Time,
IP Address (IPv4 or IPv6 format),
Date,
Consumer,
Predefined Context Variable or
Custom Context Variable (see the section
Using Context Variables in the document
Administering webMethods CloudStreams).
Note:
If you select the value Custom Context Variable, you must write an IS service to get/set the custom context variable, and then specify the service in the IS Service Name field on the Routing Rules page. CloudStreams provides an API to get/set custom context variables. For more information, see the section The API for Context Variables in the document Administering webMethods CloudStreams. CloudStreams automatically declares any custom context variables you have specified; there is no need for you to declare them.
Route To
Enter the URL of the native service to route the request to, if the rule criteria are met.
Then, click the icon next to this field and complete the Configure Endpoint Properties dialog box as follows:
Optimization Method: Select one of the following options:
None: The default.
MTOM: Indicates that
CloudStreams expects to receive a request with a Message Transmission Optimization Mechanism (MTOM) attachment, and will forward the attachment to the native service.
SwA: Indicates that
CloudStreams expects to receive a
SOAP with Attachment (SwA) request, and will forward the attachment to the native service.
Bridging between SwA and MTOM is not supported. If a consumer sends an SwA request, CloudStreams can only forward SwA to the native provider. The same is true for MTOM, and applies to responses received from the native provider. That is, an SwA or MTOM response received by CloudStreams from a native provider will be forwarded to the caller using the same format it received.
When sending SOAP requests that do not contain a MTOM or SWA attachment to a virtual service for a native provider endpoint that returns an MTOM or SWA response, the request's Accept header must be set to multipart/related (or the virtual service's In Sequence step should include an IS service callout that sets the BUILDER_TYPE context variable to multipart/related). This is necessary so CloudStreams knows how to parse the response properly.
Connection Timeout: The time interval (in seconds) after which a connection attempt will timeout. If a value is not specified (or if the value 0 is specified),
CloudStreams will use the default value specified in
Integration Server.
Read Timeout: The time interval (in seconds) after which a socket read attempt will timeout. If a value is not specified (or if the value 0 is specified), the default is 30 seconds.
SSL Options: To enable SSL client authentication for the endpoint, you must specify values for both the
Client Certificate Alias field and the
IS Keystore Alias field. If you specify a value for only one of these fields, a deployment error will occur.
SSL client authentication is optional; you may leave both fields blank.
Client Certificate Alias: The client's private key to be used for performing SSL client authentication.
IS Keystore Alias: The keystore alias of the instance of Integration Server on which
CloudStreams is running. This value (along with the value of
Client Certificate Alias) will be used for performing SSL client authentication.
Default To
Enter a native service endpoint to route the request to in case all routing rules evaluate to False.
Then, click the icon next to this field and complete the Configure Endpoint Properties dialog box, as described for the Route To field above.
Use credentials from incoming request
Default. Authenticates requests based on the credentials specified in the HTTP header. CloudStreams passes the Authorization header present in the original client request to the native service.
Use specific credentials
Authenticates requests according to the values you specify in the User, Password and Domain fields.
Invoke service anonymously
Does not authenticate requests.
Use existing HTTP headers
Use the HTTP headers that are contained in the requests.
Customize HTTP headers
Use the HTTP headers that you specify in the Name and Value columns on the tab. If you need to specify multiple headers, use the plus button to add rows.
Related Topics