Gateway Endpoint Lookup mediation primitive properties

You can specify values for mediation primitive properties either by using the property fields in the IBM® Integration Designer user interface or by using an XML format. The property field names displayed in IBM Integration Designer are generally different from the property names used when building a mediation flow using XML code. In the following information, icons are used to identify each property name used in IBM Integration Designer and the corresponding XML name. (Where applicable, XML names that are required, but not shown in IBM Integration Designer, are also described.)

Lookup Method

Specifies how the endpoint is identified, either in the built-in configuration store or in WSRR.
Field detail Value and notes
Required Yes
Valid values
URL 0
Query the built-in configuration store, using the input URL as the virtual service name. A proxy gateway can use a Lookup Method of URL or XPath.
Action 1
Query WSRR, for all endpoints with the action value specified by the message.
XPath 2
Query the built-in configuration store, using a virtual service name located using an XPath expression. A proxy gateway can use a Lookup Method of URL or XPath.
Note:
Default URL

Proxy Group Names

If you want to create a proxy gateway, specify the name of one or more proxy groups.
When you install the proxy group module, the proxy groups are created in the built-in configuration store. If you do not specify a proxy group name, a default proxy group is created when you install your module. The default proxy group is called modulenameProxyGroup, where modulename is the name of your module.
Note: You should specify a proxy group name; otherwise, when you uninstall your proxy gateway module, the proxy group is deleted, assuming that no other proxy gateway modules reference the proxy group.

Lookup XPath

If you select a Lookup Method of XPath, specify the XPath expression that locates the virtual service name in the SMO.
Field detail Value and notes
Required No
Valid values XPath
Note:

Registry Name

If you select a Lookup Method of Action, specify the WSRR definition to be used by the Gateway Endpoint Lookup mediation primitive. A WSRR definition is created using the server administrative console and provides connection information for a WSRR instance. At least one WSRR definition needs to exist on the server that your module is installed to. If the Registry Name is absent, then the default WSRR definition is used.
Field detail Value and notes
Required No
Valid values String
Note:

Classification URIs

Search for objects that match a particular classification.

To extract endpoint information about web services then, in WSRR, you must specify any classifications on the appropriate WSDL Port objects.

SRR classifies objects using the ontology classification system (OWL), in which each classifier is a class and has a URI. OWL implements a simple hierarchical system. For example, a bank account could start with the following details:
  • Account
    • Identifier
    • Name
      • First name
      • Second name
  • Address
    • First line of address
    • Second line of address
Specifying a classification of Address matches any object classified as Address, First line of address or Second line of address

User Properties

Search the registry for services that are annotated with user-defined properties.
Note: To extract endpoint information about web services, in WSRR you must specify any user properties on the appropriate WSDL Port objects.
Field detail Value and notes
Name name
The name of the user-defined property. The valid type is String.
Type type
The type of the user-defined property. If the type is String, then what you specify as the Value is used as a literal, in the search query. If the type is XPath, then what you specify as theValue must be an XPath expression. The XPath expression must resolve to a unique leaf node in the inbound SMO. The value of the leaf node is used in the search query.
Value value
The value of the user-defined property. This can be either a literal value or an XPath expression, depending upon the Type property.

Considerations

  • If the Use dynamic endpoint if set in the message header property is not set in the callout node, the runtime environment does not use the dynamic endpoint in /headers/SMOHeader/Target/address. In this case, the runtime environment uses the default endpoint if there is one, or throws an error.
  • If the Lookup XPath expression resolves to more than one element in the SMO, a runtime exception occurs.
  • All Classification or User Properties specified for a Gateway Endpoint Lookup mediation primitive result in a query that combines all of these properties using a logical AND.
  • If you want to use Classification URIs that include white space characters, the correct URI encoding should be used. For example, a single character space should be represented as %20.
  • White space characters provided in any of the Gateway Endpoint Lookup mediation primitive properties are treated as literal characters. They are not removed by the Gateway Endpoint Lookup mediation primitive when querying the registry. For example, if you specify a Classification property and the expected results are not returned from a query, ensure there is no white space before or after the Classification URI.

Sample XML code

<node name="GatewayEndpointLookup1" type="GatewayEndpointLookup" >
  <table name="proxyGroupNames">
    <row>
      <property name="name" value="myProxyGateway"/>
    </row>
  </table>
  <inputTerminal/>
  <outputTerminal>
    <wire targetNode="PolicyResolution"/>
  </outputTerminal>
  <outputTerminal name="noMatch"/>
  <failTerminal/>
</node>
Parent topic: Gateway Endpoint Lookup mediation primitive