BaseAuditModule (Security Core Classes 6.2.1 API)

java.lang.Object
- com.sun.enterprise.security.BaseAuditModule

```
public abstract class BaseAuditModule
extends Object
```
Base class that should be extended by all classes that wish to provide their own Audit support.

Version:

Author:

Harpreet Singh

Field Summary

Fields
Modifier and Type Field Description

protected Properties props

Constructor Summary

Constructors
Constructor Description

BaseAuditModule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`authentication(String user, String realm, boolean success)`	Invoked post authentication request for a user in a given realm
`void`	`init(Properties props)`	Method is invoked at server startup, during AuditModule initialization.
`void`	`serverShutdown()`	Invoked upon completion of the server shutdown
`void`	`serverStarted()`	Invoked upon completion of the server startup

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - props
```
protected Properties props
```
- Constructor Detail
  - BaseAuditModule
```
public BaseAuditModule()
```
- Method Detail
  - init
```
public void init(Properties props)
```
    Method is invoked at server startup, during AuditModule initialization. If method returns without any exception then S1AS assumes that the module is ready to serve any requests.
    
    Parameters:
    
    props - the properties for the AuditModule. These properties are defined in the domain.xml
  - authentication
```
public void authentication(String user,
                           String realm,
                           boolean success)
```
    Invoked post authentication request for a user in a given realm
    
    Parameters:
    
    user - username for whom the authentication request was made
    
    realm - the realm name under which the user is authenticated.
    
    success - the status of the authentication
  - serverStarted
```
public void serverStarted()
```
    Invoked upon completion of the server startup
  - serverShutdown
```
public void serverShutdown()
```
    Invoked upon completion of the server shutdown