Package com.adaptris.core

The main Interlok package.

Interface Summary

Interface	Description
AbstractMarshaller.Deserializer
AbstractMarshaller.Serializer
AdaptrisComponent	Base interface for components in the framework.
AdaptrisConnection	Represents a connection to an application or of a protocol type.
AdaptrisMarshaller	Defines methods required to 'marshal' Java objects to XML.
AdaptrisMarshaller.MarshalInputStream
AdaptrisMarshaller.MarshalOutputStream
AdaptrisMessage	Represents a message in the framework.
AdaptrisMessageConsumer	Implementations of AdaptrisMessageConsumer obtain data, convert it into an AdaptrisMessage and pass the message to the registered AdaptrisMessageListener.
AdaptrisMessageEncoder<T,S>	Implementations of AdaptrisMessageEncoder create representations of whole AdaptrisMessages, including metadata and unique ID.
AdaptrisMessageListener	Applies arbitrary processing to AdaptrisMessages.
AdaptrisMessageProducer	Implementations of AdaptrisMessageProducer produce messages to a destination (such as a JMS Queue or file system directory).
AdaptrisMessageSender	New interface so that we can re-use producer style functionality without all the additional requirements surrounds AdaptrisMessageWorker.
AdaptrisMessageTranslator	Base interface for translating messages to and from AdaptrisMessage instances.
AdaptrisMessageWorker	Defines behaviour common to AdaptrisMessageConsumer and AdaptrisMessageProducer.
AdaptrisPollingConsumer.LockOperator
ChannelLifecycleStrategy	Strategy for handling channel lifecycle within a ChannelList.
ComponentLifecycle	Defines standard lifecycle operations for components in the framework.
ComponentLifecycleExtension	Extensions on the standard component lifecycle.
ComponentState	Defines the state transition requests that can be made to a StateManagedComponent.
ConfigComment	Provides the ability for the UI to have notes associated with an configuration item.
ConnectedService	An interface that represents a Service that contains a connection.
ConnectionErrorHandler	Implementations of this class encapsualte behaviour that is invoked when an Exception relating to a connection is encountered.
DefaultFailedMessageRetrierJmxMBean	JMX Interface for DefaultFailedMessageRetrier
DynamicPollingTemplate.TemplateProvider	Marker interface so that not all services can be configured.
ErrorHandlerRegistrar	ErrorHandlerRegister
EventHandler	Defines behaviour related to sending and receiving Events using other standard framework components.
EventHandlerAware	Marker interface indicating that this component needs to be made aware of the EventHandler.
FailedMessageRetrier	Component which consumes AdaptrisMessages and, based on message metadata, resubmits them to the Workflow which processed them originally.
FileNameCreator	Creates a file name for an AdaptrisMessage.
IORunnable
LoggableEvent
MessageEventGenerator	Implemented by classes which generate message lifecycle events.
MessageLogger
MetadataLogger
MultiPayloadAdaptrisMessage	Interface for Adaptris messages that support multiple payloads, referenced by an ID/key.
OutOfStateHandler	Implementations will be able to test if a StateManagedComponent is in the expected state.
Poller	Schedules polling for AdaptrisPollingConsumers.
PollerImp.Callback
PollingTrigger.MessageProvider	How to generate the template that will be sent to the workflow.
ProcessingExceptionHandler	Standard interface for handling errors during processing of a message.
ProduceExceptionHandler	Implementations are pluggable responses to ProduceExceptions in a Workflow.
RetryMessageErrorHandlerMonitorMBean
SerializableMessageTranslator
Service	Implementations of Service apply aribtrary functionality to AdaptrisMessages.
ServiceCollection	Defines behaviour common to collections of Services.
ServiceWrapper	A marker interface for Services that wrap other services.
SharedComponentLifecycleStrategy	Strategy for handling connection lifecycle within a SharedComponentList.
StateManagedComponent	Specifies methods for components which manage state transitions.
StateManagedComponentContainer	Extension to StateManagedComponent used for fine grained state transitions.
Workflow	Workflows link an AdaptrisMessageConsumer, a ServceCollection and an AdaptrisMessageProducer.
WorkflowInterceptor	Interface for intercepting messages as they enter and exit a workflow.
WorkflowLifecycleStrategy	Strategy for handling workflow lifecycle within a WorkflowList.

Class Summary

Class	Description
AbstractMarshaller	Abstract implementation of AdaptrisMarshaller.
Adapter	Main class in core package.
AdapterLifecycleEvent	Contains behaviour common to all Events in the framework which relate to an Adapter's lifecycle.
AdapterMarshallerFactory	Factory Class that creates the required Marshaller ie the DataBinder instance that allows us to marshal & unmarshal our objects eg XStream, Castor etc This factory also allows the DataBinder to be configured to output to a given format eg JSON/XML.
AdapterStartUpEvent	Concrete implementations of this Event contains details of the Adapter configuration.
AdapterStateSummary	Summary of the state of an Adapter and associated Channels
AdapterXStreamMarshallerFactory	XStream Marshaller Specific Factory class.
AdaptrisConnectionImp	Contains behaviour common to implementations of AdaptrisConnection.
AdaptrisMessageConsumerImp	Implementation of behaviour common to AdaptrisMessageConsumers.
AdaptrisMessageEncoderImp<T,S>	Partial implementation of behaviour commom to all AdaptrisMessageEncoder instances.
AdaptrisMessageFactory	A static factory which returns implementations of AdaptrisMessage.
AdaptrisMessageImp	Standard implementation of AdaptrisMessage interface.
AdaptrisMessageProducerImp	Implementation of behaviour common to AdaptrisMessageProducers.
AdaptrisMessageWorkerImp	Implementation of behaviour common to AdaptrisMessageConsumer and AdaptrisMessageProducer.
AdaptrisPollingConsumer
AddPayloadService	Add a new payload to the message.
AllowsRetriesConnection	Abstract class for connections that have the ability to retry connections.
BranchingServiceCollection	Implementation of ServiceCollection which allows branching services to select the next service to apply.
BranchingServiceImp	Contains behaviour common to BranchingServices.
Channel	Links two AdaptrisConnection implementations and has a WorkflowList
ChannelCloseErrorHandler	ConnectionErrorHandler which shutdowns the channel where there is a problem.
ChannelList	Container for a collection of Channel objects
ChannelRestartProduceExceptionHandler	Implementation of ProduceExceptionHandler which attempts to restart the parent Channel of the Workflow that had the failure.
CloneMessageServiceList	Implementation of ServiceCollection that creates a new clone of AdaptrisMessage for each configured service.
ClosedState	Represents closed StateManagedComponents and implements permitted transitions.
ComponentStateImp	Default implementation of ComponentState.
ConnectionErrorHandlerImp	Behaviour common to ConnectionErrorHandlers.
CoreConstants	Constants for the core package.
DefaultAdapterStartUpEvent	Deprecated.
DefaultAdaptrisMessageImp	AdaptrisMessage implementation created by DefaultMessageFactory
DefaultChannelLifecycleStrategy	Default strategy for starting channels.
DefaultEventHandler	Basic implementation of EventHandler.
DefaultFailedMessageRetrier	Implementation of FailedMessageRetrier that does not allow duplicate workflows.
DefaultFailedMessageRetrierJmx
DefaultMarshaller	Convenience for getting the default marshalling system currently available in the adapter.
DefaultMessageFactory	The default factory which returns implementations of AdaptrisMessage.
DefaultMessageLogger	MessageLogger implementation that that logs unique-id and metadata.
DefaultSerializableMessageTranslator
DefaultWorkflowLifecycleStrategy	Default strategy for starting workflows.
DynamicPollingTemplate	Provides a template for PollingTrigger.
DynamicSharedService	A Service instance that references a Service made available via SharedComponentList.getServices().
Event	Contains behaviour common to all Events in the framework.
EventFactory	Static factory which creates Events.
EventHandlerBase	Contains behaviour common to implementations of EventHandler.
EventNameSpaceConstants	All concrete subclasses of Event should define there own 'name space' or hierarchical name, thus allowing interested parties to subscribe for Events selectively.
FailedMessageRetrierImp	Component which consumes AdaptrisMessages and, based on message metadata, resubmits them to the Workflow which processed them originally.
FixedIntervalPoller	Implementation of Poller which polls at a configurable fixed interval.
FormattedFilenameCreator	Implementation of FileNameCreator that uses String.format(String, Object...).
GaussianIntervalPoller	Implementation of Poller which polls at a random interval with a normal distribution.
HeartbeatEvent	Standard Adapter heartbeat event.
InitialisedState	Represents initialised StateManagedComponents and implements permitted transitions.
JndiContextFactory
ListenerCallbackHelper
MessageLifecycleEvent	Container for message lifecycle events (MleMarkers) for implementations of AdaptrisMessage.
MessageLoggerImpl
MetadataCollection	A container class for handling a Collection of MetadataElement instance.
MetadataElement	A key-value pair of String metadata.
MetadataFileNameCreator	Implementation of FileNameCreator which obtains the file name to use from message metadata.
MimeEncoder	Implementation of AdaptrisMessageEncoder that stores AdaptrisMessage payload and metadata as a mime-encoded multipart message.
MimeEncoderImpl<T,S>
MleMarker	Records information about activities (generally Service implementations) performed on a AdaptrisMessage during a workflow.
MultiPayloadAdaptrisMessageImp	The standard implementation of multi-payload messages; MultiPayloadAdaptrisMessage implementation created by MultiPayloadMessageFactory.
MultiPayloadMessageFactory	The multi-payload message factory which returns an implementations of MultiPayloadAdaptrisMessage.
MultiPayloadMessageMimeEncoder	Multi-payload message MIME encoder.
MultiProducerWorkflow	Implementation of Workflow that contains multiple producers.
NoOpConnection	Base Implementation of a no-op connection.
NoRetries	This is a dummy for marshalling purposes.
NullConnection	No Op connection
NullConnectionErrorHandler	Implementation of ConnectionErrorHandler for use with polling consumers where you do not want an Exception thrown back to run to re-init the Channel.
NullMessageConsumer	Null implementation of AdaptrisMessageConsumer.
NullMessageProducer	Null implementation of AdaptrisMessageProducer.
NullOutOfStateHandler	Implementation of the OutOfStateHandler which does no checks.
NullProcessingExceptionHandler	Null implementation of Processing Exceptions.
NullProduceExceptionHandler	Null implementation of ProduceExceptionHandler which logs a message only.
NullService	Null implementation of Service.
OutOfStateHandlerImp	Abstract implementation of the OutOfStateHandler.
PollerImp	Partial implementation of Poller.
PollingTrigger	Periodically sends a template message to trigger a Workflow
PoolingWorkflow	A Workflow that pools ServiceCollections.
ProduceExceptionHandlerImp	Implementation of behaviour common to ProduceExceptionHandler instances
ProduceOnlyProducerImp	Convenience class that only supports produce rather than request.
QuartzCronPoller	Implementation of Poller which provides cron style scheduled polling based on the Quartz project.
QuartzCronPoller.MyProcessJob
RaiseExceptionOutOfStateHandler	This implementation of the OutOfStateHandler will simply throw an OutOfStateException every time when a StateManagedComponent is not in the correct/expected state.
RandomIntervalPoller	Implementation of Poller which polls at a random interval with a delay between each execution of up-to the configured poll interval (in ms).
RequestReplyProducerBase	Abstract Request Reply enabled producer that may be extended by concrete sub-classes.
RequestReplyProducerImp	Abstract Request Reply enabled producer that may be extended by concrete sub-classes.
RequestReplyWorkflow	Implementation of Workflow to handle synchronous replies.
ResolveFromPayloadUsingXPath
RestartProduceExceptionHandler	Deprecated. since 3.10.2
RetryMessageErrorHandler	MessageErrorHandler implementation that allows automatic retries for a problem message.
RetryMessageErrorHandlerImp	Abstract MessageErrorHandler implementation that allows automatic retries for a problem message.
RetryMessageErrorHandlerMonitor
RetryOnceStandaloneProducer	An implementation of StandaloneProducer that on encountering an error producing a message, waits for a configurable period, re-initialises the underlying components, then tries to produce once one more.
RootProcessingExceptionHandler	RootProcessingExceptionHandler which allows you to register a Digester for aggregating information about all the errors that have occurred.
ScheduledTaskPoller
SerializableAdaptrisMessage	The SerializableAdaptrisMessage simply represents an AdaptrisMessage that can be serialized.
ServiceCollectionImp	Behaviour common to ServiceCollections.
ServiceImp	Implementation of default / common behaviour for Services.
ServiceList	Implementation of ServiceCollection with an ordered list of Services.
ServiceListBase
SharedComponent
SharedComponentList	A common store for components.
SharedConnection	A connection instance that references a connection made available via SharedComponentList.
SharedService	A Service instance that references a Service made available via SharedComponentList.
SharedServiceImpl
StandaloneConsumer	Wrapper class for a AdaptrisMessageConsumer and a AdaptrisConnection.
StandaloneProducer	Wrapper for a AdaptrisConnection and a AdaptrisMessageProducer for convenience.
StandaloneRequestor	StandaloneProducer extension that allows request reply functionality within a service
StandardProcessingExceptionHandler	ProcessingExceptionHandler implementation that contains a single service to apply when a message fails.
StandardWorkflow	Standard implementation of Workflow.
StandardWorkflowImpl
StartedState	Represents started StateManagedComponents and implements permitted transitions.
StaticPollingTemplate	Provides a static template for PollingTrigger.
StoppedState	Represents stopped StateManagedComponents and implements permitted transitions.
SwitchPayloadService	Switch the message payload from one payload to another.
ThreadContextWorkflow	Workflow that executes services in the current thread.
WaitingOutOfStateHandler	This implementation of the OutOfStateHandler will simply wait on the current Thread for the StateManagedComponent to be in the correct/expected state.
WorkflowImp	Partial implementation of Workflow.
WorkflowList	Container for a collection of Workflows.
WorkflowWithObjectPool	A Workflow that has a object pool of ServiceCollections
XStreamJsonMarshaller	JSON implementation of AdaptrisMarshaller using XStream.
XStreamMarshaller	XStream version of AdaptrisMarshaller
XStreamMarshallerImpl	Abstract XStream version of AdaptrisMarshaller

Enum Summary

Enum	Description
AdapterMarshallerFactory.MarshallingOutput
ConfiguredComponentState

Exception Summary

Exception	Description
CoreException	Standard Exception in the core package and sub-packages.
OutOfStateException
ProduceException	Exception thrown by AdaptrisMessageProducers.
ServiceException	Exception thrown by Services.
UnresolvedMetadataException