6 Administering Web Services

Oracle Enterprise Manager Fusion Middleware Control is the primary interface that you can use to manage Oracle Fusion Middleware Web Services. You can also use WebLogic Scripting Tool (WLST) commands to perform some configuration tasks for SOA, ADF, and WebCenter services. This chapter describes how to navigate to the pages in Fusion Middleware Control where you perform many of the tasks to manage your Web services, and it describes how to perform basic administration tasks. When applicable, it describes how to perform the task using WLST also. This chapter includes the following sections:

You can view tabs for Java EE Web services, non-SOA Oracle Web services such as those for ADF and WebCenter, and SOA Web services.

The tabs that are displayed depend on the Web services deployed on that server.

From this page you can click Attach Policies to attach one or more policies to one or more Web services. Note that attaching policies from this page (bulk attachment) does not perform validation on the policies that you attach.

Use the listWebServices() WLST command to display a list of the Web services. If you don't specify a Web service application or a SOA composite, the command lists all services in all applications and composites for every server instance in the domain.

Set the detail argument of the listWebServices command to true to view the endpoint configuration, the effective set of policies attached to each endpoint, the secure status of the endpoint, and if the endpoint has a valid configuration.

An endpoint is considered secure if the policies attached to it (either directly or externally) enforce authentication, authorization, or message protection behaviors.

Note:

The listWebServices command output does not include details on SOA components, including policy attachments.

Use the listWebServices WLST command to display a list of the Web services in your application. You must specify the complete application path name to identify the application and the server instance to which it is deployed.

The Component Metrics section of this tab lists the SOA components being used in the composite application, and the Services and References section displays the Web service and reference bindings, as shown in Figure 6-4.

As an alternative method of viewing the details for a Web service endpoint, you can instead navigate to the server-wide Web Services Summary page, as described in "Viewing All Current Web Services for a Server", which lists all of the Web services, and click the name of the endpoint to navigate to the specific Web Service Endpoint page.

To view the Web service endpoint configuration for a SOA composite application:

In the Services and References section of the page, click the name of the service or reference to display the Service Home or Reference Home page, as appropriate.

From the Service Home or Reference Home page, you can do the following:

Click the Dashboard tab, if it is not already selected, to see a graphic representation of the total incoming messages and faults since server startup, and recently rejected messages, including the message name, time of the fault, and the type of fault (business or system).

Click the Policies tab to view or change the policies attached to this endpoint.

Click the Faults and Rejected Messages tab to see a list of faults and rejected messages, including details such as the error message, time of the fault, and the associated composite instance ID.

Click the Properties tab to view and modify the configuration for this endpoint.

In the Services and References portion of the page, select the SOA reference to view.

In the Reference Home page, click the tabs to view the client data.

Viewing Connection-Based Web Service Clients

Use the following procedure to view a connection-based Web service client such as an ADF DC Web service client, ADF JAX-WS Indirection Proxy, or WebCenter client.

From the navigator pane, click the plus sign (+) for the Application Deployments folder to expose the applications in the farm, and select the application.

The Application Deployment home page is displayed.

From the Application Deployment menu, select ADF, and then Configure ADF Connections.

On the ADF Connections Configuration page, select a connection from the Web Service Connections section of the page, and then select the endpoint from the Configure Web Service list.

In the Configure Web Service page, click the tabs to view the client data.

Viewing WebCenter Portlets

Use the following procedure to view a WebCenter portlet.

From the navigator pane, click the plus sign (+) for the WebCenter folder and WebCenter Spaces folder to display the WebCenter spaces.

Click the name of the WebCenter space to view.

From the WebCenter menu, select Settings and Service Configuration.

The Webcenter Service Configuration page is displayed.

Select Portlet Producers to view the WebCenter portlets.

Viewing Asynchronous Web Service Callback Clients

Use the following procedure to view an asynchronous Web service Callback client. Callback clients are used only by asynchronous Web services to return the response to the caller. For more information, see "Developing Asynchronous Web Services" in Oracle Fusion Middleware Concepts Guide for Oracle Infrastructure Web Services.

Use the listWebServiceClients WLST command to display a list of the Web service clients.

listWebServiceClients(application,composite,[detail])

This command enables you to list the clients for an application, a SOA composite, or a domain. To list the client information for an application or SOA composite, specify the appropriate argument. If you do not specify an application or SOA composite, the command outputs information, including the module name, module type, and SOA reference name for all the Web service clients in all applications and composites in every server instance in the domain. To view details about each client, including the endpoint and policies, set the detail argument to true.

Note that the output displays SOA references (using the serviceRefName argument) for the SOA composites default/SampleSOAFirstPrj[1.0]. To list the SOA references for a SOA composite, specify the composite name in the command, for example listWebServiceClients(None,'default/SampleSOAFirstPrj[1.0]').

ADF and WebCenter clients are specified by the moduleType=wsconn argument in the output.

Configuring the Web Service Endpoint

Follow the procedures below to configure the Web service endpoint (or port).

Note:

The procedures described in this section apply to Oracle Infrastructure Web services and providers only.

Oracle Infrastructure Web service providers implement the java.xml.ws.Provider interface. On the Web Service Endpoint page, they display the Implementation Class and provide a subset of configuration properties.

Using Fusion Middleware Control

Use the following procedure to configure the Web service endpoint using Fusion Middleware Control:

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

Use the following procedure to configure the Web service endpoint (port) using WLST:

If any configuration item contains an unrecognized property name or an invalid value, this set command is rejected and an error message is displayed.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Enabling or Disabling a Web Service

When a Web service application is deployed, the Web service endpoint is enabled by default if no errors are encountered. If there are errors, the Web service application is deployed, but the Web service endpoint is not enabled.

You may need to temporarily make a Web service unavailable by disabling the Web service. For example, you may need to correct an invalid policy reference. When you disable a Web service, requests to the Web service will fail. To disable a Web service, you must make the endpoint on which the Web service receives requests unavailable.

Note:

The procedures described in this section apply to Oracle Infrastructure Web services only.

Using Fusion Middleware Control

To disable an ADF or WebCenter Web service endpoint:

Navigate to the Web Services Summary page.

In the Web Service Details section of the page, click on the plus (+) for the Web service to display the Web service endpoints if they are not already displayed.

Click the name of the endpoint to navigate to the Web Service Endpoint page.

From the Web Service Endpoint page, click the Configuration tab.

In the Endpoint Enabled field, select Disabled from the menu, and click Apply.

Restart the application that uses the Web service.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

To disable a Web service endpoint (port) using WLST, use the setWebServiceConfiguration command. Set the enable property of the itemProperties argument to false to disable the endpoint and to true to enable it.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

To enable or disable a Web services endpoint (port) to accept messages in REST format using WLST, use the setWebServiceConfiguration command. Set the enableREST property of the itemProperties argument to true to enable REST and to false to disable it.

From the WSDL Enabled field, select True from the menu to enable the display of the WSDL or False to disable the display of the WSDL, and click Apply.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

To enable or disable the display of a WSDL document for a Web service endpoint (port), use the setWebServiceConfiguration command. Set the enableWSDL property of the itemProperties argument to true to enable display the WSDL and to false to disable it.

In the Metadata Exchange Enabled field, select True from the menu to enable the exchange of metadata or False to disable the exchange of metadata, and click Apply.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Enabling or Disabling the Web Service Test Endpoint

The following procedures describes how to enable or disable the Web service test endpoint using Fusion Middleware Control and WLST.

Note:

The procedures described in this section apply to Oracle Infrastructure Web services and providers only.

Using Fusion Middleware Control

To enable or disable the Web service test endpoint:

Note:

This flag does not control the availability of the Web Services Test link.

In the Endpoint Test Enabled field, select True from the menu to enable the test endpoint or False to disable the test endpoint, and click Apply.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

To enable or disable the Web service test endpoint, use the setWebServiceConfiguration command. Set the enableTestPage property of the itemProperties argument to true to enable the test endpoint and to false to disable it.

In the Schema validation field, select True from the menu to enable schema validation or False to disable schema validation, and click Apply.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Configuring Web Services Atomic Transactions

WebLogic Web services support the WS-Coordination and WS-AtomicTransaction (WS-AT) specifications. Therefore, you can configure Web services atomic transactions to enable interoperability between Oracle WebLogic Server and other vendor's transaction processing systems, such as WebSphere, JBoss, Microsoft .NET, and so on.

Web services atomic transactions are supported for WebLogic JAX-WS Web services and SOA Web services and references. You can enable and configure Web services atomic transactions at design time as described in the following topics:

For WebLogic JAX-WS Web services, you can configure Web services atomic transactions at deployment time using the WebLogic Server Administration Console. For more information, see "Configure Web service atomic transactions" in the Oracle WebLogic Server Administration Console Help.

For SOA Web services and references, you can configure Web services atomic transactions at deployment time, on the service or reference endpoint, using Oracle Enterprise Manager Fusion Middleware Control or WLST. Refer to the following sections for detailed procedures using both interfaces.

Using Fusion Middleware Control

In the Services and References section of the page, select the service to be configured.

In the Service Home page, click the Properties tab.

In the Atomic Transaction Version field, select the version of the Web service atomic transaction coordination context that is supported for the SOA service. The value specified must be consistent across the entire transaction. Valid values are:

WSAT10

WSAT11

WSAT12

Default

If you select Default, all three versions are accepted.

Note:

This property works with SOA Web services that have synchronous-only operations and with Web services that have both synchronous and asynchronous operations. It does not work with SOA Web services with asynchronous-only operations.

In the Atomic Transaction Flow Option field, select whether the transaction coordination context is to be passed with the transaction flow into the SOA Web service.

Valid values on the SOA Web service are:

Never – Do not export transaction coordination context. This is the default.

Mandatory – Export transaction coordination context. An exception is thrown if there is no active transaction.

Note:

This property works with Web services that have synchronous-only operations or that have combined synchronous and asynchronous operations. It does not work with Web services with asynchronous-only operations.

-1 sets no limit to the size of the message. Or, you can set a maximum limit to the message by entering a number in the text box and selecting the unit of measurement.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Using WLST

To set the size of a request message for a Web service endpoint (port), use the setWebServiceConfiguration command. Set the maxRequestSize property of the itemProperties argument to the desired value. Enter a long integer to set the maximum value, or -1 to set no limit to the size of the message. The default is -1.

Configuring Asynchronous Web Services

When you invoke a Web service synchronously, the invoking client application waits for the response to return before it can continue with its work. In cases where the response returns immediately, this method of invoking the Web service might be adequate. However, because request processing can be delayed, it is often useful for the client application to continue its work and handle the response later on. By calling a Web service asynchronously, the client can continue its processing, without interrupt, and will be notified when the asynchronous response is returned.

For ADF and WebCenter applications, restart the Web service application. You do not need to restart a SOA composite.

Note:

You need to wait approximately 30 seconds (or the equivalent of the configured Graceful Shutdown Timeout time) between stopping and restarting the application. During this time, the server is allowing all global transactions to complete before shutting down the application. If you do not wait the configured Graceful Shutdown Timeout time, then the application will not be restarted appropriately and you will not be able to access it. To avoid waiting the graceful shutdown timeout period, you can restart the application twice.

Configuring the Web Service Client

Note:

The procedures described in this section apply to Oracle Infrastructure Web services only.

For the Web service clients in your application, including SOA references, ADF data control, and asynchronous Web service Callback clients, you can set the configuration properties defined in Table 6-3.

Table 6-3 Configuration Properties for Web Service Clients

Configuration Property

Property Name

Description

General

UDDI ServiceKey

(SOA reference clients only)

oracle.soa.uddi.serviceKey

Specifies the service key of the Oracle Service Registry (OSR) if UDDI is used for run-time resolution of the endpoint.

Configuring Asynchronous Web Service Callback Clients

The following procedure describes how to configure an asynchronous Web service Callback client. Callback clients are used only by asynchronous Web services to return the response to the caller. For more information, see "Developing Asynchronous Web Services" in Oracle Fusion Middleware Concepts Guide for Oracle Infrastructure Web Services.

Use the setWebServiceClientStubProperty command to set or change a single stub property of a Web service client endpoint. Specify the property to be set or changed using the propName and propValue arguments. To remove a property, specify a blank value for the propValue argument.

This command configures or resets all of the stub properties for the Oracle WSM client security policy attached to the client. Each property that you list in the command is set to the value you specify. If a property that was previously set is not explicitly specified in this command, it is reset to the default for the property. If no default exists, the property is removed.

For example, to configure atomic transactions for the TaskReference_pt SOA reference endpoint of the default/SimpleRef[1.0] SOA composite application, use the following command: