com.metamatrix.platform.security.audit
Interface AuditConfiguration

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable

All Known Implementing Classes:

BasicAuditConfiguration, UnmodifiableAuditConfiguration

public interface AuditConfiguration
extends java.lang.Comparable, java.lang.Cloneable

Method Summary

java.lang.Object	clone()
int	compareTo(java.lang.Object obj) Compares this object to another.
void	discardContext(java.lang.String context) Specify that messages with the input context should be discarded and not recorded.
void	discardContexts(java.util.Collection contexts) Specify that messages with the input contexts should be discarded and not recorded.
boolean	equals(java.lang.Object obj) Returns true if the specified object is semantically equal to this instance.
int	getAuditLevel() Get the level of detail of messages that are currently being recorded.
java.util.Set	getDiscardedContexts() Obtain the set of contexts for messages that are to be discarded.
boolean	isContextDiscarded(java.lang.String context)
boolean	isLevelDiscarded(int level)
void	recordAllContexts() Specify that messages in all contexts are to be recorded.
void	recordContext(java.lang.String context) Specify that messages in the input context should be recorded rather than discarded.
void	recordContexts(java.util.Collection contexts) Specify that messages in the input contexts should be recorded rather than discarded.
void	setAuditLevel(int newAuditLevel) Method to set the level of messages that are recorded for this VM.
java.lang.String	toString() String representation of logging configuration.

Method Detail

isContextDiscarded

boolean isContextDiscarded(java.lang.String context)

isLevelDiscarded

boolean isLevelDiscarded(int level)

getDiscardedContexts

java.util.Set getDiscardedContexts()

Obtain the set of contexts for messages that are to be discarded. If this method returns an empty set, then messages in all contexts are being recorded; if not empty, then messages with a context in the returned set are discarded and messages for all other contexts recorded.

Returns:

the set of contexts for messages that are to be discarded

discardContexts

void discardContexts(java.util.Collection contexts)

Specify that messages with the input contexts should be discarded and not recorded.

Parameters:

contexts - the set of contexts that are to be ignored for logging; this method does nothing if the reference is null or empty

discardContext

void discardContext(java.lang.String context)

Specify that messages with the input context should be discarded and not recorded.

Parameters:

context - the context to add to the set; this method does nothing if the reference is null

recordAllContexts

void recordAllContexts()

Specify that messages in all contexts are to be recorded.

recordContext

void recordContext(java.lang.String context)

Specify that messages in the input context should be recorded rather than discarded.

Parameters:

context - the context for messages that should be recorded; this method does nothing if the reference is null

recordContexts

void recordContexts(java.util.Collection contexts)

Specify that messages in the input contexts should be recorded rather than discarded.

Parameters:

contexts - the set of contexts that are to be recorded; this method does nothing if the reference is null or empty

getAuditLevel

int getAuditLevel()

Get the level of detail of messages that are currently being recorded.

Returns:

the level of detail

setAuditLevel

void setAuditLevel(int newAuditLevel)

Method to set the level of messages that are recorded for this VM.

Parameters:

newMessageLevel - the new level; must be either AuditLevel.NONE, AuditLevel.FULL

Throws:

java.lang.IllegalArgumentException - if the level is out of range.

compareTo

int compareTo(java.lang.Object obj)

Compares this object to another. If the specified object is an instance of the MetadataID class, then this method compares the name; otherwise, it throws a ClassCastException (as instances are comparable only to instances of the same class). Note: this method is consistent with equals(), meaning that (compare(x, y)==0) == (x.equals(y)).

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - the object that this instance is to be compared to.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.

Throws:

java.lang.IllegalArgumentException - if the specified object reference is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

equals

boolean equals(java.lang.Object obj)

Returns true if the specified object is semantically equal to this instance. Note: this method is consistent with compareTo().

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object that this instance is to be compared to.

Returns:

whether the object is equal to this object.

toString

java.lang.String toString()

String representation of logging configuration.

Overrides:

toString in class java.lang.Object

Returns:

String representation

clone

java.lang.Object clone()