Sun Java System Application Server Platform Edition 8.1 2005Q2 Update 2 Administration Guide

- Previous: Admin Console Tasks for JACC Providers
- Next: Admin Console Tasks for Listeners and JMX Connectors

# Admin Console Tasks for Audit Modules

- To create an audit module

- To edit an audit module

- To delete an audit module

- To set the active audit module

- To enable or disable audit logging

## To create an audit module

The Application Server provides a simple default audit module; for more information, see To use the default audit module.

1. In the Admin Console tree component, expand the Configuration node.

2. Expand the Security node.

3. Select the Audit Modules node.

4. On the Audit Modules page, click New.

5. On the Create Audit Module page, enter the following information:

   - Name – The name used to identify this audit module.

   - Classname – The fully-qualified name of the class that implements this module. The class name for the default audit module is `com.sun.enterprise.security.Audit`.

6. To add JVM properties to this module, click Add Property. Specify a name and value for each property. Valid properties include:

   - `auditOn` - Specifies whether or not to enable this implementation class. Valid values are `true` and `false`.

7. Click OK to save entries, or click Cancel to quit without saving.

##### See Also

- Auditing Authentication and Authorization Decisions

- To edit an audit module

- To delete an audit module

- To set the active audit module

- To enable or disable audit logging

## To edit an audit module

Audit modules are not turned on by default. For more information on how to activate audit modules, read To enable or disable audit logging.

1. In the Admin Console tree component, expand the Configuration node.

2. Expand the Security node.

3. Expand the Audit Modules node.

4. Click the node of the audit module to be edited.

5. On the Edit Audit Module page, modify the class name, if needed.

6. Enter any additional properties for the module by selecting the Add button and entering the name and value of the property. Valid properties include:

   - `auditOn -` Specifies whether or not to use this audit module. Valid values are `true` and `false`.

7. Modify any existing properties by selecting the name or value to be modified, and entering the changes directly into the text field.

8. Delete a property by selecting the checkbox to the left of the property and clicking Delete Properties.

9. Click Save to save or click the Back button on the browser to cancel without saving.

##### See Also

- Auditing Authentication and Authorization Decisions

- To create an audit module

- To delete an audit module

- To set the active audit module

- To enable or disable audit logging

## To delete an audit module

1. In the Admin Console tree component, expand the Configuration node.

2. Expand the Security node.

3. Select the Audit Modules node.

4. Click in the checkbox to the left of the audit module to be deleted.

5. Click Delete.

##### See Also

- To create an audit module

- To edit an audit module

- To delete an audit module

- To enable or disable audit logging

## To enable or disable audit logging

1. In the Admin Console tree component, expand the Configuration node.

2. Select the Security node.

   The Security page displays.

3. To enable logging, select the Audit Logging check box. To disable it, deselect it.

   Selecting this option causes the loading of the audit modules and ensures they are called by the Application Server’s audit library at audit points.

4. If you are enabling audit logging, specify a default audit module as described in To set the active audit module.

5. Select Save to save the changes.

6. Restart the Application Server if Restart Required displays in the console.

##### See Also

- To create an audit module

- To edit an audit module

- To set the active audit module

- To enable or disable audit logging

## To set the active audit module

##### Before You Begin

To specify the audit module that the server uses, first enable audit logging as described in To enable or disable audit logging.

1. In the Audit Modules field, enter the name of the audit module to be used by the server.

   The preconfigured audit module is called `default`. Make sure that this audit module has `auditOn` set to true as described in To use the default audit module.

2. Select Save to save the changes, Load Defaults to cancel.

3. Restart the Application Server if Restart Required displays in the console.

## To use the default audit module

The `default` audit module logs authentication and authorization requests to the server log file. For information on changing the location of the log file, see To configure general logging settings.

Authentication log entries include the following information:

- Names of users who attempted to authenticate.

- The realm that processed the access request.

- The requested Web module URI or EJB component.

- Success or failure of the request.

Regardless of whether audit logging is enabled, the Application Server logs all denied authentication events.

Authorization log entries include the following information:

- Names of authenticated users, if any.

- The requested Web URI or EJB component.

- Success or failure of the requests.

1. In the Admin Console tree component, expand the Configuration node.

2. Expand the Security node.

3. Expand the Audit Modules node.

4. Click the `default` node.

5. Set the value of the `auditOn` property to `true`.

6. Select Save to save the changes.

7. Restart the Application Server if Restart Required displays in the console.

##### See Also

- To create an audit module

- To edit an audit module

- To set the active audit module

- To delete an audit module

- Previous: Admin Console Tasks for JACC Providers
- Next: Admin Console Tasks for Listeners and JMX Connectors

- © 2010, Oracle Corporation and/or its affiliates