| Oracle® Web Services Manager Deployment Guide 10g (10.1.3.3.0) Part Number E10298-01 |
|
|
View PDF |
| Oracle® Web Services Manager Deployment Guide 10g (10.1.3.3.0) Part Number E10298-01 |
|
|
View PDF |
This chapter provides an overview of an Oracle Web Services Manager (Oracle WSM) deployment. You must understand the concepts in this chapter before deploying the individual components. This chapter includes the following sections:
If you install Oracle WSM using the default path, the installer creates the following directories:
ORACLE_HOME/owsm/config/ – This directory contains the source configuration files for your Oracle WSM installation. Any changes you make to the configuration files in this directory take effect when you redeploy the application.
ORACLE_HOME/j2ee/instance/applications – The variable, instance, is the name of the OC4J instance into which Oracle WSM is installed. This directory contains the runtime files for your installation. Within this directory, there is a subdirectory for each Oracle WSM application. Any changes you make to the configuration files only affect the local runtime application.
Oracle recommends that you edit the source configuration files in the ORACLE_HOME/owsm/config/ directory and deploy a component or application using these files. Your changes are saved and propagated to the runtime directory when you deploy the application. The reverse does not hold true. Any changes you make to configuration files in the runtime directory are not propagated back to the configuration files in the source directory.
The following section describes the recommended process for deploying applications and components.
After planning the topology of your Oracle WSM system, you must deploy the applications and components using the wsmadmin command-line tool. In most situations, you can deploy the applications and components using a single command, wsmadmin deploy.This command builds, deploys, and binds all Oracle WSM components or specified components to an OC4J application engine.
There may be situations where you need to separate the building and deploying of your applications or components. In this situation, use the wsmadmin buildApps command, followed by the wsmadmin deployApps command. See Appendix C, "Oracle Web Services Manager WSMADMIN Commands" for more information about the wsmadmin commands.
Oracle WSM is localized in nine languages, in addition to the default language, English. These languages are automatically installed during the product installation. During the installation, the Oracle Universal Installer detects your locale. If your locale is one of the supported locales, the installer installs Oracle WSM in that locale. If the locale is not supported, then the Oracle Universal Installer installs Oracle WSM in English, the default locale.
The online help for the components (such as Oracle WSM Policy Manager, Oracle WSM Monitor, and the Web Services Manager Control) is also available in the nine supported locales.
Oracle WSM generates a log file for each running application. You can find these log files in the runtime directory under ORACLE_HOME /j2ee/instance/log. The instance variable is the name of the OC4J instance into which Oracle WSM is installed. If you have instances of the same application running concurrently, Oracle recommends that you create a separate log file for each instance.
Each application falls under a different category, and each category has different log levels.
The configuration parameters for the log files are loaded at runtime; therefore, it is better to adjust logging at the runtime level. By doing so, you can troubleshoot the specific application generating the error.
See Oracle Web Services Manager Administrator's Guide for more information about setting logging levels.
In a production environment, you may want to deploy Oracle WSM behind a proxy server. The proxy server provides indirect access to services on another machine, in this case to applications in your Oracle WSM system. The proxy server may cache previous requests to the Oracle WSM applications, allowing the applications to respond more quickly. For application requests that have not been cached or have expired, the proxy retrieves the information and forwards it to the requesting machine. Setting up Oracle WSM behind a proxy server has the following advantages:
Performance is improved.
A centralized request queue that adds another layer of security for Oracle WSM can be created.
Access to specific URLs can be restricted.
Oracle WSM can be installed as a standalone installation or as part of Oracle Application Server 10g Release 3 (10.1.3.1.), referred to as the Oracle SOA Suite. See Oracle Web Services Manager Installation Guide for more information about the standalone installation, and see Oracle Application Server Installation Guide for Microsoft Windows and Oracle Application Server Installation Guide for Linux x86 for more information about the Oracle SOA Suite installations. The following procedures describe how to configure proxy settings for each type of installation.
To configure a standalone Oracle WSM installation behind a proxy server
Open the following file:
ORACLE_HOME/owsm/bin/coresv.properties
Edit the following parameters:
proxy.host = proxy_server
proxy.port = listen_port
noproxy.hosts = localhost *domain.com
Table 2-1 Parameter Settings for Standalone Oracle WSM
| Parameter | Description |
|---|---|
|
proxy_server |
Name of the proxy server, for example, www-proxy.us.oracle.com. |
|
|
The port number on the proxy server where you wish to connect. For example, 80. |
|
localhost *domain.com |
Hosts that connect directly without intervention from the proxy server. This value can be a list of host names separated by a vertical bar ( |
To configure Oracle WSM behind a proxy server when it is installed as part of Oracle SOA Suite
Open the following file:
ORACLE_HOME/opmn/conf/opmn.xml
Find the process-type id whose value is the name of the instance in which Oracle Web Services Manager is installed. This may be "home", or it could be another instance name. For example:
... <ias-component id="default_group"> <process-type id="home" module-id="OC4J" status="enabled"> ...
Find the data id="java-options" in the category id="start-parameters" section of the file.
... <category id="start-parameters"> <data id="java-options" value="-server -XX:MaxPermSize=128M .../> </category> ...
Add the following parameters under java-options:
Dhttp.proxySet = true
Dhttp.proxyHost = proxy_server
Dhttp.proxyPort = listen_port
Dhttp.nonproxyHost = *localhost|*domain.com
Table 2-2 Parameter Settings for Oracle WSM Installed as Part of Oracle SOA Suite
| Parameter | Description |
|---|---|
|
|
Set the value to true to enable the proxy server. |
|
|
Name of the proxy server, for example, |
|
|
The port number on the proxy server to which you wish to connect. For example, 80. |
|
|
Hosts that connect directly without intervention from the proxy server. This value can be a list of host names separated by a vertical bar ( |
Restart the Oracle WSM Server for the configuration changes to take effect.
The following is an example of Oracle WSM in a clustered environment. There are three instances of Oracle WSM, each installed on a different virtual host. The fourth virtual host acts as the load balancer. See Figure 2-1.
Figure 2-1 Example of Oracle Web Services Manager in a Clustered Environment
Instance 1 and Instance 2 are the active-active instances with the following components:
Oracle WSM Policy Manager
Oracle WSM Gateway
Instance 1 and Instance 2 are installed on vhost1 and vhost2.
Instance 3 includes the following components:
Oracle WSM Monitor
Web Services Manager Control
Instance 3 is installed on vhost3.
The fourth virtual host is a load balancer (lbrhost).
Oracle WSM components communicate with each other through a single endpoint URL. Therefore, if there are multiple instances of an Oracle WSM component—for example, multiple instances of the Oracle WSM Policy Manager—you must use a load balancer between the Oracle WSM components and the Web service client. In Figure 2-1, the load balancer provides the single endpoint URL to which client requests get made.
Configuration for all Oracle WSM components is static. Therefore, a computer cannot dynamically determine the host name or port of any computer, including the computer it resides on or the computer of any component with which it communicates. Machine addresses must be configured to reference virtual endpoints that always exist, and this requires the use of a load balancer between components.
The following sections describe the steps involved in setting up this example.
Follow the instructions in the Oracle Web Services Manager Installation Guide for installing all three instances of Oracle WSM.
Install all Oracle WSM components on instance 1, and specify lbrhost as the host.
Install all Oracle WSM components on instance 2, and specify lbrhost as the host.
Install all Oracle WSM components on instance 3, and specify vhost3 as the host.
The Oracle WSM components are bundled together by default. Therefore, all components get installed. After you have completed the installation, you remove the components you do not need.
In the following procedure, you set up the Web Services Manager Control (on vhost3) to communicate with the Oracle WSM Policy Manager (on vhost1 and vhost2) by going through the load balancer (lbrhost).
On vhost3, edit the ORACLE_HOME/owsm/config/ccore/ui-config-installer.properties file.
Set the following properties:
| Property Name | Value |
|---|---|
ui.pm.server.httpScheme |
http or https |
ui.pm.server.httpHost |
Oracle WSM Policy Manager host name. In this example, this is the load balancer, lbrhost. |
ui.pm.server.httpPort |
Oracle WSM Policy Manager HTTPS port. In this example, this is the lbrhost port. |
Deploy the application using the wsmadmin deploy control command.
See "deploy" in Appendix C, "Oracle Web Services Manager WSMADMIN Commands" for more information on this command.
Note:
Always perform this procedure first, before disabling the Oracle WSM components, to avoid errors in the log file.When you install Oracle WSM, by default, all components are installed. You need to remove the Oracle WSM Policy Manager and Oracle Web Services Manager Gateway components from vhost3. Before you proceed with the following steps, verify that you have set up the Web Services Manager Control first.
On vhost3, disable the Oracle WSM Policy Manager component using the wsmadmin undeploy policymanager command.
On vhost3, disable the Oracle Web Services Manager Gateway component using the wsmadmin undeploy gateway command.
See "undeploy" in Appendix C, "Oracle Web Services Manager WSMADMIN Commands" for more information on this command.
To set up the Oracle WSM Gateway, you need to register the gateway from the Web Services Manager Control. By registering the gateway, you are creating a logical component with policies. Web services are secured by creating a virtual endpoint through which all requests must be routed. Complete the following tasks to set up the gateway:
Connect the gateway to the Oracle WSM Monitor on vhost3.
Configure the gateway with its component ID.
Redeploy the gateway.
The procedures that follow describe how to complete these tasks.
To set up the Oracle WSM Gateway
Note:
Perform steps 1 through 3 only once for each logical gateway.Log in to Web Services Manager Control on vhost3.
Register the Oracle WSM Gateway.
In the navigation pane, click Policy Management, then click Manage Policies.
Click Add New Component.
From the Component Type list, select Gateway.
In the Component URL box, enter the URL for the load balancer (lbrhost).
Click Register.
Remember to make a note of the component ID. This ID will be used in step 4.
See "Prerequisites and General Information about Registering Oracle WSM Gateways" for more information about registering gateways.
Connect the Oracle WSM Gateway with the Oracle WSM Monitor on vhost3.
In the navigation pane of Web Services Manager Control, click Policy Management, then click Manage Policies.
Locate the gateway in the List of Components, and click the Edit icon for that gateway.
Set the following properties for the Oracle WSM Monitor, then click Save.
| Property Name | Value |
|---|---|
cfluent.monitor.rmi.host |
Host on which the Oracle WSM Monitor resides. In this example, this is vhost3. |
cfluent.monitor.rmi.port |
Oracle WSM Monitor RMI port. |
Note:
Perform steps 4 and 5 once for each physical gateway.Configure the Oracle WSM Gateway with its component ID.
Open the following file on vhost1:
ORACLE_HOME/owsm/config/gateway/gateway-config-installer.properties
In the following line, replace the component ID with the one you noted in step 2.
gateway.component.id=C0003001
Redeploy the Oracle WSM Gateway on vhost1 using the wsmadmin deploy gateway command.
See "deploy" in Appendix C, "Oracle Web Services Manager WSMADMIN Commands" for more information on this command.
Each Oracle Web Services Manager installation has all components running (that is, Oracle WSM Policy Manager, Oracle WSM Monitor, Oracle WSM Gateway, and Web Services Manager Control). However, you can only have one instance of Oracle WSM Monitor in your entire Oracle Web Services environment. Therefore, you must disable the Oracle WSM Monitor on vhost1 and vhost2.
On vhost1, disable Oracle WSM Monitor by executing the wsmadmin undeploy monitor command.
On vhost1, disable Web Services Manager Control by executing the wsmadmin undeploy control command.
See "undeploy" in Appendix C, "Oracle Web Services Manager WSMADMIN Commands" for more information on this command.
Requests for the Web service come through the load balancer. The load balancer then directs the request to vhost1 or vhost2. Check to see if you can access the WSDL by going through the load balancer (lbrhost).
Register the Web service to the Oracle WSM Gateway.
In the navigation pane, click Policy Management, then click Register Services.
Click Add New Service.
Register the WSDL for the service you want to protect.
Click Finish, then click OK.
See Oracle Web Services Manager Administrator's Guide for more information on registering a Web service to the gateway.
Get the URL for the WSDL.
From the navigation pane of the Web Services Manager Control, click Policy Management, then click Register Services.
Click the Services link for the gateway.
Click View Details icon for the Web service.
Copy the URL in the Service WSDL URL field.
Test whether you can access the Web service using the protected URL.
In the navigation pane of Web Services Manager Control, click Tools, then click Test Page.
Paste the URL you copied into the Enter wsdl url box, and click Submit Query. The page refreshes and displays other parameters you can set.
Click Invoke. You should get a Test Result page.
See Oracle Web Services Manager Administrator's Guide for more information on using the Test Page.
Once you have read and understood the concepts in this chapter, you can configure and deploy the individual Oracle WSM components. For information about configuring the Oracle WSM components, refer to Chapter 3, "Configuring the Oracle Web Services Manager Components".
