com.unboundid.directory.sdk.ds.types

Enum AuditSeverity

java.lang.Object

java.lang.Enum<AuditSeverity>

com.unboundid.directory.sdk.ds.types.AuditSeverity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuditSeverity>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum AuditSeverity
extends java.lang.Enum<AuditSeverity>

This enum defines the severity levels that may be used for data security audit report entries. Note that audit severity values are considered ordered, so something configured to report on items with a "warning" severity should also report on items with an "error" severity, "notice" includes both "warning" and "error", and "verbose" includes all severities.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR A severity level indicating a significant problem.
NOTICE A security level indicating something that may be important for administrators to see.
VERBOSE A security level indicating something that may not be important in most cases and may only be exposed for debugging purposes.
WARNING A security level indicating a warning.

Method Summary

Modifier and Type	Method and Description
Attribute	getReportEntryAttribute() Retrieves an attribute that may be used to represent this severity in report entries.
boolean	includes(AuditSeverity s) Indicates whether an item with the given severity should be handled by something configured to report on items with this severity.
static AuditSeverity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuditSeverity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ERROR

public static final AuditSeverity ERROR

A severity level indicating a significant problem.

WARNING

public static final AuditSeverity WARNING

A security level indicating a warning.

NOTICE

public static final AuditSeverity NOTICE

A security level indicating something that may be important for administrators to see.

VERBOSE

public static final AuditSeverity VERBOSE

A security level indicating something that may not be important in most cases and may only be exposed for debugging purposes.

Method Detail

values

public static AuditSeverity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuditSeverity c : AuditSeverity.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuditSeverity valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getReportEntryAttribute

public Attribute getReportEntryAttribute()

Retrieves an attribute that may be used to represent this severity in report entries.

Returns:

An attribute that may be used to represent this severity in report entries.

includes

public boolean includes(AuditSeverity s)

Indicates whether an item with the given severity should be handled by something configured to report on items with this severity.

Parameters:

s - The severity for which to make the determination.

Returns:

true if an item with the given severity should be handled by something configured to report on items with this severity, or false if not.