IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

EndpointLookup node

Use the EndpointLookup node to retrieve service endpoint information held in the WebSphere® Service Registry and Repository (WSRR). The entities that match the specified search criteria are stored in the local environment. Depending on the node configuration, the Web service URL destination used by the SOAP and HTTP request nodes can also be set. The input message is not modified.

This topic contains the following sections:

Purpose
EndpointLookup node processing
Sample
LocalEnvironment overrides
Terminals and properties

Purpose

The EndpointLookup node retrieves service endpoint information related to a WSRR service described by WSDL. A WSDL definition defines a service in terms of an interface (referred to as a portType) made available at a specified port. The WSDL port defines the endpoint information required to access the service. Endpoints are retrieved according to search criteria defined by node properties, optionally supplemented or overridden by local environment definitions at run time. See LocalEnvironment overrides for more details.

The retrieved data is placed in the local environment tree, making it available to subsequent nodes. The input message received by the node is propagated to the output terminal unchanged. In addition, the EndpointLookup node can automatically set up the destination URL to be used by a subsequent SOAPRequest, SOAPAsyncRequest or HTTPRequest node, depending on the value of the Match Policy property, see EndpointLookup node processing. This is done by the node setting the local environment overrides that are used by those nodes.

EndpointLookup node processing

The EndpointLookup node is contained in the Web services drawer of the message flow node palette, and is represented in the IBM® Integration Toolkit by the following icon:

When the EndpointLookup node receives a message the following steps occur in sequence.

The EndpointLookup node retrieves the service data from the WSRR by using the specified search criteria.
If one or more matches are found, the EndpointLookup node adds a representation of those endpoints to the local environment tree.
- If Match Policy is set to One, a single entity is returned by WSRR and added to the local environment tree. A different entity might be returned each time the query is issued. In addition, the retrieved endpoint value is set as the local environment override for the destination URL used by SOAPRequest, SOAPAsyncRequest, or HTTPRequest nodes. If the registry contains more than one entity that matches the specified search criteria it is not possible to determine which one is returned by WSRR.
- If Match Policy is set to All, all matching entities are added to the local environment tree. The order of the entities is determined by WSRR and might vary between queries. The destination URL used by SOAPRequest, SOAPAsyncRequest, or HTTPRequest nodes is not set. Instead, you must add a compute node to your message flow to select the required address and to set up the local environment settings required by those request nodes.
The input message is propagated unchanged to the Out terminal. The local environment tree is propagated to the Out terminal, where it is available for further processing by transformation nodes. See EndpointLookup node output for details of the local environment output tree.
If no matches are found, the EndpointLookup node propagates the input message to the NoMatch terminal.
If a processing error occurs, for example if the WSRR server configured on the DefaultWSRR configurable service object cannot be connected to, or the connection times out, the EndpointLookup node propagates the input message unchanged to the Failure terminal. The ExceptionList is populated with details of the error.

Sample

Look at the following sample to see how to use this node:

WebSphere Service Registry and Repository Connectivity

You can view information about samples only when you use the product documentation that is integrated with the IBM Integration Toolkit or the online product documentation. You can run samples only when you use the product documentation that is integrated with the IBM Integration Toolkit.

LocalEnvironment overrides

You can override the RegistryLookup node properties by using local environment settings. See Dynamically defining the search criteria.

Terminals and properties

When you have put an instance of the EndpointLookup node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.

The EndpointLookup node terminals are described in the following table.

Terminal	Description
In	The input terminal that accepts a message for processing by the node.
Failure	The output terminal to which the message is routed if an error occurs within the node's processing.
Out	The output terminal to which the unmodified input message and updated local environment containing the matched registry data is sent.
NoMatch	The terminal to which the input message is sent if no matching entity is found based on the specified search criteria.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The EndpointLookup node Description properties are described in the following table.

Property	M	C	Default	Description
Node name	No	No	The node type: EndpointLookup	The name of the node.
Short description	No	No	None	A brief description of the node.
Long description	No	No	None	Text that describes the purpose of the node in the message flow.

The EndpointLookup node Basic properties are described in the following table.

Property	M	C	Default	Description	mqsiapplybaroverride command property
PortType Name	No	Yes	None	Name tuple that uniquely identifies a WebSphere Service Registry and Repository defined WSDL service portType. At least one of the properties is required. If you leave all three property values blank, an error message is shown when you try to save.	name
PortType Namespace	No	Yes	None		namespace
PortType Version	No	Yes	None		portVersion
User Properties	No	No	None	Allows a query to specify user-defined properties. Add User Properties by clicking Add. User Properties refer to the Additional Properties that are used to catalog the entities in WSRR. Enter values for Property Name, which is the case-sensitive match of the additional property in WSRR, Property Type, and Property Value. The Property Type can be: a String (the default), in which case the Property Value is a character string to be matched with the additional property value present in WSRR XPATH, or ESQL, in which case the Property Value is a XPath or ESQL expression which locates a field in the message tree that contains the character string to be matched with the additional property value present in WSRR. These User Properties and Classification properties are used in the query to uniquely identify the WSDL service port.
Classification	No	No	None	The Web Ontology Language (OWL) classification system property. Each classifier is a class in OWL, and has a Uniform Resource Identifier (URI). Using classifications in the registry can help to make objects easier to find and can also add meaning to custom objects that are unique to a particular system. Add a Classification by clicking Add and typing the complete fully-qualified OWL URI for the OWL classification. For example, it can define a particular service endpoint's lifecycle state. These User Properties and Classification properties are used in the query to uniquely identify the WSDL service port.
Match Policy	Yes	No	One	WSRR can contain multiple entities that match the search criteria specified by the previous properties. If Match Policy is set to One, at most one matching entity is returned. If Match Policy is set to All, all matching entities are returned. See EndpointLookup node output. If you request a single matching entity by setting Match Policy to One, the retrieved endpoint value is set as the local environment override for the destination URL used by SOAPRequest, SOAPAsyncRequest, or HTTPRequest nodes.

The Monitoring properties of the node are described in the following table.

Property	M	C	Default	Description
Events	No	No	None	Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box.

ac55830_.htm |

Last updated Friday, 21 July 2017