com.neeve.aep
Enum AepEngine.InboundMessageLoggingPolicy

java.lang.Object
  java.lang.Enum<AepEngine.InboundMessageLoggingPolicy>
      com.neeve.aep.AepEngine.InboundMessageLoggingPolicy

All Implemented Interfaces:

Serializable, Comparable<AepEngine.InboundMessageLoggingPolicy>

Enclosing class:

AepEngine

public static enum AepEngine.InboundMessageLoggingPolicy
extends Enum<AepEngine.InboundMessageLoggingPolicy>

Enumerates an engine's inbound message logging policy.

This enumerates the policy that determines if and where to log inbound messages

Enum Constant Summary

Default
Use the default inbound message logging policy.

Off
Disable inbound message logging.

UseDedicated
Use a dedicated log for inbound message logging.

UserSupplied
Use a user supplied log for inbound message logging.

Method Summary

static AepEngine.InboundMessageLoggingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static AepEngine.InboundMessageLoggingPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Default

public static final AepEngine.InboundMessageLoggingPolicy Default

Use the default inbound message logging policy.

The default inbound message logging policy is determined by the HA and persistence mode at play. With this policy, if event sourcing & cluster persistence are enabled, then inbound message logging is implictly switched on and inbound messages are logged through the store's persister. All other configurations switch off inbound message logging.

Off

public static final AepEngine.InboundMessageLoggingPolicy Off

Disable inbound message logging.

With this policy, inbound message logging is disabled.

This option is invalid for use with engines configured to be clustered and use Event Sourcing since, in that mode inbound messages are logged in the store's event log by virtue of inbound message replication.

This is the default policy with State Replication and Standalone mode of operation. The Standalone mode of operation is one where an engine has not been configured for HA i.e. configured without a store.

UseDedicated

public static final AepEngine.InboundMessageLoggingPolicy UseDedicated

Use a dedicated log for inbound message logging.

With this policy, the engine uses a dedicated logger to log inbound messages.

This option is invalid for use with engines configured to be clustered and use Event Sourcing since, in that mode inbound messages are logged in the store's event log by virtue of inbound message replication.

UserSupplied

public static final AepEngine.InboundMessageLoggingPolicy UserSupplied

Use a user supplied log for inbound message logging.

With this policy, the engine uses a user logger supplied via AepEngine.setInboundMessageLogger(com.neeve.rog.IRogMessageLogger) to log inbound messages.

This option is invalid for use with engines configured to be clustered and use Event Sourcing since, in that mode inbound messages are logged in the store's event log by virtue of inbound message replication.

Method Detail

values

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

Returns:

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

valueOf

public static AepEngine.InboundMessageLoggingPolicy 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