All Classes

Class	Description
AbstractChainManager	Base class for a manager that takes responsibility for dynamically creating and managing instances of a transport plug-in.
AbstractCodec	Base class for codec plug-ins.
AbstractEventCodec	AbstractEventCodec is the abstract base class which all Java IAF event codecs should extend.
AbstractEventTransport	AbstractEventTransport is the abstract base class which all Java IAF event transports should extend.
AbstractGenericComponentManagementBean	AbstractGenericComponentManagementBean is a JavaBean that provides a base class upon which JavaBeans using the remote GenericComponentManagement can be built.
AbstractSimpleCodec	Base class that allows simplified implementation of codec plug-ins.
AbstractSimpleTransport	Base class that allows simplified implementation of transport plug-ins.
AbstractStore	A named distributed 'store' instance, which is a factory for tables and typically encapsulates a connection to a single distributed cluster.
AbstractStoreFactory	Factory object for creating store objects, and holding the configuration properties required to do so.
AbstractTable	A table exposed by a distributed store, providing the ability to get and modify the Rows that hold the key/value data held by the cache.
AbstractTransport	Base class for transport plug-ins.
AnyFieldType	Represents the Apama any type, for which values are specified as as AnyFieldValue objects.
AnyFieldValue	Represents the value of an Apamaany field.
Application	This Annotation is used to document a JMON application.
BaseClientInterface
BooleanFieldType	Represents the Apama boolean type, for which values are either Boolean.TRUE or Boolean.FALSE.
Callback	Declare methods on a correlator Java plugin as being a callback from the runtime.
Callback.CBType
Chain	Represents a dynamic chain instance, created using ChainManagerHost.createChain(java.lang.String, com.softwareag.connectivity.chainmanagers.ChainDefinition, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.util.List<java.lang.String>).
ChainDefinition	A dynamic chain definition, providing the configuration for each plug-in in a chain.
ChainDefinition.PluginConfiguration	The name and configuration of a single plug-in in a chain definition.
ChainManagerConstructorParameters	A container for parameters passed to the constructor of a dynamic chain manager.
ChainManagerHost	Interface that the host provides to the chain manager for operations such as creating chains and registering channel lifecycle listeners.
Channel	Class that holds a channel reference and can be passed across the correlator EPL/Java plugin boundary.
ChannelConfig	ChannelConfig is a helper class that assists in building a properties map for use when creating a new EventServiceChannel via the IEventService.addChannel() method.
ChannelFieldType	Represents the Apama Channel type, for which values are specified as String objects.
ChannelLifecycleListener	Interface that will be implemented by a chain manager to get callbacks on channel creation and destroy.
ClusterMembershipListener	Listener interface for notification of changes in the membership of a cluster.
CodecException	CodecException is the exception class thrown by a Java IAF Codec plugin.
CodecStatus	CodecStatus contains status information about the codec, and is returned by AbstractCodecEvent.getStatus().
CommandDescriptorFactory	CommandDescriptorFactory is a class that provides factory methods for creating new instances of classes that implement the ICommandDescriptor interface.
CommunicationException	CommunicationException is a specialized exception for use with the Event Service that indicates that there is a problem communicating with the Correlator.
ConcurrentMapAdapter<K,V>	Helper class for implementing the distributed MemoryStore AbstractTable class using an instance of ConcurrentMap, which is exposed by many providers.
ConfigurableCodec	This interface defines functions that Codecs which have upstream events passed to them via their associated transport must perform.
ConnectionConstants
ConnectivityPlugin	Base class that all codec and transport plug-ins inherit from.
ConnectMode
ConnectOperationsInterface	ConnectOperationsInterface is an interface that specifies methods for connecting an engine as a consumer of another engine.
ConsumerOperationsInterface	ConsumerOperationsInterface is an interface that specifies the standard operations to enable a client to receive events on specific channels from a remote Correlator.
Context	Class that holds a context reference and can be passed across the correlator EPL/Java plugin boundary.
Context	The Context class provides a Java representation of the MonitorScript context type.
ConverterConfig<K,V>	A configuration bean for deciding what RowKeyValueConverter to apply to each table.
Correlator	Static class to allow java plugins to interact with the correlator.
Correlator	This class provides various utility methods related to the Apama Event Correlator, that can be invoked from within JMon applications.
DashboardManager	DashboardManager is a class that provides static methods for getting the IDashboardContext for use in a custom function or command.
DecimalFieldType	Represents the Apama decimal type, for which values are specified as DecimalFieldValue objects.
DecimalFieldValue	Represents the value of an Apama decimal field.
DefaultRowKeyValueConverter<K,V>	Helper class for implementing RowKeyValueConverter using String for the keys and RowValue for the values.
DeleteOperationsInterface	DeleteOperationsInterface is an interface that specifies the standard operations to enable an engine client to remove items from a remote correlator.
DictionaryFieldType<K,V>	Represents the Apama dictionary<key,item> type, for which values are specified as Map objects.
Direction	The enumeration indicating the direction of message flow - towards the transport or towards the host.
DirectoryProcessor	Process a directory tree of class files to automatically generate the JMon application deployment descriptor.
DisconnectableEventConsumer
DiscoveryStatusEnum	Enum to represent the discovery status within the Scenario Service.
DistMemStoreProviderException	Represents a distributed MemoryStore error that is not a programming bug - i.e either a runtime/deployment problem reported by the 3rd party library (e.g networking problem etc) or problem with the configuration specified by the user.
ELMappingExtensionManager	Allows registration of EL methods and resolvers to the mapping layer.
ELMappingExtensionProvider	Interface for registering EL methods and resolvers.
EngineClientBean	EngineClientBean is a JavaBean for interacting with an Apama engine, typically a Correlator.
EngineClientFactory	EngineClientFactory is a factory for classes that implement Apama messaging or correlator management interfaces.
EngineClientInterface	EngineClientInterface is an interface that specifies ALL of the standard operations to enable an engine client to communicate with a remote correlator.
EngineConnection	EngineConnection encapsulates the information related to a connection between two Apama messaging components.
EngineException	An EngineException is thrown by various methods of classes in the Engine Client SDK if any problems are encountered.
EngineInfo	This interface represents the API for accessing all of the information returned from an engine as result of a call to the engineInspect() method.
EngineManagement	The EngineManagement interface is the primary low-level interface to the Engine, and allows operations to be carried out on it.
EngineManagementFactory	This class is used to create objects that implement the EngineManagement interface.
EngineStatus	EngineStatus represents the operational status of the correlator.
EPLPlugin	This Annotation is used to mark a Java EPL Plugin class.
Event	An Event object representing an event instance in flat event string format and/or structured format (as defined by its associated EventType).
Event	Abstract base class for a Java object that will be treated as an Apama event inside the Correlator, with a public Java field for each field of the event.
EventCodec	EventCodec defines the interface that Java IAF codecs implement so they can be used by the IAF to convert a downstream event from the transport into the normalised form required by the Semantic Mapper.
EventCodecProperty	EventCodecProperty holds a (name, value) pair of strings, and is used to store codec configuration propery values.
EventConsumer	An EventConsumer can connect to the Engine through an EventSupplier and register to receive events.
EventDecoder	EventDecoder defines the interface that Java IAF decoders implement so they can be used by the IAF to convert a downstream event from the transport into the normalised form required by the Semantic Mapper.
EventExpression	Instances of this class are declared to represent an "Event Expression" as defined in the Apama reference manual "The JMON Application Framework".
EventFieldAttributes	Deprecated. This class has been deprecated and may be removed in a future release - Please use the new JMon annotations instead.
EventHandler	Handler interface used for callbacks when a plugin listens for events on a channel.
EventListenerAdapter	EventListenerAdapter is a class that provides a skeletal implementation of the IEventListener interface to minimize effort required to implement the interface.
EventParser	Provides the functionality to parse String objects into Apama Event objects, for any EventType registered with the parser.
EventReader	Utility class to read Event objects from a text stream in event file format (individually, or in batches with optional timestamps if the BATCH keyword is used in the input stream).
EventServiceException	EventServiceException is a base exception class for all other specialized exceptions within with the Event Service.
EventServiceFactory	EventServiceFactory is a class that provides a factory for creating new instances of classes that implement the IEventService interface.
EventSupplier	An EventSupplier represents the resources created by the Engine to service a connection to an external sink of events.
EventTransport	EventTransport defines the interface that Java IAF transports implement so they can be used by the IAF to send an upstream event that has passed through the Semantic Mapper and encoder.
EventTransportProperty	EventTransportProperty holds a (name, value) pair of strings, and is used to store transport configuration propery values.
EventType	Represents the definition of an Apama event type, for which values are specified as Event objects.
EventType	This Annotation is used to mark a JMON Event class.
ExtendedCodecStatus	ExtendedCodecStatus contains status information about the codec, and is returned by AbstractCodecEvent.getStatus().
ExtendedTransportStatus	ExtendedTransportStatus contains status information about the transport, and is returned by AbstractTransportEvent.getStatus().
Field<T>	Represents the name and type of a field in an EventType.
FieldType<T>	Represents an Apama type.
FieldTypes	Provides factory methods and constants for getting all supported Apama event field types.
FloatFieldType	Represents the Apama float type, for which values are specified as Double objects.
FunctionDescriptorFactory	FunctionDescriptorFactory is a class that provides factory methods for creating new instances of classes that implement the IFunctionDescriptor interface.
GenericComponentManagement	Generic management interface for Apama components.
GenericComponentManagement.GenericComponentConnection	The interface describing a messaging connection to a component
GenericComponentManagement.GenericComponentConnectionSet
GenericComponentManagement.GenericComponentInfo	A list of related component info tuples
GenericComponentManagement.GenericComponentInfoTuple	A name-value pair holding some information about a component
GenericComponentManagement.GenericComponentLogLevel	Log verbosity levels
GenericComponentManagement.GenericComponentReceiver	The interface describing a messaging receiver connected to a component
GenericComponentManagement.GenericComponentSender	The interface describing a messaging sender connected to a component
GenericComponentManagementBean	GenericComponentManagementBean is a JavaBean that provides a way of controlling an arbitrary server that exports a GenericComponentManagement interface.
GenericComponentManagementException	Base for all exceptions thrown by the GenericComponentManagement interface.
GenericComponentManagementFactory	Create objects that implement the GenericComponentManagement interface.
GenericComponentManagementOperationsInterface
HostSide	Used by transport and codec plug-in authors for sending messages towards the host (originating from the transport).
IAFLogger	Deprecated. Use Logger instead.
ICommandDescriptor	ICommandDescriptor is an interface that represents a description of a DashboardStudio command.
ICommandLibrary	ICommandLibrary is the interface a Dashboard Studio custom command library must implement.
IDashboardContext	IDashboardContext is an interface to an instance of a dashboard or dashboard panel.
IEventAuthority	An IEventAuthority authorizes users for sending an event to the correlator.
IEventListener	IEventListener specifies the interface that classes must implement to receive events from an EventServiceChannel.
IEventService	IEventService is an interface that represents the public API to the EventService.
IEventServiceChannel	IEventServiceChannel is the public interface for a class that represents a channel or channels on which events are received from a Correlator.
IFunctionDescriptor	IFunctionDescriptor is an interface that represents a description of a DashboardSutdio function.
IFunctionLibrary	IFunctionLibrary is the interface a Dashboard Studio custom function library must implement.
IllegalCallingThreadException	Thrown when an attempt is made to change the state of running scenarios in the data queue processing thread.
IMacroPreprocessor	IMacroPreprocessor class provides a hook for user to resolve macros inside any attachment strings in the Instance Table Query attachment.
IMacroPreprocessor.ATTACHMENT_TYPE	Enum type to indicate the type of attachment when the process() method is called.
InjectOperationsInterface	InjectOperationsInterface is an interface that specifies the standard operations to enable an engine client to inject new code into a remote correlator.
InspectOperationsInterface	InspectOperationsInterface is an interface that specifies the standard orperations to enable an engine client to gather information from a remote correlator about the set of Monitors and Event Types that it is currently working with.
InstanceStateEnum	Enum class to handle the StateChange event.
IntegerFieldType	Represents the Apama integer type, for which values are specified as Long objects.
InterruptedEngineException	An InterruptedEngineException is thrown by various methods of classes in the Engine Client SDK if the thread calling is interrupted.
InvalidInputParameterException	InvalidInputParameterException is a specialized exception class that is used by classes of the Scenario Service to indicate that an invalid input parameter has been provided to create or edit a ScenarioInstance.
IResponseListener	IResponseListener specifies the interface that classes must implement to receive the response part of an asynchronous request-response call.
IResponseWrapper	IResponseWrapper is an interface that specifies the public API for objects returned by the various request-response methods of the Event Service.
IScenarioAuthority	An IScenarioAuthority authorizes users for viewing, editing, deleting, and creating scenarios.
IScenarioDefinition	IScenarioDefinition supports creating instances of a scenario, listening for added/removed/changed instances, and getting the information about the scenario definition itself (for example id, display name, input/output parameter names and types).
IScenarioDefinition.ScenarioType	Enumeration used to distinguish between different kinds of scenario definition.
IScenarioInstance	IScenarioInstance supports getting the owner, last update time and current input/output parameter values of a scenario instance, listening for changes in individual instance parameters, and performing delete and edit operations on the instance.
IScenarioService	The Scenario Service is an API for interacting with Apama applications from custom clients and dashboards running outside the correlator.
ITabularData	ITabularData is an interface to an instance of Dashboard Studio tabular data.
IUserCredentials	UserCredentials contain information about a user attempting to access data or perform an operation.
IVariableData	IVariableData is an interface to an instance of a class containing the current values of a set of dashboard variables.
JarProcessor	Process a jar file to automatically generate the JMon application deployment descriptor.
JmsReceiverMapper	Message mapper interface for a class that can synchronously convert a received JMS message to an event string (and optional duplication detection ids).
JmsReceiverMapperContext	Context object allowing a mapper to get this receiver's receiverId and helper methods for destination handling etc.
JmsReceiverMapperFactory	Holds mapper configuration information and uses it to create instances implementing the single-threaded JmsReceiverMapper interface.
JmsSenderMapper	Message mapper interface for a class that can synchronously convert an event string (and optional duplication detection ids) to a JMS message to send.
JmsSenderMapperContext	Context object allowing a mapper to get this sender's Session object for constructing JMS Messages and helper methods for destination handling etc.
JmsSenderMapperFactory	Holds mapper configuration information and uses it to create instances implementing the single-threaded JmsSenderMapper interface.
JmsSenderMessageHolder	Holds a JMS message and send parameters such as the destination, and optionally the values of any send arguments that were overridden on a per-message basis by the mapper (such as priority).
Location	The Location class provides a Java representation of the MonitorScript location type.
LocationFieldType	Represents the Apama location type, for which values are specified as LocationType objects.
LocationType	Represents the value of an Apama location type, consisting of of two (x,y) co-ordinates.
Logger	The Logger class is a logging facade used by Apama's Java client API, and also by Apama classes and user-defined plug-ins that run inside the correlator and IAF processes.
LogLevel	LogLevel is an enumeration specifying all the log levels supported by Apama server components and the Java client logging API.
ManagedTransportConstructorParameters	A container for parameters used to create a transport plug-in instance from a chain manager.
MapExtractor	Provides a type-safe way to extract values from a heterogenous Map (where keys and values could be of any type), with user-friendly error messages identifying the map and key within the map if any item is missing or has the wrong type.
MappableApamaEvent	Holds an Apama event that is about to be mapped to a JMS message, or has just been mapped from a JMS message.
MatchEvent	Represents a match against an event expression registered in the Correlator.
MatchListener	This interface defines the single method that must be implemented in order for an object to be a listener for MatchEvents.
Message	A container for a payload and metadata.
Monitor	Deprecated. Apama's in-process API for Java (JMon) is deprecated and will be removed in a future release - It is recommend that you now use EPL plug-ins written in Java instead of JMon applications.
MonitorScript	A MonitorScript object encapsulates a MonitorScript code fragment, containing package, event and monitor definitions to be injected into an Engine.
MonitorType	This Annotation is used to mark a JMON Monitor class.
NamedAggregateInfo	This interface provides the API for accessing a snapshot of information about an aggregate function that is/was live in the engine.
NamedContextInfo	This interface provides the API for accessing a snapshot of information about a Context that is/was live in the engine.
NamedEventTypeInfo	This interface provides the API for accessing a snapshot of information about a Monitor that is/was live in the engine.
NamedJavaApplicationInfo	This interface provides the API for accessing a snapshot of information about a Java (JMon) Application that is/was live in the engine.
NamedMap<K,V>	Extension to HashMap to give the map an event type name.
NamedMonitorInfo	This interface provides the API for accessing a snapshot of information about a Monitor that is/was live in the engine.
NamedPluginReceiverInfo	This interface provides the API for accessing a snapshot of information about a Receiver that is/was live in the engine.
NamedReceiverInfo	This interface provides the API for accessing a snapshot of information about a Receiver that is/was live in the engine.
NamedTimerInfo	This interface provides the API for accessing a snapshot of information about a Monitor that is/was live in the engine.
NameInfo	This is the base interface for defining the API for accessing information about items that are/were live in the engine at the point of inspection.
NoBlock	Declare that either an entire plugin, or a specific method doesn't block.
NormalisedEvent	Represents an Apama event in the normalised form used by the IAF Semantic Mapper.
NormalisedEventException	NormalisedEventException is the exception class thrown by NormalisedEvent and JNormalisedIterator.
NormalisedEventIterator	NormalisedEventIterator implements an iterator interface similar to the C NormalisedEventIterator interface documented in the IAF manual, which can be used for iterating over the fields of a NormalisedEvent.
OptionalFieldType<T>	Represents the Apama optional type, for which values are specified as FieldType objects.
ParameterTypeEnum	Enumeration class to model the "type" of scenario input/output parameters.
ParserRuntimeException	ParserRuntimeException will be thrown when an error occurs while parsing an Apama event.
PingableClient	The PingableClient interface is the interface to any Apama TCP server, and allows clients to detect if the server is alive.
PingableClientFactory
PingBean	PingBean is a JavaBean that provides a mechanism for pinging any Apama TCP server that offers the Pingable interface (that should be all of them).
PingClientInterface
PingOperationsInterface
PluginConstructorParameters	A base interface for parameters passed to the constructor of transport or codec plug-ins.
PluginConstructorParameters.CodecConstructorParameters	A container for parameters passed to the constructor of a codec plug-in.
PluginConstructorParameters.TransportConstructorParameters	A container for parameters passed to the constructor of a transport plug-in.
PluginHost	Interface to support miscellaneous requests from a particular plug-in to the host system.
PreparedEventExpression	Instances of this class are created from PreparedEventExpressionTemplate objects.
PreparedEventExpressionException	Exception thrown when illegal operations are performed on a PreparedEventExpression object.
PreparedEventExpressionTemplate	Instances of this class are declared to represent templates for "Prepared Event Expressions".
ReceiveConsumerOperationsInterface	ReceiveConsumerOperationsInterface is an interface providing the ability to create consumers for receiving events from an Apama server component.
ReconnectPolicyInterface	A policy that can be applied to an engine client to control when it can reconnect.
RemoveListener	This interface defines the single method that must be implemented in order for a MatchListener to be told when it's connection to an EventExpression has gone.
ResponseTimeoutException	ResponseTimeoutException is a specialized exception for use with the Event Service that indicates that a request-response timeout has been exceeded.
RowChangedSubscriptionManager	A per-table helper object for managing each context's subscription to notifications about the table.
RowChangedType	Represents the supported types of row change alterations.
RowKeyValueConverter<K,V>	Interface to allow custom application-specific Java classes to be used to represent keys and values instead of the default String (for keys) and RowValue classes.
RowValue	The value of an entry/row in a distributed store's table.
RowValueHelper	Helper class for more conveniently and efficiently dealing with RowValue objects for a given table schema.
ScenarioServiceConfig	ScenarioServiceConfig is a helper class that assists in building a properties map for use when creating a new ScenarioService via the ScenarioServiceFactory.
ScenarioServiceException	ScenarioServiceException is a base exception class for all other specialized exceptions within with the Scenario Service.
ScenarioServiceFactory	ScenarioServiceFactory is a class that provides factory methods for creating new instances of IScenarioService.
SemanticMapper	SemanticMapper defines the interface that Java IAF decoders implement so they can be used by the IAF to convert a downstream event from the transport into the normalised form required by the Semantic Mapper.
SemanticMapperException	SemanticMapperException is the exception class thrown by the IAF Semantic Mapper.
SendOperationsInterface	SendOperationsInterface is an interface that specifies the standard operations to enable an engine client to send events to a remote correlator.
SequenceFieldType<E>	Represents the Apama sequence<type> type, for which values are specified as List objects.
SimpleAbstractJmsMessageMapper	Abstract helper class for implementing simple mappings between JMS messages and Apama events, with optional support for delegation to another mapper.
StatusReporter	An interface allowing a plug-in to report status values to the host.
StatusReporter.StatusItem	An interface that can be used to efficiently update the value associated with a single status key.
StringFieldType	Represents the Apama string type, for which values are specified as String objects.
TableSupportsExtraFields	Tagging interface to declare a class supports the use of the extraFields member of RowValue.
TabularDataFactory	TabularDataFactory is a class that provides factory methods for creating new instances of ITabularData
TimestampConfig	TimestampConfig is an assemblage of configuration settings relating to the handling of TimestampSet data (used in the latency measurement framework).
TimestampSet	Represents a set of high-accuracy timestamps, used for latency measurement.
TimestampSetException	TimestampSetException is the exception class thrown by TimestampSet.
TransformInterface	TransformInterface is provided by plugins to the IAF to transform property entries in the config file before being passed to plugins.
TransportException	TransportException is the exception class thrown by aJava IAF Transport plugin.
TransportSide	Used by codec plug-in authors for sending messages towards the transport (originating from the host).
TransportStatus	TransportStatus contains status information about the transport, and is returned by AbstractTransportEvent.getStatus().
Unloadable	This interface defines a method which will be called on any monitor which implements this interface when the JMon application is being unloaded.
WatchOperationsInterface	WatchOperationsInterface is an interface that specifies the standard operations to enable an engine client to extract status information from a remote correlator.
Wildcard	This Annotation is used to mark a JMON Event parameter (field) that is wildcarded.