D OracleAS Web Services Auditing Schema

This appendix describes the Oracle Application Server Web Services auditing configuration elements defined by the auditing schema oracle-webservices-auditing-10_0.xsd. This file can be found in the oc4j-schemas.jar file.

OC4J_HOME\j2ee\home\lib\oc4j-schemas.jar

OC4J_HOME represents the directory where you installed Oracle Containers for J2EE (OC4J).

Auditing is typically used as part of a larger Web services management configuration. To enable auditing, you have to configure it into the Web service on the server side and into the client. The configuration is part of an XML configuration file that is passed to the Web service or client when it is assembled.

• For the server, the configuration is stored in the oracle-webservices.xml deployment descriptor file. This file is based on the oracle-webservices-10_0.xsd schema.

• For a J2SE client, the configuration is stored in the <generated_name>_Stub.xml deployment descriptor file. This file is based on the oracle-webservices-client-10_0.xsd schema.

• For a J2EE client, configuration information for auditing is located in the J2EE client-side Web services proprietary deployment descriptor. Depending on the client application, this can be either orion-web.xml, orion-ejb-jar.xml, or orion-application-client.xml.

Unlike other management features, auditing can be configured only at the operation level; you cannot configure auditing at the global or port-level.

For more information about auditing and assembling auditing in to a Web service and client see Chapter 6, "Auditing and Tracing Messages".

Hierarchy of an Auditing Configuration

Auditing is designated and defined by the single element <auditing>. In the oracle-webservices.xml server-side configuration file, this element appears in the <runtime> clause for an individual operation. Each operation can have its own auditing configuration. The following conceptual fragment illustrates where the <auditing> element appears in the hierarchy of an oracle-webservices.xml file.

...
<port-component>
  ...
   <runtime>
    <operations>
      <operation>
        <runtime>
        ...
         <auditing>

For a J2EE client, the auditing configuration appears within the <operation> clause of the <service-ref-mapping> element. Like the server-side, auditing can be configured only for operations; the <auditing> element appears in the <runtime> clause for an individual operation. Each operation can have its own auditing configuration. The following fragment illustrates where the <auditing> element appears in the hierarchy of a orion-web-application.xml file

<orion-web-app>
    ...
    <service-ref-mapping>
        <port-info>
            ...
            <runtime>
                ...
                <security>
                <reliability>
                ...
            <operations>
                ...
                  <operation>
                    <runtime>
                        ...
                        <security>
                        <reliability>
                        <auditing>

Elements and Attributes for the Auditing Schema

This section is an alphabetical dictionary of elements of the auditing schema, oracle-webservices-auditing-10_0.xsd. See the preceding section, "Hierarchy of an Auditing Configuration", if you are interested in the hierarchy.

The auditing schema defines the single element, <auditing>.

<auditing>

Parent element:  root element for auditing

Child element:  None

Required? Optional

The <auditing> element designates the presence of an auditing configuration for an operation. Its attributes define whether auditing will be enabled for request messages, response messages, and fault messages.

Table D-1 <auditing> Attributes

Name	Description
fault	Value: boolean Default: false Indicates whether fault messages will be audited. Default is false.
request	Value: boolean Default: true Indicates whether request messages will be audited. Default is true.
response	Value: boolean Default: false Indicates whether response messages will be audited. Default is false.

Auditing Configuration Listing

You can find sample auditing configurations for a Web service and client in Chapter 6, "Auditing and Tracing Messages".