An endpoint listener is the point (address) at which messages
for an inbound service are received. The endpoint listeners that are
supplied with WebSphere Application Server support SOAP over HTTP
and SOAP over JMS bindings.
About this task
Endpoint listeners are a physical endpoint for receiving
inbound service requests. An inbound service describes a bus destination
as a logical Web service. An inbound port associates a (logical)
inbound service with an endpoint listener to provide a (physical)
endpoint where the service can be invoked. Therefore you must have
defined an endpoint listener before you can create an inbound port.
A
request arrives at an endpoint listener. It is passed to an inbound
port (at which point security and JAX-RPC handler lists can be applied)
then sent on to the service destination. Responses follow the same
path in reverse.
To use the administrative console to configure an endpoint
listener, complete the following steps:
Procedure
- Start the administrative console.
- In the navigation pane, click one of the following paths:
The endpoint
listeners collection form is displayed.
- Click New. The
New endpoint listener wizard is displayed.
- Use the wizard to create the new endpoint listener configuration
by completing the following steps. For more information about the
properties that you set with the wizard, see Endpoint Listeners [Settings].
If you want to configure an endpoint listener with values that match
those used for an endpoint listener supplied with WebSphere Application
Server Version 6.0, see Endpoint listener configuration details for Version 6.0.x compatibility.
- Select listener name and binding type.
- Endpoint listener name
- Type the name of your choice by which the endpoint listener is
known. For example: wsgwsoaphttp; wsgwsoaphttp2; SOAPJMSChannel1; SOAPJMSChannel2.
- Binding type
- Select the type of binding that this endpoint listener supports.
For a SOAP over HTTP or SOAP over HTTPS endpoint listener, select SOAP/HTTP or SOAP/HTTPS.
For a SOAP over JMS endpoint listener select SOAP/JMS.
- Optional: Configure JMS settings.
This
panel is only displayed if you selected SOAP/JMS in
the previous panel.
You can choose to deploy your endpoint listener
application to use an activation specification (for use with the default
messaging provider) or a listener port (for use with another JMS provider
such as the WebSphere MQ
messaging provider).
Select from the drop-down lists the listener
port, or the activation specification and queue connection
factory that you have previously configured as described in Configuring JMS resources for the synchronous SOAP over JMS endpoint listener.
- Configure required URLs.
Configure Web
addresses for the application root and the WSDL serving root. You
can either select pre-configured addresses based on the known
virtual
hosts, or create new values.
Transitioning note: The panel providing some suggestions for the URL root,
based on the known virtual hosts, was added in Version 6.1 of the
product. In Version 6.0, this panel is not available.
- URL root
- Select or type the address at which external clients access the endpoint listener endpoint. The URL root is the context root of the endpoint listener application, and provides the root of the Web address that is used to build the endpoint addresses within WSDL files to direct requesters to this endpoint listener.
- An HTTP server can be used with a stand-alone application sever.
Alternatively, if your endpoint listener is used by external clients
to access a cluster providing high availability or workload management
capability, your cluster normally employs a suitably configured HTTP
server (or WebSphere proxy server) operating as an IP-sprayer. In
either case, if external clients access the endpoint listener through
an HTTP server or server cluster, using default port 80, then specify
the HTTP server name and no port number. For example (for SOAP over HTTP endpoint listener 1):
http://www.yourcompany.com/wsgwsoaphttp1
Transitioning note: The
/wsgwsoaphttp1 portion
of the URL root in the previous example is the context root of the
web module within the endpoint listener application. In Version 6.0
of the product, this context root portion had to match certain predefined
values within the endpoint listener applications. These predefined
values are documented in
Endpoint listener configuration details for Version 6.0.x compatibility.
In Version 6.1, any values can be used, including the predefined values
used in Version 6.0, provided they do not conflict with another installed
application. In Version 6.1, the product configures the endpoint
listener application to match the value that you supply.
For
a stand-alone application server, your endpoint listener is typically
configured for clients to connect directly to an individual application
server. If your endpoint listener is used by external clients to access
a cluster, you can configure the listener so that clients connect
directly to an individual application server within the cluster as
shown in the following example, but this may restrict the high availability
or workload management capabilities of your cluster. However, if you allow external clients to connect direct to your application server (for example because it is a stand-alone server or in a development or test environment) then specify the application server host name and port number. For example (for SOAP over HTTP endpoint listener 1):http://your.server.name:9080/wsgwsoaphttp1
where
the port number (specified as 9080 in this example) matches the WC_defaultHost port
value for the application server concerned.
- WSDL serving HTTP URL root
- Type the root of the Web address for the WSDL files of the inbound
services that are available at this endpoint listener. This address comprises the root of the HTTP address at which external clients access your endpoint listener application, followed by /sibws. This
represents the URL that is used when publishing the WSDL URL to a
UDDI registry. The host and port name you specify for the WSDL
serving HTTP URL root typically match those you specify
for the URL root.
If external clients access the endpoint listener through
an HTTP server or server cluster, typically using default port 80, then this
URL root includes the HTTP server name and no port number. For example:
http://www.yourcompany.com/sibws
However,
if you allow external clients to connect direct to your application server
(for example in a development or test environment) then this URL root includes
the application server host name and port number. For example:
http://your.server.name:9080/sibws
Note: The WSDL serving HTTP URL root is only used internally by other components of IBM WebSphere Application Server (notably the IBM UDDI registry). For all other uses, you access the WSDL file through the endpoint listener endpoint for the inbound service. To get the location details for a given inbound service WSDL file, publish the WSDL file to a zip file as described in Modifying an existing inbound service configuration, then look up the location within the exported WSDL file.
- Click Finish.
Results
If the processing completes successfully, the list of endpoint
listeners is updated to include the new endpoint listener. Otherwise,
an error message is displayed.