AepEngineDescriptor (Talon 3.7.265 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.neeve.aep
Class AepEngineDescriptor

java.lang.Object
  com.neeve.root.RootObject
      com.neeve.aep.AepEngineDescriptor

public final class AepEngineDescriptor
extends RootObject
extends RootObject

An AEP engine descriptor.

This class configures an AEP engine instance and supplies methods to persist descriptors in platform configuration respositories.

Threading:: This class is not safe for concurrent access by multiple threads.

Nested Class Summary
`static class`	`AepEngineDescriptor.ChannelConfig` Class describing configuration information for an AEP engine's channel.

Method Summary
`AepEngineDescriptor`	`addBus(String busName)` Add a bus to an engine's list of buses.
`AepEngineDescriptor`	`addChannel(String channelDescriptor)` Add a channel to an engine's list of channels.
`AepEngineDescriptor`	`addChannel(String channelName, AepEngineDescriptor.ChannelConfig channelConfig)` Add a global channel to an engine's list of channels.
`AepEngineDescriptor`	`addChannel(String busName, String channelName, AepEngineDescriptor.ChannelConfig channelConfig)` Add a bus specific channel to an engine's list of channels.
`AepEngineDescriptor`	`addMessageFactory(String factoryClassName)` Add the name of a factory class to the list of message factories
`AepEngineDescriptor`	`addStateFactory(String factoryClassName)` Add the name of a factory class to the list of state factories
`AepEngineDescriptor`	`clearBusManagerProperties(String busName)` Clear a bus manager's configuration properties
`AepEngineDescriptor`	`clearBusManagerProperty(String busName, String propName)` Clear a bus manager's configuration property
`AepEngineDescriptor`	`clearEventMultiplexerProperty(String name)` Clear an engine's event multiplexer property.
`AepEngineDescriptor`	`clearInboundMessageLoggingProperty(String name)` Clear an engine's inbound message logging property.
`AepEngineDescriptor`	`clearOutboundMessageLoggingProperty(String name)` Clear an engine's outbound message logging property.
`AepEngineDescriptor`	`clearPerTransactionStatsLoggingProperty(String name)` Clear an engine's per transaction stats message logging property.
`AepEngineDescriptor`	`clearStartupExpectation(AepEngine.StartupExpectation expectation)` Clear an engine's startup expectation.
`static AepEngineDescriptor`	`create(String name)` Create a default AEP engine descriptor.
`void`	`delete()` Delete an AEP engine descriptor from the default configuration repository.
`void`	`delete(IConfigRepository repo)` Delete an AEP engine descriptor from a configuration repository.
`static boolean`	`exists(IConfigRepository repo, String name)` Checks if an AEP engine is configured in a configuration repository.
`static boolean`	`exists(String name)` Checks if an AEP engine is configured in the default configuration repository
`int`	`getAdaptiveCommitBatchCeiling()` Get an engine's adaptive commit batch ceiling.
`boolean`	`getAdministrative()` Get whether an engine is an administrative enginel
`AepEngine.AppExceptionHandlingPolicy`	`getAppExceptionHandlingPolicy()` Get an engine's application exception handling policy.
`Set<String>`	`getBuses()` Get an engine's bus list.
`Properties`	`getBusManagerProperties(String busName)` Get a bus manager's configuration properties
`Set<String>`	`getBusManagersWithConfiguration()` Get the set of bus names that have been configured
`boolean`	`getCaptureEventLatencyStats()` Get whether event processing latencies are captured.
`boolean`	`getCaptureMessageTypeStats()` Get whether stats are additionally recorded ona per message type basis.
`boolean`	`getCapturePerTransactionStats()` Get whether or not the engine records transaction timing stats.
`boolean`	`getCaptureTransactionLatencyStats()` Get whether or not the engine records transaction latency stats.
`AepEngineDescriptor.ChannelConfig`	`getChannelConfig(String busName, String channelName)` Get an engine's channel configuration
`Map<String,AepEngineDescriptor.ChannelConfig>`	`getChannels(String busName)` Get an engine's channel list.
`int`	`getClusterHeartbeatInterval()` Get the cluster heartbeat interval
`boolean`	`getDispatchTransactionStageEvents()` Get whether an engine will dispatch transaction stage events.
`boolean`	`getDisposeOnSend()` Get whether `AepEngine.sendMessage(com.neeve.sma.MessageChannel, com.neeve.rog.IRogMessage, java.util.Properties)` disposes sent messages.
`boolean`	`getEnableEventTrace()` Get whether diagnostic trace logging related to engine events is enabled.
`boolean`	`getEnableMessageTrace()` Get whether diagnostic trace logging for messages is enabled
`boolean`	`getEnableScheduleTrace()` Get whether diagnostic trace logging related to engine schedules is enabled.
`boolean`	`getEnableSendCommitCompleteSequenceAlerts()` Get whether or not to enable out of order send commit completion detection.
`boolean`	`getEnableSequenceNumberTrace()` Get whether diagnostic trace logging related to message sequencing is enabled.
`boolean`	`getEnableTransactionCommitSuspension()` Get whether transaction commit suspension is enabled in an engine.
`boolean`	`getEnableTransactionSavepoints()` Gets whether or not transaction savepoints are enabled for the engine.
`boolean`	`getEnableTransactionTrace()` Get whether diagnostic trace logging related to engine transactions is enabled.
`Properties`	`getEventMultiplexerProperties()` Get the set of event multiplexer properties.
`String`	`getEventMultiplexerProperty(String name)` Get an engine's event multiplexer property.
`AepEngine.EventMultiplexerType`	`getEventMultiplexerType()` Get an engine's event multiplexer type.
`AepEngine.HAPolicy`	`getHAPolicy()` Get an engine's HA policy.
`AepEngine.InboundEventAcknowledgementPolicy`	`getInboundEventAcknowledgementPolicy()` Gets the `AepEngine`'s `AepEngine.InboundEventAcknowledgementPolicy`.
`AepEngine.InboundMessageLoggingFailurePolicy`	`getInboundMessageLoggingFailurePolicy()` The engine's inbound message logging failure policy.
`AepEngine.InboundMessageLoggingPolicy`	`getInboundMessageLoggingPolicy()` Get an engine's message inbound message logging policy.
`Properties`	`getInboundMessageLoggingProperties()` Get the set of inbound message logging properties.
`String`	`getInboundMessageLoggingProperty(String name)` Get an engine's inbound message logging property.
`int`	`getMaxEnvironmentProviders()` Get the maximum number of environment providers that can be registered with the engine.
`AepEngine.MessageBusBindingFailPolicy`	`getMessageBusBindingFailPolicy()` Get an engine's message bus binding fail policy.
`List<String>`	`getMessageFactories()` Get the list of an engine's message factories
`AepEngine.MessageHandlingPolicy`	`getMessageHandlingPolicy()` Get an engine's message handling policy.
`AepEngine.MessageSendExceptionHandlingPolicy`	`getMessageSendExceptionHandlingPolicy()` Get an engine's message send exception handling policy.
`AepEngine.MessageSendPolicy`	`getMessageSendPolicy()` Deprecated. The message send policy has been deprecated. This method will always return `AepEngine.MessageSendPolicy.ReplicateBeforeSend`
`boolean`	`getMessageTraceFilterUnsetFields()` Get whether unset fields are filtered for json formatted objects when json message tracing is enabled.
`boolean`	`getMessageTraceInJson()` Get whether messages are traced in Json or toString
`RogLogUtil.JsonPrettyPrintStyle`	`getMessageTraceJsonStyle()` Get the styling of Json formated message trace.
`RogLogUtil.MetadataDisplayPolicy`	`getMessageTraceMetadataDisplayPolicy()` Get whether metadata, payload or both will be traced when message trace logging is enabled.
`AepEngine.MessagingStartFailPolicy`	`getMessagingStartFailPolicy()` Get an engine's messaging start fail policy.
`String`	`getName()` Get the name of the AEP engine that this descriptor describes.
`AepEngine.OutboundMessageLoggingFailurePolicy`	`getOutboundMessageLoggingFailurePolicy()` The engine's outbound message logging failure policy.
`AepEngine.OutboundMessageLoggingPolicy`	`getOutboundMessageLoggingPolicy()` Get an engine's message outbound message logging policy.
`Properties`	`getOutboundMessageLoggingProperties()` Get the set of outbound message logging properties.
`String`	`getOutboundMessageLoggingProperty(String name)` Get an engine's outbound message logging property.
`boolean`	`getPerformDuplicateChecking()` Get whether an engine is configured to perform duplicate checking
`boolean`	`getPerformMidstreamInitializationValidation()` Get whether the engine checks that initial transactions are not missing during recovery or replication in `Event Sourced` engines.
`AepEngine.PerTransactionStatsLoggingFailurePolicy`	`getPerTransactionStatsLoggingFailurePolicy()` The engine's binary transaction stats logging failure policy.
`AepEngine.PerTransactionStatsLoggingPolicy`	`getPerTransactionStatsLoggingPolicy()` Get an engine's binary transaction stats logging policy.
`Properties`	`getPerTransactionStatsLoggingProperties()` Gets an aep engine's per transaction stats logging properties.
`String`	`getPerTransactionStatsLoggingProperty(String name)` Get an engine's per transaction stats message logging property.
`boolean`	`getPreserveChannelJoinsOnStop()` Gets whether or not joined channels are preserved on clean shutdown.
`String`	`getQuarantineChannel()` Get an engine's quarantine channel
`String`	`getQuarantineMessageKey()` Get an engine's quarantine message key.
`boolean`	`getReplicateInParallel()` Get whether parallel replication is enabled
`boolean`	`getReplicateSolicitedSends()` Get whether to replicate solicited sends.
`boolean`	`getReplicateUnsolicitedSends()` Get whether to replicate unsolicited sends.
`AepEngine.ReplicationPolicy`	`getReplicationPolicy()` Get an engine's replication policy.
`boolean`	`getSequenceUnsolicitedSends()` Get whether unsolicited sends are sequenced.
`boolean`	`getSequenceUnsolicitedWithSolicitedSends()` Get whether unsolicited sends are sequenced with solicited sends.
`boolean`	`getSetInboundMessagesAsReadOnly()` Get whether inbound messages are marked as read only on receipt.
`boolean`	`getSetOutboundMessagesAsReadOnly()` Get whether outbound messages are marked as read only on send.
`boolean`	`getSetOutboundSequenceNumbers()` Get whether sequence numbers are set on outbound messages
`boolean`	`getSetSupportMetadata()` Get whether inbound messages are marked as read only on receipt.
`Enum<?>`	`getStartupExpectation(AepEngine.StartupExpectation expectation)` Get an engine's startup expectation.
`Map<AepEngine.StartupExpectation,Enum<?>>`	`getStartupExpectations()` Get the set of an engine's startup expectations.
`List<String>`	`getStateFactories()` Get the list of an engine's state factories
`String`	`getStore()` Get the name of an engine's ODS store.
`int`	`getStuckAlertEventThreshold()` Get's the engine stuck alert event threshold.
`boolean`	`getSyncInjectedMessages()` Gets whether `MessageView.sync()` is called during `AepEngine.injectMessage(com.neeve.rog.IRogMessage)`.
`static AepEngineDescriptor`	`load(IConfigRepository repo, String name)` Create an AEP engine descriptor from a configuration repository.
`static AepEngineDescriptor`	`load(String name)` Create an AEP engine from the default configuration repository.
`static Set<AepEngineDescriptor>`	`loadAll()` Create descriptors for all AEP engines in the default configuration repository.
`static Set<AepEngineDescriptor>`	`loadAll(IConfigRepository repo)` Create descriptors for all AEP engines in a configuration repository.
`AepEngineDescriptor`	`removeBus(String busName)` Remove a bus from an engine's list of buses.
`AepEngineDescriptor`	`removeChannel(String channelDescriptor)` Remove a channel from an engine's list of channels.
`AepEngineDescriptor`	`removeChannel(String busName, String channelName)` Remove a bus specific channel from an engine's list of channels.
`void`	`save()` Save an AEP engine descriptor to the default configuration repository.
`void`	`save(IConfigRepository repo)` Save a AEP engine descriptor to a configuration repository.
`AepEngineDescriptor`	`setAdaptiveCommitBatchCeiling(int val)` Set the adaptive commit batch ceiling.
`AepEngineDescriptor`	`setAdministrative(boolean val)` Set whether an engine is an administrative engine.
`AepEngineDescriptor`	`setAppExceptionHandlingPolicy(AepEngine.AppExceptionHandlingPolicy val)` Set an engine's application exception handling policy.
`AepEngineDescriptor`	`setBusManagerProperties(String busName, Properties properties)` Set a bus manager's configuration properties
`String`	`setBusManagerProperty(String busName, String propName)` Get a bus manager's configuration property
`AepEngineDescriptor`	`setBusManagerProperty(String busName, String propName, String propVal)` Set a bus manager's configuration property
`AepEngineDescriptor`	`setCaptureEventLatencyStats(boolean val)` Set whether event processing latencies are captured.
`AepEngineDescriptor`	`setCaptureMessageTypeStats(boolean val)` Set whether stats are additionally recorded ona per message type basis.
`AepEngineDescriptor`	`setCapturePerTransactionStats(boolean val)` Sets whether or not the engine record per transaction stats.
`AepEngineDescriptor`	`setCaptureTransactionLatencyStats(boolean val)` Set whether or not the engine records transaction latency stats.
`AepEngineDescriptor`	`setClusterHeartbeatInterval(int val)` Set the cluster heartbeat interval (in milliseconds).
`AepEngineDescriptor`	`setDispatchTransactionStageEvents(boolean val)` Set whether transaction stage events should dispatched.
`AepEngineDescriptor`	`setDisposeOnSend(boolean val)` Set whether to automatically dispose sent messages.
`AepEngineDescriptor`	`setEnableEventTrace(boolean val)` Enable diagnostic trace logging of events received and dispatched by an engine Enabling this is useful in determining the sequence of events processed by the engine When enabled trace will be emitted at debug level to the logger named 'nv.aep.event'.
`AepEngineDescriptor`	`setEnableMessageTrace(boolean val)` Enable diagnostic trace logging for messages.
`AepEngineDescriptor`	`setEnableScheduleTrace(boolean val)` Enable diagnostic trace logging related to schedules managed by an engine.
`AepEngineDescriptor`	`setEnableSendCommitCompleteSequenceAlerts(boolean val)` Set whether or not to enable out of order send commit completion detection.
`AepEngineDescriptor`	`setEnableSequenceNumberTrace(boolean val)` Enable diagnostic trace logging related to message sequencing.
`AepEngineDescriptor`	`setEnableTransactionCommitSuspension(boolean val)` Set whether transaction commit suspension is enabled or disabled.
`void`	`setEnableTransactionSavepoints(boolean enableTransactionSavepoints)` Sets whether or not transaction savepoints are enabled for the engine.
`AepEngineDescriptor`	`setEnableTransactionTrace(boolean val)` Enable diagnostic trace logging related to transactions processed by an engine.
`AepEngineDescriptor`	`setEventMultiplexerProperties(Properties val)` Set the set of event multiplexer properties.
`AepEngineDescriptor`	`setEventMultiplexerProperty(String name, String val)` Set an engine's event multiplexer property.
`AepEngineDescriptor`	`setEventMultiplexerType(AepEngine.EventMultiplexerType val)` Set an engine's event multiplexer type.
`AepEngineDescriptor`	`setHAPolicy(AepEngine.HAPolicy val)` Set an engine's HA policy.
`AepEngineDescriptor`	`setInboundEventAcknowledgementPolicy(AepEngine.InboundEventAcknowledgementPolicy policy)` Set's the policy controlling when inbound events processed by an the application are acnowledged upstream.
`AepEngineDescriptor`	`setInboundMessageLoggingFailurePolicy(AepEngine.InboundMessageLoggingFailurePolicy val)` Set an engine's inbound message logging failure policy.
`AepEngineDescriptor`	`setInboundMessageLoggingPolicy(AepEngine.InboundMessageLoggingPolicy val)` Set an engine's inbound message logging policy.
`AepEngineDescriptor`	`setInboundMessageLoggingProperties(Properties val)` Set the set of inbound message logging properties.
`AepEngineDescriptor`	`setInboundMessageLoggingProperty(String name, String val)` Set an engine's inbound message logging property.
`AepEngineDescriptor`	`setMaxEnvironmentProviders(int val)` Set the maximum number of environment providers that can be registered with the engine.
`AepEngineDescriptor`	`setMessageBusBindingFailPolicy(AepEngine.MessageBusBindingFailPolicy val)` Set an engine's message bus binding fail policy.
`AepEngineDescriptor`	`setMessageHandlingPolicy(AepEngine.MessageHandlingPolicy val)` Set an engine's message handling policy.
`AepEngineDescriptor`	`setMessageSendExceptionHandlingPolicy(AepEngine.MessageSendExceptionHandlingPolicy val)` Set an engine's message send exception handling policy.
`AepEngineDescriptor`	`setMessageSendPolicy(AepEngine.MessageSendPolicy val)` Deprecated. The message send policy has been deprecated. This method is a noop. AEP engines will always function with ReplicateBeforeSend
`AepEngineDescriptor`	`setMessageTraceFilterUnsetFields(boolean val)` Set whether unset fields are filtered for json formatted objects when json message tracing is enabled.
`AepEngineDescriptor`	`setMessageTraceInJson(boolean val)` Sets whether messages are traced in Json or toString format.
`AepEngineDescriptor`	`setMessageTraceJsonStyle(RogLogUtil.JsonPrettyPrintStyle val)` Set the styling of Json formatted message trace.
`AepEngineDescriptor`	`setMessageTraceMetadataDisplayPolicy(RogLogUtil.MetadataDisplayPolicy val)` Set whether metadata, payload or both will be traced when message trace logging is enabled.
`AepEngineDescriptor`	`setMessagingStartFailPolicy(AepEngine.MessagingStartFailPolicy val)` Set an engine's messaging start fail policy.
`AepEngineDescriptor`	`setOutboundMessageLoggingFailurePolicy(AepEngine.OutboundMessageLoggingFailurePolicy val)` Set an engine's outbound message logging failure policy.
`AepEngineDescriptor`	`setOutboundMessageLoggingPolicy(AepEngine.OutboundMessageLoggingPolicy val)` Set an engine's outbound message logging policy.
`AepEngineDescriptor`	`setOutboundMessageLoggingProperties(Properties val)` Set the set of outbound message logging properties.
`AepEngineDescriptor`	`setOutboundMessageLoggingProperty(String name, String val)` Set an engine's outbound message logging property.
`AepEngineDescriptor`	`setPerformDuplicateChecking(boolean val)` Set whether the engine should perform duplicate checking When duplicate checking is enabled received messaegs that are deemed duplicates are discarded by the engine.
`AepEngineDescriptor`	`setPerformMidstreamInitializationValidation(boolean val)` Set whether the engine checks that initial transactions are not missing during recovery or replication in `Event Sourced` engines.
`AepEngineDescriptor`	`setPerTransactionStatsLoggingFailurePolicy(AepEngine.PerTransactionStatsLoggingFailurePolicy val)` Set an engine's binary transaction stats logging failure policy.
`AepEngineDescriptor`	`setPerTransactionStatsLoggingPolicy(AepEngine.PerTransactionStatsLoggingPolicy val)` Set an engine's binary transaction stats logging policy.
`AepEngineDescriptor`	`setPerTransactionStatsLoggingProperties(Properties val)` Set the value of a per transaction stats logging properties.
`AepEngineDescriptor`	`setPerTransactionStatsLoggingProperty(String name, String val)` Set an engine's per transaction stats message logging property.
`AepEngineDescriptor`	`setPreserveChannelJoinsOnStop(boolean preserveChannelJoinsOnStop)` Sets whether or not to preserve joined channels when the engine stops normally.
`AepEngineDescriptor`	`setQuarantineChannel(String val)` Set an engine's quarantine channel.
`AepEngineDescriptor`	`setQuarantineMessageKey(String val)` Set an engine's quarantine message key.
`AepEngineDescriptor`	`setReplicateInParallel(boolean val)` Enable parallel replication When parallel replication is enabled, the engine replicates inbound messages to the cluster backups in parallel with the processing of the message by the message handler.
`AepEngineDescriptor`	`setReplicateSolicitedSends(boolean val)` Set whether to replicate solicited sends.
`AepEngineDescriptor`	`setReplicateUnsolicitedSends(boolean val)` Set whether to replicate unsolicited sends.
`AepEngineDescriptor`	`setReplicationPolicy(AepEngine.ReplicationPolicy val)` Set an engine's replication policy.
`AepEngineDescriptor`	`setSequenceUnsolicitedSends(boolean val)` Set whether to sequence unsolicited sends.
`AepEngineDescriptor`	`setSequenceUnsolicitedWithSolicitedSends(boolean val)` Set whether to sequence unsolicited sends with solicited sends.
`AepEngineDescriptor`	`setSetInboundMessagesAsReadOnly(boolean val)` Set whether inbound messages are marked as read only on receipt.
`AepEngineDescriptor`	`setSetOutboundMessagesAsReadOnly(boolean val)` Set whether outbound messages are marked as read only on send.
`AepEngineDescriptor`	`setSetOutboundSequenceNumbers(boolean val)` Set whether support sequence numbers are set by the engine on outbound messages Setting this property to `false` prevents the engine from setting sequence numbers on outbound messages.
`AepEngineDescriptor`	`setSetSupportMetadata(boolean val)` Set whether support related metadata is set by the engine on inbound and outbound messages.
`AepEngineDescriptor`	`setStartupExpectation(AepEngine.StartupExpectation expectation, Enum<?> val)` Set an engine's startup expectation.
`AepEngineDescriptor`	`setStartupExpectations(Map<AepEngine.StartupExpectation,Enum<?>> val)` Set the set of an engine's startup expectations.
`AepEngineDescriptor`	`setStore(String storeName)` Set the name of an engine's ODS store.
`AepEngineDescriptor`	`setStuckAlertEventThreshold(int thresholdSeconds)` Defines the threshold, in seconds, after which an AepStuckAlertEvent is dispatched to the application's `IAepAsynchronousEventHandler`.
`void`	`setSyncInjectedMessages(boolean syncInjectedMessages)` Sets whether `MessageView.sync()` is called during `AepEngine.injectMessage(com.neeve.rog.IRogMessage)`.
`String`	`toString()` Return the string representation of an engine descriptor

Methods inherited from class com.neeve.root.RootObject
`getChecked, getThreaded, getTracer, setChecked, setTracer`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Method Detail

getName

public final String getName()

Get the name of the AEP engine that this descriptor describes.

Threading:: This method is safe for concurrent access by multiple threads.

addStateFactory

public final AepEngineDescriptor addStateFactory(String factoryClassName)

Add the name of a factory class to the list of state factories

Parameters:: factoryClassName - The name of the factory class to add.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

getStateFactories

public final List<String> getStateFactories()

Get the list of an engine's state factories

Returns:: Returns the list of state factories
Threading:: This method is not safe for concurrent access by multiple threads.

addMessageFactory

public final AepEngineDescriptor addMessageFactory(String factoryClassName)

Add the name of a factory class to the list of message factories

Parameters:: factoryClassName - The name of the factory class to add.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

getMessageFactories

public final List<String> getMessageFactories()

Get the list of an engine's message factories

Returns:: Returns the list of message factories
Threading:: This method is not safe for concurrent access by multiple threads.

addBus

public final AepEngineDescriptor addBus(String busName)

Add a bus to an engine's list of buses.

Parameters:: busName - The bus to add.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

setBusManagerProperty

public final AepEngineDescriptor setBusManagerProperty(String busName,
                                                       String propName,
                                                       String propVal)

Set a bus manager's configuration property

Parameters:: busName - The bus manager to configure.; propName - The property to set.; propVal - The property value.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

setBusManagerProperty

public final String setBusManagerProperty(String busName,
                                          String propName)

Get a bus manager's configuration property

Parameters:: busName - The bus manager to configure.; propName - The property to set.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

clearBusManagerProperty

public final AepEngineDescriptor clearBusManagerProperty(String busName,
                                                         String propName)

Clear a bus manager's configuration property

Parameters:: busName - The bus manager to configure.; propName - The property to set.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

setBusManagerProperties

public final AepEngineDescriptor setBusManagerProperties(String busName,
                                                         Properties properties)

Set a bus manager's configuration properties

Parameters:: busName - The bus manager to configure.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

getBusManagerProperties

public final Properties getBusManagerProperties(String busName)

Get a bus manager's configuration properties

Parameters:: busName - The bus manager whose configuration to return.
Threading:: This method is not safe for concurrent access by multiple threads.
Note: The properties object returned is the object maintained by the descriptor. Therefore, bus managed properties can be added, removed and/or updated directly in the returned object. For the changes to take effect, the changes must be made before the engine is created.

clearBusManagerProperties

public final AepEngineDescriptor clearBusManagerProperties(String busName)

Clear a bus manager's configuration properties

Parameters:: busName - The bus manager whose configuration to clear.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

getBusManagersWithConfiguration

public final Set<String> getBusManagersWithConfiguration()

Get the set of bus names that have been configured

Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

removeBus

public final AepEngineDescriptor removeBus(String busName)

Remove a bus from an engine's list of buses.

Parameters:: busName - The bus to add.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.

addChannel

public final AepEngineDescriptor addChannel(String channelName,
                                            AepEngineDescriptor.ChannelConfig channelConfig)

Add a global channel to an engine's list of channels.

Parameters:: channelName - The channel to add.; channelConfig - The channel configuration object.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.
This method will add a global channel to the engine's list of channels. A global channel is one that is processed for each of the buses configured for the application except the engine's internal buses.

addChannel

public final AepEngineDescriptor addChannel(String busName,
                                            String channelName,
                                            AepEngineDescriptor.ChannelConfig channelConfig)

Add a bus specific channel to an engine's list of channels.

Parameters:: busName - The bus to which the channel belongs.; channelName - The channel to add.; channelConfig - The channel configuration object.
Returns:: Returns this descriptor for invocation chaining.
Threading:: This method is not safe for concurrent access by multiple threads.
This method will add a bus specific channel to the engine's list of channels. A bus specific channel is one that is processed only for the specified bus when the engine starts messaging.

removeChannel

public final AepEngineDescriptor removeChannel(String busName,
                                               String channelName)

Remove a bus specific channel from an engine's list of channels.

Parameters:: busName - The bus to which the channel belongs.; channelName - The channel to remove.
Threading:: This method is not safe for concurrent access by multiple threads.
Note: If all channels are removed from a bus, the bus is also effectively removed from the descriptor i.e. the bus will not be joined by the engine. If the intent is to keep the bus around and just remove the channels, then the bus needs to be explictly added again after the remove.

addChannel

public final AepEngineDescriptor addChannel(String channelDescriptor)

Add a channel to an engine's list of channels.

Parameters:: channelDescriptor - Specifies the channel to be added. This must be of the form @&prop1=val1&...&propN=valN. A descriptor without the bus name is interpreted to be for a global channel.
Threading:: This method is not safe for concurrent access by multiple threads.

removeChannel

public final AepEngineDescriptor removeChannel(String channelDescriptor)

Remove a channel from an engine's list of channels.

Parameters:: channelDescriptor - Specifies the channel to be removed. This must be of the form @. A descriptor without the bus name is interpreted to be for a global channel.
Threading:: This method is not safe for concurrent access by multiple threads.

getBuses

public final Set<String> getBuses()

Get an engine's bus list.

Threading:: This method is not safe for concurrent access with other methods that manipulate the engine's channel list.
This method returns the list of buses for which the engine has channels configured to join.

getChannels

public final Map<String,AepEngineDescriptor.ChannelConfig> getChannels(String busName)

Get an engine's channel list.

Parameters:: busName - The bus for which the channels are to be retrieved.
Threading:: This method is not safe for concurrent access with other methods that manipulate the engine's channel list.
This method returns the list of channels within a specified bus that an engine is configured to join. A return value of null indicates that the engine is not configured to join any of the channels in the specified bus.

getChannelConfig

public final AepEngineDescriptor.ChannelConfig getChannelConfig(String busName,
                                                                String channelName)

Get an engine's channel configuration

setStore

public final AepEngineDescriptor setStore(String storeName)

Set the name of an engine's ODS store.

Parameters:: storeName - The name of the store. A store of this name should exist in the default repository at runtime from where the AEP engine using this descriptor will load the store descriptor.

getStore

public final String getStore()

Get the name of an engine's ODS store.

setHAPolicy

public final AepEngineDescriptor setHAPolicy(AepEngine.HAPolicy val)

Set an engine's HA policy.

Parameters:: val - The HA policy to set.
Returns:: Returns this for invocation chaining.

getHAPolicy

public final AepEngine.HAPolicy getHAPolicy()

Get an engine's HA policy.

Returns:: Returns the policy.

setReplicationPolicy

public final AepEngineDescriptor setReplicationPolicy(AepEngine.ReplicationPolicy val)

Set an engine's replication policy.

Parameters:: val - The replication policy to set.
Returns:: Returns this for invocation chaining.

getReplicationPolicy

public final AepEngine.ReplicationPolicy getReplicationPolicy()

Get an engine's replication policy.

Returns:: Returns the policy.

setMessagingStartFailPolicy

public final AepEngineDescriptor setMessagingStartFailPolicy(AepEngine.MessagingStartFailPolicy val)

Set an engine's messaging start fail policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getMessagingStartFailPolicy

public final AepEngine.MessagingStartFailPolicy getMessagingStartFailPolicy()

Get an engine's messaging start fail policy.

Returns:: Returns the policy.

setMessageBusBindingFailPolicy

public final AepEngineDescriptor setMessageBusBindingFailPolicy(AepEngine.MessageBusBindingFailPolicy val)

Set an engine's message bus binding fail policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getMessageBusBindingFailPolicy

public final AepEngine.MessageBusBindingFailPolicy getMessageBusBindingFailPolicy()

Get an engine's message bus binding fail policy.

Returns:: Returns the policy.

setInboundMessageLoggingPolicy

public final AepEngineDescriptor setInboundMessageLoggingPolicy(AepEngine.InboundMessageLoggingPolicy val)

Set an engine's inbound message logging policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getInboundMessageLoggingPolicy

public final AepEngine.InboundMessageLoggingPolicy getInboundMessageLoggingPolicy()

Get an engine's message inbound message logging policy.

Returns:: Returns the policy.

setInboundMessageLoggingFailurePolicy

public final AepEngineDescriptor setInboundMessageLoggingFailurePolicy(AepEngine.InboundMessageLoggingFailurePolicy val)

Set an engine's inbound message logging failure policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getInboundMessageLoggingFailurePolicy

public AepEngine.InboundMessageLoggingFailurePolicy getInboundMessageLoggingFailurePolicy()

The engine's inbound message logging failure policy.

When not set this defaults to AepEngine.InboundMessageLoggingFailurePolicy.StopEngine

Returns:: The engine's inbound message logging failure policy.

setInboundMessageLoggingProperty

public final AepEngineDescriptor setInboundMessageLoggingProperty(String name,
                                                                  String val)

Set an engine's inbound message logging property.

Parameters:: name - The name of the property to set.; val - The property value.
Returns:: Returns this for invocation chaining.

getInboundMessageLoggingProperty

public final String getInboundMessageLoggingProperty(String name)

Get an engine's inbound message logging property.

Parameters:: name - The property name
Returns:: Returns the property value.

clearInboundMessageLoggingProperty

public final AepEngineDescriptor clearInboundMessageLoggingProperty(String name)

Clear an engine's inbound message logging property.

Parameters:: name - The name of the property to clear.
Returns:: Returns this for invocation chaining.

setInboundMessageLoggingProperties

public final AepEngineDescriptor setInboundMessageLoggingProperties(Properties val)

Set the set of inbound message logging properties.

Parameters:: val - The property table

getInboundMessageLoggingProperties

public final Properties getInboundMessageLoggingProperties()

Get the set of inbound message logging properties.

Note: The properties object returned is the object maintained by the descriptor. Therefore, inbound message logging properties can be added, removed and/or updated directly in the returned object. For the changes to take effect, the changes must be made before the engine is created.

Returns:: Returns the property table.

setOutboundMessageLoggingPolicy

public final AepEngineDescriptor setOutboundMessageLoggingPolicy(AepEngine.OutboundMessageLoggingPolicy val)

Set an engine's outbound message logging policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getOutboundMessageLoggingPolicy

public final AepEngine.OutboundMessageLoggingPolicy getOutboundMessageLoggingPolicy()

Get an engine's message outbound message logging policy.

Returns:: Returns the policy.

setOutboundMessageLoggingFailurePolicy

public final AepEngineDescriptor setOutboundMessageLoggingFailurePolicy(AepEngine.OutboundMessageLoggingFailurePolicy val)

Set an engine's outbound message logging failure policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getOutboundMessageLoggingFailurePolicy

public AepEngine.OutboundMessageLoggingFailurePolicy getOutboundMessageLoggingFailurePolicy()

The engine's outbound message logging failure policy.

When not set this defaults to AepEngine.OutboundMessageLoggingFailurePolicy.StopEngine

Returns:: The engine's outbound message logging failure policy.

setOutboundMessageLoggingProperty

public final AepEngineDescriptor setOutboundMessageLoggingProperty(String name,
                                                                   String val)

Set an engine's outbound message logging property.

Parameters:: name - The name of the property to set.; val - The property value.
Returns:: Returns this for invocation chaining.

getOutboundMessageLoggingProperty

public final String getOutboundMessageLoggingProperty(String name)

Get an engine's outbound message logging property.

Parameters:: name - The property name
Returns:: Returns the property value.

clearOutboundMessageLoggingProperty

public final AepEngineDescriptor clearOutboundMessageLoggingProperty(String name)

Clear an engine's outbound message logging property.

Parameters:: name - The name of the property to clear.
Returns:: Returns this for invocation chaining.

setOutboundMessageLoggingProperties

public final AepEngineDescriptor setOutboundMessageLoggingProperties(Properties val)

Set the set of outbound message logging properties.

Parameters:: val - The property table

getOutboundMessageLoggingProperties

public final Properties getOutboundMessageLoggingProperties()

Get the set of outbound message logging properties.

Note: The properties object returned is the object maintained by the descriptor. Therefore, outbound message logging properties can be added, removed and/or updated directly in the returned object. For the changes to take effect, the changes must be made before the engine is created.

Returns:: Returns the property table.

setPerTransactionStatsLoggingPolicy

public final AepEngineDescriptor setPerTransactionStatsLoggingPolicy(AepEngine.PerTransactionStatsLoggingPolicy val)

Set an engine's binary transaction stats logging policy.

When getCapturePerTransactionStats() is enabled, this logger is used to write the captured stats to a transaction log.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getPerTransactionStatsLoggingPolicy

public final AepEngine.PerTransactionStatsLoggingPolicy getPerTransactionStatsLoggingPolicy()

Get an engine's binary transaction stats logging policy.

Returns:: Returns the policy.

setPerTransactionStatsLoggingFailurePolicy

public final AepEngineDescriptor setPerTransactionStatsLoggingFailurePolicy(AepEngine.PerTransactionStatsLoggingFailurePolicy val)

Set an engine's binary transaction stats logging failure policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getPerTransactionStatsLoggingFailurePolicy

public AepEngine.PerTransactionStatsLoggingFailurePolicy getPerTransactionStatsLoggingFailurePolicy()

The engine's binary transaction stats logging failure policy.

When not set this defaults to AepEngine.PerTransactionStatsLoggingFailurePolicy.StopEngine

Returns:: The engine's binary transaction stats message logging failure policy.

setPerTransactionStatsLoggingProperty

public final AepEngineDescriptor setPerTransactionStatsLoggingProperty(String name,
                                                                       String val)

Set an engine's per transaction stats message logging property.

Parameters:: name - The name of the property to set.; val - The property value.
Returns:: Returns this for invocation chaining.

getPerTransactionStatsLoggingProperty

public final String getPerTransactionStatsLoggingProperty(String name)

Get an engine's per transaction stats message logging property.

Parameters:: name - The property name
Returns:: Returns the property value.

clearPerTransactionStatsLoggingProperty

public final AepEngineDescriptor clearPerTransactionStatsLoggingProperty(String name)

Clear an engine's per transaction stats message logging property.

Parameters:: name - The name of the property to clear.
Returns:: Returns this for invocation chaining.

setPerTransactionStatsLoggingProperties

public final AepEngineDescriptor setPerTransactionStatsLoggingProperties(Properties val)

Set the value of a per transaction stats logging properties.

Parameters:: val - The property table

getPerTransactionStatsLoggingProperties

public final Properties getPerTransactionStatsLoggingProperties()

Gets an aep engine's per transaction stats logging properties.

Note: The properties object returned is the object maintained by the descriptor. Therefore, transaction stats logging properties can be added, removed and/or updated directly in the returned object. For the changes to take effect, the changes must be made before the engine is created.

Returns:: Returns the property table.

setMessageHandlingPolicy

public final AepEngineDescriptor setMessageHandlingPolicy(AepEngine.MessageHandlingPolicy val)

Set an engine's message handling policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.
Note: The message handling policy is for internal testing purposes only. An application should never have any need to change it

getMessageHandlingPolicy

public final AepEngine.MessageHandlingPolicy getMessageHandlingPolicy()

Get an engine's message handling policy.

Returns:: Returns the policy.

setMessageSendPolicy

@Deprecated
public final AepEngineDescriptor setMessageSendPolicy(AepEngine.MessageSendPolicy val)

Deprecated. The message send policy has been deprecated. This method is a noop. AEP engines will always function with ReplicateBeforeSend

Set an engine's message send policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getMessageSendPolicy

@Deprecated
public final AepEngine.MessageSendPolicy getMessageSendPolicy()

Deprecated. The message send policy has been deprecated. This method will always return AepEngine.MessageSendPolicy.ReplicateBeforeSend

Get an engine's message send policy.

Returns:: Returns the policy.

setAppExceptionHandlingPolicy

public final AepEngineDescriptor setAppExceptionHandlingPolicy(AepEngine.AppExceptionHandlingPolicy val)

Set an engine's application exception handling policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getAppExceptionHandlingPolicy

public final AepEngine.AppExceptionHandlingPolicy getAppExceptionHandlingPolicy()

Get an engine's application exception handling policy.

Returns:: Returns the policy.

setMessageSendExceptionHandlingPolicy

public final AepEngineDescriptor setMessageSendExceptionHandlingPolicy(AepEngine.MessageSendExceptionHandlingPolicy val)

Set an engine's message send exception handling policy.

Parameters:: val - The policy to set.
Returns:: Returns this for invocation chaining.

getMessageSendExceptionHandlingPolicy

public final AepEngine.MessageSendExceptionHandlingPolicy getMessageSendExceptionHandlingPolicy()

Get an engine's message send exception handling policy.

Returns:: Returns the policy.

setEventMultiplexerType

public final AepEngineDescriptor setEventMultiplexerType(AepEngine.EventMultiplexerType val)

Set an engine's event multiplexer type.

Parameters:: val - The type to set.
Returns:: Returns this for invocation chaining.

getEventMultiplexerType

public final AepEngine.EventMultiplexerType getEventMultiplexerType()

Get an engine's event multiplexer type.

Returns:: Returns the type.

setEventMultiplexerProperty

public final AepEngineDescriptor setEventMultiplexerProperty(String name,
                                                             String val)

Set an engine's event multiplexer property.

Parameters:: name - The name of the property to set.; val - The property value.
Returns:: Returns this for invocation chaining.

getEventMultiplexerProperty

public final String getEventMultiplexerProperty(String name)

Get an engine's event multiplexer property.

Parameters:: name - The property name
Returns:: Returns the property value.

clearEventMultiplexerProperty

public final AepEngineDescriptor clearEventMultiplexerProperty(String name)

Clear an engine's event multiplexer property.

Parameters:: name - The name of the property to clear.
Returns:: Returns this for invocation chaining.

setEventMultiplexerProperties

public final AepEngineDescriptor setEventMultiplexerProperties(Properties val)

Set the set of event multiplexer properties.

Parameters:: val - The property table

getEventMultiplexerProperties

public final Properties getEventMultiplexerProperties()

Get the set of event multiplexer properties.

Returns:: Returns the property table.
Note: The properties object returned is the object maintained by the descriptor. Therefore, event multiplexer properties can be added, removed and/or updated directly in the returned object. For the changes to take effect, the changes must be made before the engine is created.

setStartupExpectation

public final AepEngineDescriptor setStartupExpectation(AepEngine.StartupExpectation expectation, Enum<?> val)

Set an engine's startup expectation.

Parameters:
expectation - The expectation.
val - The expectation value.
Returns:
Returns this for invocation chaining.

getStartupExpectation

public final Enum<?> getStartupExpectation(AepEngine.StartupExpectation expectation)

Get an engine's startup expectation.

Parameters:
expectation - The expectation to get
Returns:
Returns the expectation value.

clearStartupExpectation

public final AepEngineDescriptor clearStartupExpectation(AepEngine.StartupExpectation expectation)

Clear an engine's startup expectation.

Parameters:
expectation - The expectation to clear.
Returns:
Returns this for invocation chaining.

setStartupExpectations

public final AepEngineDescriptor setStartupExpectations(Map<AepEngine.StartupExpectation,Enum<?>> val)

Set the set of an engine's startup expectations.

Parameters:
val - The property table

getStartupExpectations

public final Map<AepEngine.StartupExpectation,Enum<?>> getStartupExpectations()

Get the set of an engine's startup expectations.

Returns:
Returns the map of startup expectations.
Note: The map returned is the map maintained by the descriptor. Therefore, startup expectations can be added, removed and/or updated directly in the returned map. For the changes to take effect, the changes must be made before the engine is created.

setAdaptiveCommitBatchCeiling

public final AepEngineDescriptor setAdaptiveCommitBatchCeiling(int val)

Set the adaptive commit batch ceiling.

Parameters:
val - The ceiling to set. A value <=0 disables adaptive commit batch sizing.
Returns:
Returns this for invocation chaining.

getAdaptiveCommitBatchCeiling

public final int getAdaptiveCommitBatchCeiling()

Get an engine's adaptive commit batch ceiling.

Returns:
Returns the policy.

setDispatchTransactionStageEvents

public final AepEngineDescriptor setDispatchTransactionStageEvents(boolean val)

Set whether transaction stage events should dispatched.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.

getDispatchTransactionStageEvents

public final boolean getDispatchTransactionStageEvents()

Get whether an engine will dispatch transaction stage events.

Returns:
Returns whether the engine dispatches transaction stage events.

setEnableTransactionCommitSuspension

public final AepEngineDescriptor setEnableTransactionCommitSuspension(boolean val)

Set whether transaction commit suspension is enabled or disabled.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.

getEnableTransactionCommitSuspension

public final boolean getEnableTransactionCommitSuspension()

Get whether transaction commit suspension is enabled in an engine.

Returns:
Returns whether transaction commits can be suspended.

getEnableTransactionSavepoints

public final boolean getEnableTransactionSavepoints()

Gets whether or not transaction savepoints are enabled for the engine.
Transaction savepoints allow an application to create savepoints and rollback work done in message handlers to that save point.
When transaction savepoints are not enabled, application calls to create savepoints or rollback to savepoints will result in an IllegalStateException.

Returns:
Whether or not transaction savepoints are enabled.
See Also:
AepEngine.createTransactionSavepoint(), AepEngine.rollbackToTransactionSavepoint(int)

setEnableTransactionSavepoints

public final void setEnableTransactionSavepoints(boolean enableTransactionSavepoints)

Sets whether or not transaction savepoints are enabled for the engine.
Enabling of transaction savepoints introduces a small amount of overhead in the engine. It is only recommended that it be enabled for applications that need it.

Parameters:
enableTransactionSavepoints - Whether or not transaction savepoints are enabled.
See Also:
AepEngine.createTransactionSavepoint(), AepEngine.rollbackToTransactionSavepoint(int)

setReplicateSolicitedSends

public final AepEngineDescriptor setReplicateSolicitedSends(boolean val)

Set whether to replicate solicited sends.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.
This parameter governs whether solicited sends (sends triggered by the processing of inbound messages) performed on clustered State Replication engines will be replicated or not. This setting has no effect on Event Sourced engines or engines that are not clustered.

Note: This parameter should be changed with extreme caution. The act of disabling replication of outbound messages will likely result in a loss of outbound messages in the event of a fail over.

This parameter is only applicable to State Replicated engines. The default value for this parameter is true.

getReplicateSolicitedSends

public final boolean getReplicateSolicitedSends()

Get whether to replicate solicited sends.

Returns:
Returns whether solicited sends are replicated.

setReplicateUnsolicitedSends

public final AepEngineDescriptor setReplicateUnsolicitedSends(boolean val)

Set whether to replicate unsolicited sends.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.
This parameter governs whether unsolicited sends performed on clustered State Replication engines will be replicated or not. This setting has no effect on Event Sourced engines or engines that are not clustered.

This parameter is only applicable to State Replicated engines. The default value for this parameter is false.

getReplicateUnsolicitedSends

public final boolean getReplicateUnsolicitedSends()

Get whether to replicate unsolicited sends.

Returns:
Returns whether unsolicited sends are replicated.

setSequenceUnsolicitedSends

public final AepEngineDescriptor setSequenceUnsolicitedSends(boolean val)

Set whether to sequence unsolicited sends.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.
By default, unsolicited sends are sent with a sequence number of 0. Specifying true in this parameter will cause sequence numbers to be attached to unsolicited sends too.

Note: Be careful about attaching sequence numbers to unsolicited sends especially if the application is going to be doing both unsolicited and solicited sends concurrently since that can cause messages to be sent on the wire in a sequence different from the sequence in which sequence numbers were assigned to the message thus causing legitimate messages to be dropped due to incorrect duplicate determination. For such applications, use sequenceSolicitedWithUnsolicitedSends instead to ensure that not only are unsolicited sends sequenced but that they are also correctly sequenced vis-a-vis solicited sends.

The default value for this parameter is false.

getSequenceUnsolicitedSends

public final boolean getSequenceUnsolicitedSends()

Get whether unsolicited sends are sequenced.

Returns:
Returns whether unsolicited sends are sequenced.

setClusterHeartbeatInterval

public final AepEngineDescriptor setClusterHeartbeatInterval(int val)

Set the cluster heartbeat interval (in milliseconds). When replicating message and state to its cluster peers, the AepEngine piggybacks internal state such as outbound message acknowledgements and other internal control data. Setting a cluster heartbeat interval can be useful for low throughput applications to keep the backup in closer sync to the primary. The most common use case for setting this would be to reduce the number of in doubt messages outstanding in backup peers to a window. A value of 0 (default) disables the cluster heartbeat interval.

Parameters:
val - The interval in milliseconds
Returns:
Returns this for invocation chaining.
The default value for this parameter is 0 (i.e. cluster heartbeats are off).

getClusterHeartbeatInterval

public final int getClusterHeartbeatInterval()

Get the cluster heartbeat interval

setSequenceUnsolicitedWithSolicitedSends

public final AepEngineDescriptor setSequenceUnsolicitedWithSolicitedSends(boolean val)

Set whether to sequence unsolicited sends with solicited sends.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.
This parameter is applicable for applications performing concurrent solicited and unsolicited sends and want the unsolicited sends to be sequenced. Setting this parameter ensures that unsolicited and solicited sends are sequenced on the wire in the same order in which the sequence numbers were attached to the messages.

The default value for this parameter is false.

getSequenceUnsolicitedWithSolicitedSends

public final boolean getSequenceUnsolicitedWithSolicitedSends()

Get whether unsolicited sends are sequenced with solicited sends.

Returns:
Returns whether unsolicited sends are sequenced with solicited sends.

setDisposeOnSend

public final AepEngineDescriptor setDisposeOnSend(boolean val)

Set whether to automatically dispose sent messages.

Parameters:
val - The value to set.
Returns:
Returns this for invocation chaining.
If set, then the AepEngine.sendMessage(com.neeve.sma.MessageChannel, com.neeve.rog.IRogMessage, java.util.Properties) method will dispose a message after it has been sent. This means that the caller must not hold onto or reference a message beyond the call to the send message method.

The default value for this parameter is true.

getDisposeOnSend

public final boolean getDisposeOnSend()

Get whether AepEngine.sendMessage(com.neeve.sma.MessageChannel, com.neeve.rog.IRogMessage, java.util.Properties) disposes sent messages.

setQuarantineChannel

public final AepEngineDescriptor setQuarantineChannel(String val)

Set an engine's quarantine channel.
This method sets the channel on which quarantined messages are transmitted. This applies when the application throws an exception and the application exception policy is configured to be 'quarantine and stop' i.e. (AepEngine.AppExceptionHandlingPolicy.QuarantineAndStop)

Parameters:
val - The channel name to set as the quarantine channel.
Returns:
Returns this for invocation chaining.

getQuarantineChannel

public final String getQuarantineChannel()

Get an engine's quarantine channel

Returns:
Returns the quarantine channel and null if not set.

setQuarantineMessageKey

public final AepEngineDescriptor setQuarantineMessageKey(String val)

Set an engine's quarantine message key.

Parameters:
val - The channel name to set as the quarantine channel.
Returns:
Returns this for invocation chaining.
This method is used to explicitly set the message key to be associated with outbound quarantine messages. If the key is set using this method, the sending of the quarantine message will bypass the dynamic key resolution machinery.

getQuarantineMessageKey

public final String getQuarantineMessageKey()

Get an engine's quarantine message key.

Returns:
Returns the quarantine message key and null if not set.

setAdministrative

public final AepEngineDescriptor setAdministrative(boolean val)

Set whether an engine is an administrative engine.

Returns:
Returns this for invocation chaining.
Engines designated as administratibve engines are not subject to auto performance tuning.

getAdministrative

public final boolean getAdministrative()

Get whether an engine is an administrative enginel

setStuckAlertEventThreshold

public final AepEngineDescriptor setStuckAlertEventThreshold(int thresholdSeconds)

Defines the threshold, in seconds, after which an AepStuckAlertEvent is dispatched to the application's IAepAsynchronousEventHandler.
An AepStuckAlertEvent event is intended to alert that the engine's transaction pipeline is "stuck" i.e. there are one or more transaction commits in the pipeline and the event multiplexer thread is not processing any events. For example, the event multiplexer thread could be flow controlled on the replication TCP connection due to an issue in the backup or could be spinning in a loop in the business logic due to a bug in a business logic handler. This event triggered by the AEP engine under the following conditions:

There are > 0 commits in the engine's commit pipeline

The number of commits in the pipeline has not changed for a configurable period of time

A message or event handler is hung and preventing the engine from processing further events

Parameters:
thresholdSeconds - A positive value indicates the time in seconds that the engine must be stuck before an event is issued.
See Also:
IAepAsynchronousEventHandler, AepEngine.setAsynchronousEventHandler(IAepAsynchronousEventHandler)

getStuckAlertEventThreshold

public final int getStuckAlertEventThreshold()

Get's the engine stuck alert event threshold.

Returns:
The stuck event alert threshold
See Also:
setStuckAlertEventThreshold(int)

setPerformDuplicateChecking

public final AepEngineDescriptor setPerformDuplicateChecking(boolean val)

Set whether the engine should perform duplicate checking
When duplicate checking is enabled received messaegs that are deemed duplicates are discarded by the engine. A message is considered to be a duplicate if:

The message has a sequence number that is greater than 1.
The sequence number is less than the last received sequence number for the flowId and senderId in the message.
A sequence number of 1 is interpreted as a restart of a messaging stream. A value of 0 or less means the message is not sequenced and will ignored for duplicate checks.
Sequence id assignment by an AepEngine

MessageSender: Is assigned by the AepEngine using the hashcode of the engine name.
MessageFlow: Leaves flow unset as 0 (default). At present it is not recommended for applications to set a flow.
MessageSequenceNumber: Set for each send from a event handler by incrementing a sequence number or for each unsolicited send (outside of a event handler) when sequenceUnsolicitedSends is true.

Default Value: Value of AepConstants.PERFORM_DUPLICATE_CHECKING_PROPNAME property

See Also:
MessageView.getMessageSender(), MessageView.getMessageSequenceNumber(), MessageView.getMessageFlow(), getSequenceUnsolicitedSends()

getPerformDuplicateChecking

public final boolean getPerformDuplicateChecking()

Get whether an engine is configured to perform duplicate checking

See Also:
setPerformDuplicateChecking(boolean)

setPerformMidstreamInitializationValidation

public final AepEngineDescriptor setPerformMidstreamInitializationValidation(boolean val)

Set whether the engine checks that initial transactions are not missing during recovery or replication in Event Sourced engines.
Can be set to false to disable the validation check that when operating with HA Policy of EventSourcing that the the first replayed transaction has an id of 2 (e.g. 1 plus the engine's initial transaction id of 1).
It is not recommended that you disable this check unless it recommended that you do so by Neeve support.
Default Value: Value of AepConstants.PERFORM_MIDSTREAMINIT_VALIDATION_PROPNAME property

getPerformMidstreamInitializationValidation

public final boolean getPerformMidstreamInitializationValidation()

Get whether the engine checks that initial transactions are not missing during recovery or replication in Event Sourced engines.

See Also:
setPerformMidstreamInitializationValidation(boolean)

setEnableSequenceNumberTrace

public final AepEngineDescriptor setEnableSequenceNumberTrace(boolean val)

Enable diagnostic trace logging related to message sequencing.
Enabling this can assist in diagnosing issues related to the loss, duplicate or out of order events.
When enabled trace will be emitted at debug level to the logger named 'nv.aep.sno'.
It is often times useful to enable this tracing in concert with event and transaction tracing (see setEnableTransactionTrace(boolean) and setEnableEventTrace(boolean))
Default Value: Value of AepConstants.ENABLE_SEQUENCENUMBER_TRACE_PROPNAME property

getEnableSequenceNumberTrace

public final boolean getEnableSequenceNumberTrace()

Get whether diagnostic trace logging related to message sequencing is enabled.

See Also:
setEnableSequenceNumberTrace(boolean)

setEnableEventTrace

public final AepEngineDescriptor setEnableEventTrace(boolean val)

Enable diagnostic trace logging of events received and dispatched by an engine
Enabling this is useful in determining the sequence of events processed by the engine
When enabled trace will be emitted at debug level to the logger named 'nv.aep.event'.
It is often times useful to enable this tracing in concert with transaction and sequence number tracing (see setEnableTransactionTrace(boolean) and setEnableSequenceNumberTrace(boolean))
Default Value: Value of AepConstants.ENABLE_EVENT_TRACE_PROPNAME property

getEnableEventTrace

public final boolean getEnableEventTrace()

Get whether diagnostic trace logging related to engine events is enabled.

See Also:
setEnableEventTrace(boolean)

setEnableTransactionTrace

public final AepEngineDescriptor setEnableTransactionTrace(boolean val)

Enable diagnostic trace logging related to transactions processed by an engine.
Enabling this is useful in determining the relative sequencing and timing of a transaction commit as the commit proceeds to completion
When enabled trace will be emitted at debug level to the logger named 'nv.aep.txn'.
It is often times useful to enable this tracing in concert with sequence number and event tracing (see setEnableEventTrace(boolean) and setEnableSequenceNumberTrace(boolean))
Default Value: Value of AepConstants.ENABLE_TRANSACTION_TRACE_PROPNAME property

getEnableTransactionTrace

public final boolean getEnableTransactionTrace()

Get whether diagnostic trace logging related to engine transactions is enabled.

See Also:
setEnableTransactionTrace(boolean)

setEnableScheduleTrace

public final AepEngineDescriptor setEnableScheduleTrace(boolean val)

Enable diagnostic trace logging related to schedules managed by an engine.
Enabling this is useful for diagnosing issues related to timer execution and scheduling
When enabled trace will be emitted at debug level to the logger named 'nv.aep.sched'.
Default Value: Value of AepConstants.ENABLE_SCHEDULE_TRACE_PROPNAME property

getEnableScheduleTrace

public final boolean getEnableScheduleTrace()

Get whether diagnostic trace logging related to engine schedules is enabled.

See Also:
setEnableScheduleTrace(boolean)

setEnableMessageTrace

public final AepEngineDescriptor setEnableMessageTrace(boolean val)

Enable diagnostic trace logging for messages.
When enabled, messages and Entities will be traced at debug level to the tracer named 'nv.aep.msg' at the following points:

[MSG-IN]: When a message is received by the AepEngine.
[MSG-PER]: or an outbound

When an inbound message is logged to an inbound messages persister.
When an outbound message is logged to an outbound messages persister.
message is logged to an outbound message
[MSG-REPL-OUT]:

When an inbound message is replicated for (for AepEngine.HAPolicy.EventSourcing).
When an outbound message is replicated (for AepEngine.HAPolicy.StateReplication).
An environment change provider replicates an environment change message.

[MSG-OUT]: When an outbound message is sent.
[MSG-OUT-Q]: When an outbound message is queued in the in doubt redelivery queueu on a backup.
[MSG-REPL-IN]: When a message is received by an engine that is a backup or recovering from a transaction log.
[OBJ-ADD-IN]: When a new entity is received by an engine that is a backup or recovering from a transaction.
[OBJ-UPD-IN]: When an entity has been updated fro engine that is a backup or recovering from a transaction.
[OBJ-REM-IN]: When an entity has been removed fro engine that is a backup or recovering from a transaction.

Default Value: Value of AepConstants.ENABLE_MESSAGE_TRACE_PROPNAME property

getEnableMessageTrace

public final boolean getEnableMessageTrace()

Get whether diagnostic trace logging for messages is enabled

See Also:
setEnableMessageTrace(boolean)

setMessageTraceInJson

public final AepEngineDescriptor setMessageTraceInJson(boolean val)

Sets whether messages are traced in Json or toString format.
When set to true The message will be printed in Json format, otherwise message will be traced using its toString method.
Default Value: Value of AepConstants.MESSAGE_TRACE_IN_JSON_PROPNAME property

getMessageTraceInJson

public final boolean getMessageTraceInJson()

Get whether messages are traced in Json or toString

See Also:
setMessageTraceInJson(boolean)

setMessageTraceJsonStyle

public final AepEngineDescriptor setMessageTraceJsonStyle(RogLogUtil.JsonPrettyPrintStyle val)

Set the styling of Json formatted message trace.
Default Value: Value of AepConstants.MESSAGE_TRACE_JSONSTYLE_PROPNAME property

getMessageTraceJsonStyle

public final RogLogUtil.JsonPrettyPrintStyle getMessageTraceJsonStyle()

Get the styling of Json formated message trace.

See Also:
setMessageTraceJsonStyle(com.neeve.rog.log.RogLogUtil.JsonPrettyPrintStyle)

setMessageTraceMetadataDisplayPolicy

public final AepEngineDescriptor setMessageTraceMetadataDisplayPolicy(RogLogUtil.MetadataDisplayPolicy val)

Set whether metadata, payload or both will be traced when message trace logging is enabled.
To display only the payload use a value of "Off", to display both metadata and payload use "On". The default behavior ("Only") is to log only metadata.
Default Value: Value of AepConstants.MESSAGE_TRACE_METADATA_DISPLAY_PROPNAME property

See Also:
AepConstants.ENABLE_MESSAGE_TRACE_PROPNAME, RogLogUtil.MetadataDisplayPolicy

getMessageTraceMetadataDisplayPolicy

public final RogLogUtil.MetadataDisplayPolicy getMessageTraceMetadataDisplayPolicy()

Get whether metadata, payload or both will be traced when message trace logging is enabled.

See Also:
setMessageTraceMetadataDisplayPolicy(com.neeve.rog.log.RogLogUtil.MetadataDisplayPolicy)

setMessageTraceFilterUnsetFields

public final AepEngineDescriptor setMessageTraceFilterUnsetFields(boolean val)

Set whether unset fields are filtered for json formatted objects when json message tracing is enabled.
Default Value: Value of AepConstants.FILTER_UNSET_FIELDS_IN_MESSAGE_TRACE_PROPNAME property

getMessageTraceFilterUnsetFields

public final boolean getMessageTraceFilterUnsetFields()

Get whether unset fields are filtered for json formatted objects when json message tracing is enabled.

See Also:
setMessageTraceFilterUnsetFields(boolean)

setMaxEnvironmentProviders

public final AepEngineDescriptor setMaxEnvironmentProviders(int val)

Set the maximum number of environment providers that can be registered with the engine.
Default Value: Value of AepConstants.MAX_ENVIRONMENTPROVIDERS_PROPNAME property

getMaxEnvironmentProviders

public final int getMaxEnvironmentProviders()

Get the maximum number of environment providers that can be registered with the engine.

See Also:
setMaxEnvironmentProviders(int)

setEnableSendCommitCompleteSequenceAlerts

public final AepEngineDescriptor setEnableSendCommitCompleteSequenceAlerts(boolean val)

Set whether or not to enable out of order send commit completion detection.
When enabled the engine will enable checks that stability events are received in an ordered fashion from bus bindings. If send commit completions occur out of order, then AepOutOfOrderSendCommitCompletionAlertEvent events will be dispatched.
There are many cases where it is permissible for commit completions to come back out of order with respect to the order in which the sends in the transaction were completed. When enabled out of order send commit completion checking attempts to take into account cases where transaction T(2) can complete before transact a previous transaction T(1) such as:

T(1) and T(2) send on different buses and T(2)'s bus is faster.
T(2) had no outbound sends while T(1) did.
T(2) used BestEffort messaging while T(1) used Guaranteed.
The bus implementation doesn't guarantee ordered send commit completion.
An AepEngine is tolerant of out of order send commit completions, and ensures that transactions are completed in a sequential order, so an out of order send commit completion is not itself a problem. However, if, in our examples above T(2) completes before T(1), and T(1) never completes it would be a problem since it also means that T(2) will never complete. Enabling out of order send commit completions can in such cases provide a hint that there may be something wrong with the message bus binding.
Enabling out of order send commit completions is not recommended for normal operation, the checks are costly, and a lost send commit completion can be better reported using aep engine stuck alerts (see setStuckAlertEventThreshold(int)).
Default Value: Value of AepConstants.ENABLE_SENDCOMMITCOMPLETE_SEQUENCEALERTS_PROPNAME property

getEnableSendCommitCompleteSequenceAlerts

public final boolean getEnableSendCommitCompleteSequenceAlerts()

Get whether or not to enable out of order send commit completion detection.

See Also:
setEnableSendCommitCompleteSequenceAlerts(boolean)

setSetInboundMessagesAsReadOnly

public final AepEngineDescriptor setSetInboundMessagesAsReadOnly(boolean val)

Set whether inbound messages are marked as read only on receipt.
By contract it is illegal for an application to modify an inbound message and this policy is enforced by the AepEngine when message events are received.
Setting this propery to false prevents the engine from marking inbound messages as read only, but does not make modifying the message a supported operation. Modifying a received message can severely compromise the recovery and stability of the application, and would only be advisable in extreme cases or for testing purposes when recommended by Neeve support.
Default Value: Value of AepConstants.SET_INBOUNDMESSAGE_ASREADONLY_PROPNAME property

getSetInboundMessagesAsReadOnly

public final boolean getSetInboundMessagesAsReadOnly()

Get whether inbound messages are marked as read only on receipt.

See Also:
setSetInboundMessagesAsReadOnly(boolean)

setSetOutboundMessagesAsReadOnly

public final AepEngineDescriptor setSetOutboundMessagesAsReadOnly(boolean val)

Set whether outbound messages are marked as read only on send.
By contract it is illegal for an application to modify an outbound message after it has been sent..
Setting this propery to false prevents the engine from marking outbound messages as read only, but does not make modifying the message a supported operation. Modifying an output message can severely compromise the recovery and stability of the application, and would only be advisable in extreme cases or for testing purposes when recommended by support.
Default Value: Value of AepConstants.SET_OUTBOUNDMESSAGE_ASREADONLY_PROPNAME property

getSetOutboundMessagesAsReadOnly

public final boolean getSetOutboundMessagesAsReadOnly()

Get whether outbound messages are marked as read only on send.

See Also:
setSetInboundMessagesAsReadOnly(boolean)

setCaptureMessageTypeStats

public final AepEngineDescriptor setCaptureMessageTypeStats(boolean val)

Set whether stats are additionally recorded ona per message type basis.
Can be enabled on an engine by engine basis using 'nv.aep.{enginename}.msgtype.stats' where {enginename} is replaced by the name of the engine as specified in its AepEngineDescriptor.
Collection of message type specific stats records counts and rates per type as well as message processing time stats for each message which can be useful in finding particular handlers that have high execution times.
Default Value: Value of AepConstants.CAPTURE_MSGTYPE_STATS_PROPNAME property

getCaptureMessageTypeStats

public final boolean getCaptureMessageTypeStats()

Get whether stats are additionally recorded ona per message type basis.

See Also:
setCaptureMessageTypeStats(boolean)

setCaptureTransactionLatencyStats

public final AepEngineDescriptor setCaptureTransactionLatencyStats(boolean val)

Set whether or not the engine records transaction latency stats.
Can be enabled on an engine by engine basis using 'nv.aep.{enginename}.latency.stats' where {enginename} is replaced by the name of the engine as specified in its AepEngineDescriptor. When enabled the following stats are recorded and made available in IAepEngineStats:

mpproc
mproc
msend
msendc
cstart
cprolo
csend]
ctrans
cstore
cepilo
cfull
tleg1
tleg2
tleg3
inout
inack

IAepEngineStats can be traced by enabling or stats can be collected by a Talon Server. Default Value: Value of AepConstants.CAPTURE_TRANSACTION_LATENCY_STATS_PROPNAME property

getCaptureTransactionLatencyStats

public final boolean getCaptureTransactionLatencyStats()

Get whether or not the engine records transaction latency stats.

See Also:
setCaptureTransactionLatencyStats(boolean)

setCapturePerTransactionStats

public final AepEngineDescriptor setCapturePerTransactionStats(boolean val)

Sets whether or not the engine record per transaction stats.
Unlike captureTransactionLatencyStats which records histographical latencies, this setting is much more expensive in that it records and emits individual timestamps for operations that occured in the transaction including store commit timestamps and individual message timestamps.

In most cases the capturing this level of detail is not worth the overhead it incurrs, as the histographical latency captured via captureTransactionLatencyStats is usually sufficient for inferring timings within a given sampling interval. However, in cases where it is critical to determine the exact timings of transaction processing to better understand product behavior it can be useful.

If used in production (which is not recommended), applications should undergo stress testing under maximum peak load to determine the impact of enabling collection of per transaction timings.

This feature is classified as an expiremental feature and is subject to change or be removed without notice

getCapturePerTransactionStats

public final boolean getCapturePerTransactionStats()

Get whether or not the engine records transaction timing stats.

See Also:
setCapturePerTransactionStats(boolean)

setCaptureEventLatencyStats

public final AepEngineDescriptor setCaptureEventLatencyStats(boolean val)

Set whether event processing latencies are captured.
Can be enabled on an engine by engine basis using 'nv.aep.{enginename}.msgtype.stats' where {enginename} is replaced by the name of the engine as specified in its AepEngineDescriptor.
Capture event latency stats is useful in determining the amount of time spent by the engine's dispatch thread processing non message events.
Default Value: Value of AepConstants.CAPTURE_EVENT_LATENCY_STATS_PROPNAME property

getCaptureEventLatencyStats

public final boolean getCaptureEventLatencyStats()

Get whether event processing latencies are captured.

See Also:
setCaptureEventLatencyStats(boolean)

setReplicateInParallel

public final AepEngineDescriptor setReplicateInParallel(boolean val)

Enable parallel replication
When parallel replication is enabled, the engine replicates inbound messages to the cluster backups in parallel with the processing of the message by the message handler. This parameter only applies to Event Sourced engines

getReplicateInParallel

public final boolean getReplicateInParallel()

Get whether parallel replication is enabled

getPreserveChannelJoinsOnStop

public final boolean getPreserveChannelJoinsOnStop()

Gets whether or not joined channels are preserved on clean shutdown.

Returns:
false to 'leave' channels on clean stop.

setPreserveChannelJoinsOnStop

public final AepEngineDescriptor setPreserveChannelJoinsOnStop(boolean preserveChannelJoinsOnStop)

Sets whether or not to preserve joined channels when the engine stops normally.
By default when an engine is stopped without an error bus channels that were 'joined' will be 'left' meaning that any subscriptions or interests created by the message bus will be unsubscribed or unregistered. Setting this value to true causes the engine to preserve channel interest even on a clean shutdown.
Note that this property has no effect for the case where an engine shuts down with an error (e.g. AepEngine.stop(Exception) with a non null cause. In this case channel joins are left in tact allowing a backup to take over.
Note that this behavior can be overridden programatically on a case by case basis by a handler for AepEngineStoppingEvent setting AepEngineStoppingEvent.setPreserveChannelJoins(boolean),

Parameters:
preserveChannelJoinsOnStop - Indicates whether or not to preserve joined channel subscriptions on a normal stop.
Returns:
This descriptor for invocation chaining.
See Also:
AepEngineStoppingEvent.setPreserveChannelJoins(boolean)

setSetSupportMetadata

public final AepEngineDescriptor setSetSupportMetadata(boolean val)

Set whether support related metadata is set by the engine on inbound and outbound messages.
Setting this property to false prevents the engine from setting support related metadata on inbound and outbound messages. Support related metadata is not critical to the operation of the engine but is useful information set by the engine that can aid in support, reporting and troubleshooting activities since the metadata is persisted in the transaction log.
Default Value: Value of AepConstants.SET_SUPPORT_METADATA_PROPNAME property

getSetSupportMetadata

public final boolean getSetSupportMetadata()

Get whether inbound messages are marked as read only on receipt.

See Also:
setSetSupportMetadata(boolean)

setSetOutboundSequenceNumbers

public final AepEngineDescriptor setSetOutboundSequenceNumbers(boolean val)

Set whether support sequence numbers are set by the engine on outbound messages
Setting this property to false prevents the engine from setting sequence numbers on outbound messages. This is beneficial for very latency sensitive applications but comes at the cost that messages sent by such configured engines will not be checked for duplicates by downstream receiving applications.
Default Value: Value of AepConstants.SET_OUTBOUND_SEQUENCE_NUMBERS_PROPNAME property

getSetOutboundSequenceNumbers

public final boolean getSetOutboundSequenceNumbers()

Get whether sequence numbers are set on outbound messages

See Also:
setSetOutboundSequenceNumbers(boolean)

getInboundEventAcknowledgementPolicy

public final AepEngine.InboundEventAcknowledgementPolicy getInboundEventAcknowledgementPolicy()

Gets the AepEngine's AepEngine.InboundEventAcknowledgementPolicy.

Returns:
the InboundEventAcknowledgementPolicy for the engine.
See Also:
AepEngine.InboundEventAcknowledgementPolicy

setInboundEventAcknowledgementPolicy

public final AepEngineDescriptor setInboundEventAcknowledgementPolicy(AepEngine.InboundEventAcknowledgementPolicy policy)

Set's the policy controlling when inbound events processed by an the application are acnowledged upstream.
Note this is an experimental setting. It should not be set in production without guidance from Neeve support.
The general contract of an AepEngine is that it cannot acknowledge up stream events (such as message events) in a transaction until such as the transaction has been stabilized to the point that in the event of a failure the message will not be lost.
When the engine is not configured with a store this property has no effect and events are acknowledged when the entire transaction is committed (e.g. when downstream acknowledgements are received.)

Parameters:
policy - the InboundEventAcknowledgementPolicy for the engine.
Returns:
This descriptor for invocation chaining.

getSyncInjectedMessages

public final boolean getSyncInjectedMessages()

Gets whether MessageView.sync() is called during AepEngine.injectMessage(com.neeve.rog.IRogMessage).

Returns:
Whether or not messages will be synced in the inject method.
See Also:
setSyncInjectedMessages(boolean)

setSyncInjectedMessages

public final void setSyncInjectedMessages(boolean syncInjectedMessages)

Sets whether MessageView.sync() is called during AepEngine.injectMessage(com.neeve.rog.IRogMessage).
When using Event Sourcing or inbound message logging injected messages injected messages may be replicated and/or persisted to disk. To do so means that the contents of the message must be synced. By doing sync() during the inject call, it can save the engine's processor thread cpu cycles.

Parameters:
syncInjectedMessages - True to enable sync on message injection.

save

public final void save(IConfigRepository repo) throws EAepException

Save a AEP engine descriptor to a configuration repository.

Parameters:
repo - The configuration respository to save the descriptor to.
Throws:
EAepException - Thrown in case an error in encountered while saving the descriptor.
Threading:

This method is notsafe for concurrent access by multiple threads.
This method saves an AEP engine descriptor to a configuration repository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered by this class.

save

public final void save() throws EAepException

Save an AEP engine descriptor to the default configuration repository.

Throws:
EAepException
Threading:

This method is notsafe for concurrent access by multiple threads.
This method saves an AEP engine descriptor to the default configuration respository. The descriptor is saved in a format suitable for loading subsequently using any of the load methods offered in this class.

delete

public final void delete(IConfigRepository repo) throws EAepException

Delete an AEP engine descriptor from a configuration repository.

Parameters:
repo - The configuration respository to delete the descriptor from.
Throws:
EAepException - Thrown in case an error in encountered during the deletion of the descriptor.
Threading:

This method is notsafe for concurrent access by multiple threads.
This method permanently deletes an AEP engine descriptor from a configuration repository.

delete

public final void delete() throws EAepException

Delete an AEP engine descriptor from the default configuration repository.

Throws:
EAepException - Thrown in case an error in encountered during the deletion of the descriptor.
Threading:

This method is notsafe for concurrent access by multiple threads.
This method permanently deletes an AEP engine descriptor from the default configuration repository.

create

public static AepEngineDescriptor create(String name)

Create a default AEP engine descriptor.

Parameters:
name - The engine name.
Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(IConfigRepository repo, String name)

Checks if an AEP engine is configured in a configuration repository.

Parameters:
repo - The configuration respository to check in.
name - The name of the engine to check for.
Threading:

This method is safe for concurrent access by multiple threads.

exists

public static boolean exists(String name)

Checks if an AEP engine is configured in the default configuration repository

Parameters:
name - The name of the engine to check for.
Threading:

This method is safe for concurrent access by multiple threads.

load

public static AepEngineDescriptor load(IConfigRepository repo, String name) throws EAepException

Create an AEP engine descriptor from a configuration repository.

Parameters:
repo - The configuration respository to create it from.
name - The name of the engine whose descriptor is to be prepared.
Throws:
EAepException
Threading:

This method is safe for concurrent access by multiple threads.
This method creates and initializes an AEP engine descriptor from a configuration repository.

load

public static AepEngineDescriptor load(String name) throws EAepException

Create an AEP engine from the default configuration repository.

Parameters:
name - The name of the engine whose descriptor is to be prepared.
Throws:
EAepException
Threading:

This method is safe for concurrent access by multiple threads.
This method creates and initializes an AEP engine descriptor from the default configuration repository.

loadAll

public static Set<AepEngineDescriptor> loadAll(IConfigRepository repo) throws EAepException

Create descriptors for all AEP engines in a configuration repository.

Parameters:
repo - The configuration respository from where to create the engines.
Returns:
Returns the set of engine descriptors.
Throws:
EAepException
Threading:

This method is safe for concurrent access by multiple threads.

loadAll

public static Set<AepEngineDescriptor> loadAll() throws EAepException

Create descriptors for all AEP engines in the default configuration repository.

Returns:
Returns the set of engine descriptors.
Throws:
EAepException
Threading:

This method is safe for concurrent access by multiple threads.

toString

public final String toString()

Return the string representation of an engine descriptor

Overrides:
toString in class Object

Overview Package Class Tree Deprecated Index Help

PREV CLASS NEXT CLASS FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2016 Neeve Research, LLC. All Rights Reserved.

com.neeve.aep Class AepEngineDescriptor

getName

addStateFactory

getStateFactories

addMessageFactory

getMessageFactories

addBus

setBusManagerProperty

setBusManagerProperty

clearBusManagerProperty

setBusManagerProperties

getBusManagerProperties

clearBusManagerProperties

getBusManagersWithConfiguration

removeBus

addChannel

addChannel

removeChannel

addChannel

removeChannel

getBuses

getChannels

getChannelConfig

setStore

getStore

setHAPolicy

getHAPolicy

setReplicationPolicy

getReplicationPolicy

setMessagingStartFailPolicy

getMessagingStartFailPolicy

setMessageBusBindingFailPolicy

getMessageBusBindingFailPolicy

setInboundMessageLoggingPolicy

getInboundMessageLoggingPolicy

setInboundMessageLoggingFailurePolicy

getInboundMessageLoggingFailurePolicy

setInboundMessageLoggingProperty

getInboundMessageLoggingProperty

clearInboundMessageLoggingProperty

setInboundMessageLoggingProperties

getInboundMessageLoggingProperties

setOutboundMessageLoggingPolicy

getOutboundMessageLoggingPolicy

setOutboundMessageLoggingFailurePolicy

getOutboundMessageLoggingFailurePolicy

setOutboundMessageLoggingProperty

getOutboundMessageLoggingProperty

clearOutboundMessageLoggingProperty

setOutboundMessageLoggingProperties

getOutboundMessageLoggingProperties

setPerTransactionStatsLoggingPolicy

getPerTransactionStatsLoggingPolicy

setPerTransactionStatsLoggingFailurePolicy

getPerTransactionStatsLoggingFailurePolicy

setPerTransactionStatsLoggingProperty

getPerTransactionStatsLoggingProperty

clearPerTransactionStatsLoggingProperty

setPerTransactionStatsLoggingProperties

getPerTransactionStatsLoggingProperties

setMessageHandlingPolicy

getMessageHandlingPolicy

setMessageSendPolicy

getMessageSendPolicy

setAppExceptionHandlingPolicy

getAppExceptionHandlingPolicy

setMessageSendExceptionHandlingPolicy

getMessageSendExceptionHandlingPolicy

setEventMultiplexerType

getEventMultiplexerType

setEventMultiplexerProperty

getEventMultiplexerProperty

clearEventMultiplexerProperty

setEventMultiplexerProperties

getEventMultiplexerProperties

setStartupExpectation

getStartupExpectation

clearStartupExpectation

setStartupExpectations

getStartupExpectations

com.neeve.aep
Class AepEngineDescriptor

Sequence id assignment by an `AepEngine`