AuditActivity (Jetspeed-2 Core API 2.3.1 API)

```
public interface AuditActivity
```
Gathers information about security auditing activity

Version:

$Id: $

Author:

David Sean Taylor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTHENTICATION_FAILURE`
`static String`	`AUTHENTICATION_SUCCESS`
`static String`	`CAT_ADMIN_ATTRIBUTE_MAINTENANCE`
`static String`	`CAT_ADMIN_AUTHORIZATION_MAINTENANCE`
`static String`	`CAT_ADMIN_CREDENTIAL_MAINTENANCE`
`static String`	`CAT_ADMIN_REGISTRY_MAINTENANCE`
`static String`	`CAT_ADMIN_USER_MAINTENANCE`
`static String`	`CAT_USER_ATTRIBUTE`
`static String`	`CAT_USER_AUTHENTICATION`
`static String`	`PASSWORD_ACTIVATE`
`static String`	`PASSWORD_CHANGE_FAILURE`
`static String`	`PASSWORD_CHANGE_SUCCESS`
`static String`	`PASSWORD_DISABLED`
`static String`	`PASSWORD_ENABLED`
`static String`	`PASSWORD_EXPIRE`
`static String`	`PASSWORD_EXTEND`
`static String`	`PASSWORD_RESET`
`static String`	`PASSWORD_UNLIMITED`
`static String`	`PASSWORD_UPDATE_REQUIRED`
`static String`	`REGISTRY_DELETE`
`static String`	`REGISTRY_DEPLOY`
`static String`	`REGISTRY_START`
`static String`	`REGISTRY_STOP`
`static String`	`REGISTRY_UNDEPLOY`
`static String`	`USER_ADD_ATTRIBUTE`
`static String`	`USER_ADD_GROUP`
`static String`	`USER_ADD_PROFILE`
`static String`	`USER_ADD_ROLE`
`static String`	`USER_CREATE`
`static String`	`USER_DELETE`
`static String`	`USER_DELETE_ATTRIBUTE`
`static String`	`USER_DELETE_GROUP`
`static String`	`USER_DELETE_PROFILE`
`static String`	`USER_DELETE_ROLE`
`static String`	`USER_DISABLE`
`static String`	`USER_EXTEND`
`static String`	`USER_EXTEND_UNLIMITED`
`static String`	`USER_UPDATE`
`static String`	`USER_UPDATE_ATTRIBUTE`

Method Summary

Methods
Modifier and Type	Method and Description
`DataSource`	`getDataSource()` Deprecated.
`boolean`	`getEnabled()` Get the enabled state of the auditing service.
`void`	`logAdminAttributeActivity(String username, String ipaddress, String targetUser, String activity, String name, String beforeValue, String afterValue, String description)` Log auditable activity by an administrator on user attributes on behalf of a user
`void`	`logAdminAuthorizationActivity(String username, String ipaddress, String targetUser, String activity, String name, String description)` Log auditable activity by an administrator on authorization configuration on behalf of a user
`void`	`logAdminCredentialActivity(String username, String ipaddress, String targetUser, String activity, String description)` Log auditable activity by an administrator on credentials on behalf of a user
`void`	`logAdminRegistryActivity(String adminUser, String ipaddress, String activity, String description)` Log auditable activity by an administrator on registry maintenance
`void`	`logAdminUserActivity(String adminUser, String ipaddress, String targetUser, String activity, String description)` Log auditable activity by an administrator on behalf of another user
`void`	`logUserActivity(String username, String ipaddress, String activity, String description)` Log user activity that requires audit trails
`void`	`logUserAttributeActivity(String username, String ipaddress, String activity, String name, String beforeValue, String afterValue, String description)` Log auditable activity by an administrator on user attributes
`void`	`setEnabled(boolean enabled)` Enable or disable the auditing service at runtime.

- Field Detail
  - AUTHENTICATION_SUCCESS
```
static final String AUTHENTICATION_SUCCESS
```
    See Also:
    Constant Field Values
  - AUTHENTICATION_FAILURE
```
static final String AUTHENTICATION_FAILURE
```
    See Also:
    Constant Field Values
  - PASSWORD_CHANGE_SUCCESS
```
static final String PASSWORD_CHANGE_SUCCESS
```
    See Also:
    Constant Field Values
  - PASSWORD_CHANGE_FAILURE
```
static final String PASSWORD_CHANGE_FAILURE
```
    See Also:
    Constant Field Values
  - USER_CREATE
```
static final String USER_CREATE
```
    See Also:
    Constant Field Values
  - USER_UPDATE
```
static final String USER_UPDATE
```
    See Also:
    Constant Field Values
  - USER_DELETE
```
static final String USER_DELETE
```
    See Also:
    Constant Field Values
  - USER_DISABLE
```
static final String USER_DISABLE
```
    See Also:
    Constant Field Values
  - USER_EXTEND
```
static final String USER_EXTEND
```
    See Also:
    Constant Field Values
  - USER_EXTEND_UNLIMITED
```
static final String USER_EXTEND_UNLIMITED
```
    See Also:
    Constant Field Values
  - PASSWORD_EXPIRE
```
static final String PASSWORD_EXPIRE
```
    See Also:
    Constant Field Values
  - PASSWORD_RESET
```
static final String PASSWORD_RESET
```
    See Also:
    Constant Field Values
  - PASSWORD_ACTIVATE
```
static final String PASSWORD_ACTIVATE
```
    See Also:
    Constant Field Values
  - PASSWORD_ENABLED
```
static final String PASSWORD_ENABLED
```
    See Also:
    Constant Field Values
  - PASSWORD_DISABLED
```
static final String PASSWORD_DISABLED
```
    See Also:
    Constant Field Values
  - PASSWORD_UPDATE_REQUIRED
```
static final String PASSWORD_UPDATE_REQUIRED
```
    See Also:
    Constant Field Values
  - PASSWORD_EXTEND
```
static final String PASSWORD_EXTEND
```
    See Also:
    Constant Field Values
  - PASSWORD_UNLIMITED
```
static final String PASSWORD_UNLIMITED
```
    See Also:
    Constant Field Values
  - USER_ADD_ROLE
```
static final String USER_ADD_ROLE
```
    See Also:
    Constant Field Values
  - USER_DELETE_ROLE
```
static final String USER_DELETE_ROLE
```
    See Also:
    Constant Field Values
  - USER_ADD_GROUP
```
static final String USER_ADD_GROUP
```
    See Also:
    Constant Field Values
  - USER_DELETE_GROUP
```
static final String USER_DELETE_GROUP
```
    See Also:
    Constant Field Values
  - USER_ADD_PROFILE
```
static final String USER_ADD_PROFILE
```
    See Also:
    Constant Field Values
  - USER_DELETE_PROFILE
```
static final String USER_DELETE_PROFILE
```
    See Also:
    Constant Field Values
  - USER_ADD_ATTRIBUTE
```
static final String USER_ADD_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - USER_DELETE_ATTRIBUTE
```
static final String USER_DELETE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - USER_UPDATE_ATTRIBUTE
```
static final String USER_UPDATE_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - REGISTRY_DEPLOY
```
static final String REGISTRY_DEPLOY
```
    See Also:
    Constant Field Values
  - REGISTRY_UNDEPLOY
```
static final String REGISTRY_UNDEPLOY
```
    See Also:
    Constant Field Values
  - REGISTRY_STOP
```
static final String REGISTRY_STOP
```
    See Also:
    Constant Field Values
  - REGISTRY_START
```
static final String REGISTRY_START
```
    See Also:
    Constant Field Values
  - REGISTRY_DELETE
```
static final String REGISTRY_DELETE
```
    See Also:
    Constant Field Values
  - CAT_USER_AUTHENTICATION
```
static final String CAT_USER_AUTHENTICATION
```
    See Also:
    Constant Field Values
  - CAT_USER_ATTRIBUTE
```
static final String CAT_USER_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - CAT_ADMIN_USER_MAINTENANCE
```
static final String CAT_ADMIN_USER_MAINTENANCE
```
    See Also:
    Constant Field Values
  - CAT_ADMIN_CREDENTIAL_MAINTENANCE
```
static final String CAT_ADMIN_CREDENTIAL_MAINTENANCE
```
    See Also:
    Constant Field Values
  - CAT_ADMIN_ATTRIBUTE_MAINTENANCE
```
static final String CAT_ADMIN_ATTRIBUTE_MAINTENANCE
```
    See Also:
    Constant Field Values
  - CAT_ADMIN_AUTHORIZATION_MAINTENANCE
```
static final String CAT_ADMIN_AUTHORIZATION_MAINTENANCE
```
    See Also:
    Constant Field Values
  - CAT_ADMIN_REGISTRY_MAINTENANCE
```
static final String CAT_ADMIN_REGISTRY_MAINTENANCE
```
    See Also:
    Constant Field Values
- Method Detail
  - setEnabled
```
void setEnabled(boolean enabled)
```
    Enable or disable the auditing service at runtime.
    
    Parameters:
    enabled - the new state, true for enabled, false for disabled
  - getEnabled
```
boolean getEnabled()
```
    Get the enabled state of the auditing service.
    
    Returns:
    the current state of audit service
  - logUserActivity
```
void logUserActivity(String username,
                   String ipaddress,
                   String activity,
                   String description)
```
    Log user activity that requires audit trails
    
    Parameters:
    username - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    activity - the type of activity, see constants defined in this interface
    description - a general description or comment for this activity
  - logAdminUserActivity
```
void logAdminUserActivity(String adminUser,
                        String ipaddress,
                        String targetUser,
                        String activity,
                        String description)
```
    Log auditable activity by an administrator on behalf of another user
    
    Parameters:
    adminUser - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    targetUser - the user having activities logged by the adminUser
    activity - the type of activity, see constants defined in this interface
    description - a general description or comment for this activity
  - logAdminCredentialActivity
```
void logAdminCredentialActivity(String username,
                              String ipaddress,
                              String targetUser,
                              String activity,
                              String description)
```
    Log auditable activity by an administrator on credentials on behalf of a user
    
    Parameters:
    username - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    targetUser - the user having activities logged by the adminUser
    activity - the type of activity, see constants defined in this interface
    description - a general description or comment for this activity
  - logAdminAuthorizationActivity
```
void logAdminAuthorizationActivity(String username,
                                 String ipaddress,
                                 String targetUser,
                                 String activity,
                                 String name,
                                 String description)
```
    Log auditable activity by an administrator on authorization configuration on behalf of a user
    
    Parameters:
    username - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    targetUser - the user having activities logged by the adminUser
    activity - the type of activity, see constants defined in this interface
    name - the name of the resource being modified
    description - a general description or comment for this activity
  - logAdminAttributeActivity
```
void logAdminAttributeActivity(String username,
                             String ipaddress,
                             String targetUser,
                             String activity,
                             String name,
                             String beforeValue,
                             String afterValue,
                             String description)
```
    Log auditable activity by an administrator on user attributes on behalf of a user
    
    Parameters:
    username - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    targetUser - the user having activities logged by the adminUser
    activity - the type of activity, see constants defined in this interface
    name - the name of the resource being modified
    beforeValue - the value of the attribute before changes were made
    afterValue - the value of the attribute after changes were made
    description - a general description or comment for this activity
  - logUserAttributeActivity
```
void logUserAttributeActivity(String username,
                            String ipaddress,
                            String activity,
                            String name,
                            String beforeValue,
                            String afterValue,
                            String description)
```
    Log auditable activity by an administrator on user attributes
    
    Parameters:
    username - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    activity - the type of activity, see constants defined in this interface
    name - the name of the resource being modified
    beforeValue - the value of the attribute before changes were made
    afterValue - the value of the attribute after changes were made
    description - a general description or comment for this activity
  - logAdminRegistryActivity
```
void logAdminRegistryActivity(String adminUser,
                            String ipaddress,
                            String activity,
                            String description)
```
    Log auditable activity by an administrator on registry maintenance
    
    Parameters:
    adminUser - the administrative user performing auditable activities
    ipaddress - the ip address of the http request
    activity - the type of activity, see constants defined in this interface
    description - a general description or comment for this activity
  - getDataSource
```
DataSource getDataSource()
```
    Deprecated.
    
    Returns:
    DataSource in use by the logger

Interface AuditActivity

Field Summary

Method Summary

Field Detail

AUTHENTICATION_SUCCESS

AUTHENTICATION_FAILURE

PASSWORD_CHANGE_SUCCESS

PASSWORD_CHANGE_FAILURE

USER_CREATE

USER_UPDATE

USER_DELETE

USER_DISABLE

USER_EXTEND

USER_EXTEND_UNLIMITED

PASSWORD_EXPIRE

PASSWORD_RESET

PASSWORD_ACTIVATE

PASSWORD_ENABLED

PASSWORD_DISABLED

PASSWORD_UPDATE_REQUIRED

PASSWORD_EXTEND

PASSWORD_UNLIMITED

USER_ADD_ROLE

USER_DELETE_ROLE

USER_ADD_GROUP

USER_DELETE_GROUP

USER_ADD_PROFILE

USER_DELETE_PROFILE

USER_ADD_ATTRIBUTE

USER_DELETE_ATTRIBUTE

USER_UPDATE_ATTRIBUTE

REGISTRY_DEPLOY

REGISTRY_UNDEPLOY

REGISTRY_STOP

REGISTRY_START

REGISTRY_DELETE

CAT_USER_AUTHENTICATION

CAT_USER_ATTRIBUTE

CAT_ADMIN_USER_MAINTENANCE

CAT_ADMIN_CREDENTIAL_MAINTENANCE

CAT_ADMIN_ATTRIBUTE_MAINTENANCE

CAT_ADMIN_AUTHORIZATION_MAINTENANCE

CAT_ADMIN_REGISTRY_MAINTENANCE

Method Detail

setEnabled

getEnabled

logUserActivity

logAdminUserActivity

logAdminCredentialActivity

logAdminAuthorizationActivity

logAdminAttributeActivity

logUserAttributeActivity

logAdminRegistryActivity

getDataSource