The Web service endpoint address is the URL that a client application
must specify to access the Web services APIs. The endpoint address is written
into the WSDL file that you export to generate a proxy client for your client
application.
Why and when to perform this task
The Web service endpoint address to use depends on your WebSphere® server
configuration:
- Scenario 1. A single WebSphere server. The WebSphere endpoint address to specify
is the host name and port number of the server, for example host1:9080.
- Scenario 2. A WebSphere cluster composed of several servers.
The WebSphere endpoint
address to specify is the host name and port of the server that is hosting
the Web services APIs, for example, host2:9081.
- Scenario 3. A Web server is used as a front end. The WebSphere endpoint
address to specify is the host name and port of the Web server, for example: host:80.
By default, the Web service endpoint address takes the form protocol://host:port/context_root/fixed_path.
Where:
- protocol. The communications protocol to be used between
the client application and the WebSphere server. The default protocol
is HTTP. You can instead choose to use the more secure HTTPS (HTTP over SSL)
protocol. It is recommended to use HTTPS.
- host:port. The host name and port number used to access
the machine that is hosting the Web services APIs. These values vary depending
on the WebSphere server configuration; for example, whether your client application
is to access the application directly or through a Web server front end.
- context_root. You are free to choose any value for
the context root. The value you choose must, however, be unique within each WebSphere cell.
The default value uses a "node_server/cluster" suffix that eliminates the
risk of naming conflicts.
- fixed_path is either /sca/com/ibm/bpe/api/BFMWS (for
the Business Flow Manager API) or /sca/com/ibm/task/api/HTMWS (for
the Human Task Manager API) and cannot be modified.
The Web service endpoint address is initially specified when configuring
the business process container or human task container:
Steps for this task
- Log on to the administrative console with a user ID with administrator
rights.
- Choose .
Note: You can also select to display a list of all available enterprise applications.
- Select BPEContainer (for the business process
container) or TaskContainer (for the human task container)
from the list of SCA modules or applications.
- Choose Provide HTTP endpoint URL information from
the list of Additional properties.
- Select one of the default prefixes from the list, or enter a custom
prefix. Use a prefix from the default prefix list if your client
applications are to connect directly to the application server hosting the
Web services API. Otherwise, specify a custom prefix.
- Click Apply to copy the selected prefix
to the SCA module.
- Click OK. The URL information
is saved to your workspace.
Result
You can view the current value in the administrative console (for
example, for the business process container: ).
In the exported WSDL
file, the location attribute of the soap:address element
contains the specified Web services endpoint address. For example:
<wsdl:service name="BFMWSService">
<wsdl:port name="BFMWSPort" binding="this:BFMWSBinding">
<soap:address location=
"https://myserver:9080/WebServicesAPIs/sca/com/ibm/bpe/api/BFMWS"/>