Skip navigation links

oracle.wsm.audit
Class Auditor

java.lang.Object
oracle.wsm.audit.Auditor

public class Auditor

extends Object

Since:

release specific (what release of product did this appear in)

Version:

$Header: owsm/src/oracle/wsm/audit/Auditor.java /st_owsm/12 2009/01/14 23:40:18 rdhar Exp $

Author:

jbryan

Nested Class Summary

static class

Auditor.ContextType

Field Summary

static String	DEFAULT_J2SE_FILTER Default standalone filter expression.
static String	DEFAULT_J2SE_LOGDIR Default standalone log directory.
static Long	DEFAULT_RETRY_COUNT Default number of retries (for HA).
static Long	DEFAULT_RETRY_DELAY Default delay (in milliseconds) between retries (for HA).
static boolean	FAILURE Flag to use to indicate a failure event.
static String	PARAM_J2SE_FILTER Key to use to determine standalone filter expression.
static String	PARAM_J2SE_LOGDIR Key to use to determine standalone log directory.
static String	PARAM_RETRY_COUNT Key to use to determine number of retries (for HA).
static String	PARAM_RETRY_DELAY Key to use to determine delay between retries (for HA).
static boolean	SUCCESS Flag to use to indicate a success event.

Method Summary

static Auditor	createAuditor(Auditor.ContextType contextType, Properties params)
boolean	isEnabled(String eventType, boolean eventStatus, Map<String,Object> properties, Date startDate, Date prepDate) Quickly check to see whether an event might be audited.
void	log(oracle.security.jps.service.audit.AuditEvent ev, Date startDate, Date prepDate, Date checkDate) Audit an event and log performance information.
void	shutdown() Shutdown auditor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUCCESS

public static final boolean SUCCESS

Flag to use to indicate a success event.

See Also:

Constant Field Values

FAILURE

public static final boolean FAILURE

Flag to use to indicate a failure event.

See Also:

Constant Field Values

PARAM_J2SE_FILTER

public static final String PARAM_J2SE_FILTER

Key to use to determine standalone filter expression.

See Also:

Constant Field Values

DEFAULT_J2SE_FILTER

public static final String DEFAULT_J2SE_FILTER

Default standalone filter expression.

See Also:

Constant Field Values

PARAM_J2SE_LOGDIR

public static final String PARAM_J2SE_LOGDIR

Key to use to determine standalone log directory.

See Also:

Constant Field Values

DEFAULT_J2SE_LOGDIR

public static final String DEFAULT_J2SE_LOGDIR

Default standalone log directory.

PARAM_RETRY_COUNT

public static final String PARAM_RETRY_COUNT

Key to use to determine number of retries (for HA).

See Also:

Constant Field Values

DEFAULT_RETRY_COUNT

public static final Long DEFAULT_RETRY_COUNT

Default number of retries (for HA).

PARAM_RETRY_DELAY

public static final String PARAM_RETRY_DELAY

Key to use to determine delay between retries (for HA).

See Also:

Constant Field Values

DEFAULT_RETRY_DELAY

public static final Long DEFAULT_RETRY_DELAY

Default delay (in milliseconds) between retries (for HA).

Method Detail

createAuditor

public static Auditor createAuditor(Auditor.ContextType contextType,
                                    Properties params)
                             throws oracle.security.jps.JpsException

Throws:

oracle.security.jps.JpsException

isEnabled

public boolean isEnabled(String eventType,
                         boolean eventStatus,
                         Map<String,Object> properties,
                         Date startDate,
                         Date prepDate)
                  throws AuditException

Quickly check to see whether an event might be audited.

Parameters:

eventType - type of event

eventStatus - status of event

properties - event attributes

Returns:

whether event might be audited

Throws:

AuditException

log

public void log(oracle.security.jps.service.audit.AuditEvent ev,
                Date startDate,
                Date prepDate,
                Date checkDate)
         throws AuditException

Audit an event and log performance information.

Parameters:

ev - event to log

startDate - date when audit processing began

prepDate - date when audit preparation completed

checkDate - date when audit checking completed

Throws:

AuditException

shutdown

public void shutdown()
              throws AuditException

Shutdown auditor.

Throws:

AuditException

Skip navigation links