A Understanding the Web Services Management Schema

The Web services management policy file, wsmgmt.xml, defines the security, reliability, logging, and auditing features that can be assigned to a Web service. On deployment, the contents of the oracle-webservices.xml deployment descriptor which relate to management, are extracted from the file and copied to wsmgmt.xml.

The wsmgmt.xml file resides in the ORACLE_HOME\j2ee\home\config directory.

Note:

Oracle Application Server Web Services strongly recommends that you do not edit or change the contents of wsmgmt.xml.

Management features have scope: they can be assigned globally, to a port, and to an operation within a port.

This appendix has these sections.

Levels of Web Service Management
wsmgmt.xml Listing

Levels of Web Service Management

The schema for the wsmgmt.xml management policy file allows Web service management features to be set at these levels:

Global Level
Port Level
Operation Level

The tags and elements described in the following sections are used in the Web service management schema. For a listing of wsmgmt.xml, the XML version of the schema, see Example A-3, "Sample wsmgmt.xml File".

Global Level

The management features that are globally applied to a Web service appear between <runtime> elements at the top of wsmgmt.xml. If a feature is enabled, it will be applied at runtime. Only security features can be applied globally to a Web service. The security features are delimited by <security> elements.

The XML fragment in Example A-1 illustrates the global elements of the wsmgmt.xml file, simplified for clarity. The ellipses indicate additional security elements. For a description of the elements that appear in the <security> element, see the Oracle Application Server Web Services Security Guide.

Example A-1 Global Elements of the wsmgmt.xml File

<wsmgmt>
   <runtime>
       <security>
         ...
       </security>
    </runtime>
</wsmgmt>

Port Level

The management features that can be configured for a port are delimited by <port> elements. Each Web service can have a number of ports defined in Web service management schema. A port is synonymous with a Java interface. For each port, security, reliability, and logging features can be set.

The security features that appear in the global level are repeated in the port level. Security features set at the port level override security features set at the global level.

The XML fragment in Example A-2 illustrates the port elements of the wsmgmt.xml file, simplified for clarity. The ellipses indicate additional elements. For a description of the elements that appear in the <security> element, see the Oracle Application Server Web Services Security Guide. For a description of the elements that appear in the <reliability> element, see "Server-Side Reliability Configuration Elements". For a description of the elements that appear in the <logging> element, see "Server-Side Logging Configuration Elements".

Example A-2 Port Level Elements in the wsmgmt.xml File

<wsmgmt>
   ...
   <port app="my-ear" web="my-war" service="my-service" port="my-service-port"> 
        <runtime enabled="security">
                <security>
                   ...
                </security>
                <reliability>
                  ...
                </reliability>
                <logging>
                   ...
                </logging>
        </runtime>
   </port>
  ...
<wsmgmt>

Table A-1 describes the settings for a port.

Table A-1 Attributes for the Port Element

Attribute Name	Description
port	Maps to the port name in `oracle-webservices.xml` and to the WSDL.
web (or ejb for Web services that expose EJBs)	Maps to the WAR name which is obtained either from `server.xml` or the Web-side XML file.
service	Maps to the Web service name in `oracle-webservices.xml` and the WSDL.
app	Maps to the application name in `server.xml`.

The port component also has a <runtime> section where the port-level security, reliability, and logging features can be enabled or disabled. If a feature is enabled, it will be applied at runtime. This is done by including the name of the configuration element in the enabled attribute of the <port> element. The configuration of each feature (such as security or logging) can still be present even if it is disabled by virtue of not being present in the enabled attribute. The values of the enabled attribute are delimited by commas. The order of the features on the enabled attribute is currently ignored.

Operation Level

Each port can have multiple operations associated with it. In the <port> element, the <operations> element indicates the start of the list of operations belonging to a particular port. The <operation> element indicates the start of an individual operation.

Table A-2 describes the element for an operation.

Table A-2 General Setting for Operation

Element Name	Description
<operation>	The `name` attribute maps to an operation name in the WSDL.

For each operation, the wsmgmt.xml management policy file defines security, reliability, logging, and auditing features available.

The security, reliability, and logging features that are listed in the port level are repeated at the operation level. A security feature set at the operation level overrides the setting made at the port and global level. A reliability or logging feature set at the operation level, in contrast will be referenced by the corresponding feature set at the port level.

wsmgmt.xml Listing

Example A-3 contains a skeleton listing of the server-side Web services management file wsmgmt.xml. See the cross references for the listings and description of the elements in the security, reliability, and logging components.

Example A-3 Sample wsmgmt.xml File

<?xml version="1.0" encoding="UTF-8"?>
<wsmgmt xmlns:oc4j="http://xmlns.oracle.com/oracleas/schema/oc4j-10_0.xsd"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="D:\ade\las\j2ee\src\META-INF\META-INF\
     oracle-webservices-management-10_0.xsd" 
schema-major-version="10" schema-minor-version="0">
   <runtime>
      <security>
          ...

For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide.

          ...
      </security>
   </runtime>
   <port app="String" web="String" service="String" port="String">
      <runtime enabled="String">
         <security>
            ...

For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide.

            ...
          </security>
         <reliability>
             ...

For a description and listing of reliability elements, see "Port-Level Reliability Elements on the Server".

              ...
              ...
          </reliability>
         <logging>
             ...

For a description and listing of logging elements, see "Port-Level Logging Elements on the Server".

            ...
          </logging>
      </runtime>
      <operations>
         <operation name="String">
            <runtime>
               <security>
                ...

For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide.

               ...
               </security>
               <auditing request="false" response="false" fault="false"/>

For a listing and description of operation-level auditing elements, see "Server-Side Auditing Configuration Elements".

               <reliability>
                  ...

For a listing and description of operation-level reliability elements, see "Operation Level Reliability Elements on the Server".

                  ...
               </reliability>
               <logging>
                    ...

For a listing and description of operation-level logging elements, see "Operation Level Logging Elements on the Server".

                   ...
                 </logging>
            </runtime>
         </operation>
      </operations>
   </port>
</wsmgmt>