org.adroitlogic.ultraesb.api.mediation

Enum AuditSupport.AuditMode

java.lang.Object

java.lang.Enum<AuditSupport.AuditMode>

org.adroitlogic.ultraesb.api.mediation.AuditSupport.AuditMode

All Implemented Interfaces:

Serializable, Comparable<AuditSupport.AuditMode>

Enclosing interface:

AuditSupport

public static enum AuditSupport.AuditMode
extends Enum<AuditSupport.AuditMode>

This enumeration represents the mode at which a particular audit log should be generated. enumeration value and there respective meanings are as follows; COMPLETE - Record the message payload, headers and properties all PAYLOAD_ONLY - Record the message payload, but not headers nor properties HEADERS_ONLY - Record the message headers, but not payload not properties PROPERTIES_ONLY - Record the message properties, but not payload nor headers PAYLOAD_AND_HEADERS - Record the message payload and headers, but not properties PAYLOAD_AND_PROPERTIES - Record the message payload and properties, but not headers HEADERS_AND_PROPERTIES - Record the message headers and properties, but not payload

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE
HEADERS_AND_PROPERTIES
HEADERS_ONLY
PAYLOAD_AND_HEADERS
PAYLOAD_AND_PROPERTIES
PAYLOAD_ONLY
PROPERTIES_ONLY

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	shouldAuditHeaders() Whether headers are recorded
abstract boolean	shouldAuditPayload() Whether payload is recorded
abstract boolean	shouldAuditProperties() Whether properties are recorded
static AuditSupport.AuditMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuditSupport.AuditMode[]	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

COMPLETE

public static final AuditSupport.AuditMode COMPLETE

PAYLOAD_ONLY

public static final AuditSupport.AuditMode PAYLOAD_ONLY

HEADERS_ONLY

public static final AuditSupport.AuditMode HEADERS_ONLY

PROPERTIES_ONLY

public static final AuditSupport.AuditMode PROPERTIES_ONLY

PAYLOAD_AND_HEADERS

public static final AuditSupport.AuditMode PAYLOAD_AND_HEADERS

PAYLOAD_AND_PROPERTIES

public static final AuditSupport.AuditMode PAYLOAD_AND_PROPERTIES

HEADERS_AND_PROPERTIES

public static final AuditSupport.AuditMode HEADERS_AND_PROPERTIES

Method Detail

values

public static AuditSupport.AuditMode[] 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 (AuditSupport.AuditMode c : AuditSupport.AuditMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuditSupport.AuditMode valueOf(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:

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

NullPointerException - if the argument is null

shouldAuditHeaders

public abstract boolean shouldAuditHeaders()

Whether headers are recorded

Returns:

boolean true iff headers should be recorded

shouldAuditPayload

public abstract boolean shouldAuditPayload()

Whether payload is recorded

Returns:

boolean true iff payload should be recorded

shouldAuditProperties

public abstract boolean shouldAuditProperties()

Whether properties are recorded

Returns:

boolean true iff properties should be recorded