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 ofAdaptrisMessageConsumerobtain data, convert it into anAdaptrisMessageand pass the message to the registeredAdaptrisMessageListener.AdaptrisMessageEncoder<T,S> Implementations ofAdaptrisMessageEncodercreate representations of wholeAdaptrisMessages, including metadata and unique ID.AdaptrisMessageListener Applies arbitrary processing toAdaptrisMessages.AdaptrisMessageProducer Implementations ofAdaptrisMessageProducerproduce 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 toAdaptrisMessageConsumerandAdaptrisMessageProducer.AdaptrisPollingConsumer.LockOperator ChannelLifecycleStrategy Strategy for handling channel lifecycle within aChannelList.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 aStateManagedComponent.ConfigComment Provides the ability for the UI to have notes associated with an configuration item.ConnectedService An interface that represents aServicethat contains a connection.ConnectionErrorHandler Implementations of this class encapsualte behaviour that is invoked when anExceptionrelating to a connection is encountered.DefaultFailedMessageRetrierJmxMBean JMX Interface forDefaultFailedMessageRetrierDynamicPollingTemplate.TemplateProvider Marker interface so that not all services can be configured.ErrorHandlerRegistrar ErrorHandlerRegisterEventHandler Defines behaviour related to sending and receivingEvents 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 anAdaptrisMessage.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 aStateManagedComponentis in the expected state.Poller Schedules polling forAdaptrisPollingConsumers.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 Deprecated. since 4.2.0RetryMessageErrorHandlerMonitorMBean SerializableMessageTranslator Service Implementations ofServiceapply aribtrary functionality toAdaptrisMessages.ServiceCollection Defines behaviour common to collections ofServices.ServiceWrapper A marker interface for Services that wrap other services.SharedComponentLifecycleStrategy Strategy for handling connection lifecycle within aSharedComponentList.StateManagedComponent Specifies methods for components which manage state transitions.StateManagedComponentContainer Extension toStateManagedComponentused for fine grained state transitions.Workflow Workflows link anAdaptrisMessageConsumer, aServceCollectionand anAdaptrisMessageProducer.WorkflowInterceptor Interface for intercepting messages as they enter and exit a workflow.WorkflowLifecycleStrategy Strategy for handling workflow lifecycle within aWorkflowList. -
Class Summary Class Description AbstractMarshaller Abstract implementation of AdaptrisMarshaller.Adapter Main class incorepackage.AdapterLifecycleEvent Contains behaviour common to allEventsin the framework which relate to anAdapter'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 thisEventcontains details of theAdapterconfiguration.AdapterStateSummary AdapterXStreamMarshallerFactory XStream Marshaller Specific Factory class.AdaptrisConnectionImp Contains behaviour common to implementations ofAdaptrisConnection.AdaptrisMessageConsumerImp Implementation of behaviour common toAdaptrisMessageConsumers.AdaptrisMessageEncoderImp<T,S> Partial implementation of behaviour commom to allAdaptrisMessageEncoderinstances.AdaptrisMessageFactory Astaticfactory which returns implementations ofAdaptrisMessage.AdaptrisMessageImp Standard implementation ofAdaptrisMessageinterface.AdaptrisMessageProducerImp Implementation of behaviour common toAdaptrisMessageProducers.AdaptrisMessageWorkerImp Implementation of behaviour common toAdaptrisMessageConsumerandAdaptrisMessageProducer.AdaptrisPollingConsumer AddPayloadService Add a new payload to the message.AllowsRetriesConnection Abstract class for connections that have the ability to retry connections.BranchingServiceCollection Implementation ofServiceCollectionwhich allowsbranchingservices to select the next service to apply.BranchingServiceImp Contains behaviour common toBranchingServices.Channel Links twoAdaptrisConnectionimplementations and has aWorkflowListChannelCloseErrorHandler ConnectionErrorHandlerwhich shutdowns the channel where there is a problem.ChannelList Container for a collection ofChannelobjectsChannelRestartProduceExceptionHandler Deprecated. since 4.2.0CloneMessageServiceList Implementation of ServiceCollection that creates a new clone of AdaptrisMessage for each configured service.ClosedState Represents closedStateManagedComponents and implements permitted transitions.ComponentStateImp Default implementation ofComponentState.ConnectionErrorHandlerImp Behaviour common toConnectionErrorHandlers.CoreConstants Constants for thecorepackage.DefaultAdapterStartUpEvent Deprecated. DefaultAdaptrisMessageImp AdaptrisMessageimplementation created byDefaultMessageFactoryDefaultChannelLifecycleStrategy Default strategy for starting channels.DefaultEventHandler Basic implementation ofEventHandler.DefaultFailedMessageRetrier Implementation ofFailedMessageRetrierthat 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 ofAdaptrisMessage.DefaultMessageLogger MessageLogger implementation that that logs unique-id and metadata.DefaultSerializableMessageTranslator DefaultWorkflowLifecycleStrategy Default strategy for starting workflows.DynamicPollingTemplate Provides a template forPollingTrigger.DynamicSharedService A Service instance that references a Service made available viaSharedComponentList.getServices().Event Contains behaviour common to allEvents in the framework.EventFactory Static factory which createsEvents.EventHandlerBase Contains behaviour common to implementations ofEventHandler.EventNameSpaceConstants All concrete subclasses ofEventshould define there own 'name space' or hierarchical name, thus allowing interested parties to subscribe forEvents selectively.FailedMessageRetrierImp Component which consumesAdaptrisMessages and, based on message metadata, resubmits them to theWorkflowwhich processed them originally.FixedIntervalPoller Implementation ofPollerwhich polls at a configurable fixed interval.FormattedFilenameCreator Implementation of FileNameCreator that usesString.format(String, Object...).GaussianIntervalPoller Implementation of Poller which polls at a random interval with a normal distribution.HeartbeatEvent StandardAdapterheartbeat event.InitialisedState Represents initialisedStateManagedComponents and implements permitted transitions.JndiContextFactory ListenerCallbackHelper MessageLifecycleEvent Container for message lifecycle events (MleMarkers) for implementations ofAdaptrisMessage.MessageLoggerImpl MetadataCollection A container class for handling aCollectionofMetadataElementinstance.MetadataElement A key-value pair ofStringmetadata.MetadataFileNameCreator Implementation ofFileNameCreatorwhich obtains the file name to use from message metadata.MimeEncoder Implementation ofAdaptrisMessageEncoderthat storesAdaptrisMessagepayload and metadata as a mime-encoded multipart message.MimeEncoderImpl<T,S> MleMarker Records information about activities (generallyServiceimplementations) performed on aAdaptrisMessageduring a workflow.MultiPayloadAdaptrisMessageImp The standard implementation of multi-payload messages;MultiPayloadAdaptrisMessageimplementation created byMultiPayloadMessageFactory.MultiPayloadMessageFactory The multi-payload message factory which returns an implementations ofMultiPayloadAdaptrisMessage.MultiPayloadMessageMimeEncoder Multi-payload message MIME encoder.MultiProducerWorkflow Implementation ofWorkflowthat contains multiple producers.NoOpConnection Base Implementation of a no-op connection.NoRetries This is a dummy for marshalling purposes.NullConnection No Op connectionNullConnectionErrorHandler Implementation ofConnectionErrorHandlerfor use with polling consumers where you do not want an Exception thrown back to run to re-init the Channel.NullMessageConsumer Null implementation ofAdaptrisMessageConsumer.NullMessageProducer Null implementation ofAdaptrisMessageProducer.NullOutOfStateHandler Implementation of theOutOfStateHandlerwhich does no checks.NullProcessingExceptionHandler Null implementation of Processing Exceptions.NullProduceExceptionHandler Deprecated. since 4.2.0NullService Null implementation ofService.OutOfStateHandlerImp Abstract implementation of theOutOfStateHandler.PollerImp Partial implementation ofPoller.PollingTrigger Periodically sends a template message to trigger aWorkflowPoolingWorkflow A Workflow that pools ServiceCollections.ProduceExceptionHandlerImp Deprecated. since 4.2.0ProduceOnlyProducerImp Convenience class that only supports produce rather than request.QuartzCronPoller Implementation ofPollerwhich provides cron style scheduled polling based on the Quartz project.QuartzCronPoller.MyProcessJob RaiseExceptionOutOfStateHandler This implementation of theOutOfStateHandlerwill simply throw anOutOfStateExceptionevery time when aStateManagedComponentis 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 ofWorkflowto handle synchronous replies.ResolveFromPayloadUsingXPath RestartProduceExceptionHandler Deprecated. since 3.10.2RetryMessageErrorHandler 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.SaferXMLResolver Resolver implementation that resolves and escapes XML content.ScheduledTaskPoller SerializableAdaptrisMessage The SerializableAdaptrisMessage simply represents an AdaptrisMessage that can be serialized.ServiceCollectionImp Behaviour common toServiceCollections.ServiceImp Implementation of default / common behaviour forServices.ServiceList Implementation ofServiceCollectionwith an ordered list ofServices.ServiceListBase SharedComponent SharedComponentList A common store for components.SharedConnection A connection instance that references a connection made available viaSharedComponentList.SharedService A Service instance that references a Service made available viaSharedComponentList.SharedServiceImpl StandaloneConsumer Wrapper class for aAdaptrisMessageConsumerand aAdaptrisConnection.StandaloneProducer Wrapper for aAdaptrisConnectionand aAdaptrisMessageProducerfor convenience.StandaloneRequestor StandaloneProducer extension that allows request reply functionality within a serviceStandardProcessingExceptionHandler ProcessingExceptionHandler implementation that contains a single service to apply when a message fails.StandardWorkflow Standard implementation ofWorkflow.StandardWorkflowImpl StartedState Represents startedStateManagedComponents and implements permitted transitions.StaticPollingTemplate Provides a static template forPollingTrigger.StoppedState Represents stoppedStateManagedComponents 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 theOutOfStateHandlerwill simply wait on the current Thread for theStateManagedComponentto be in the correct/expected state.WorkflowImp Partial implementation ofWorkflow.WorkflowList Container for a collection ofWorkflows.WorkflowWithObjectPool A Workflow that has a object pool of ServiceCollectionsXStreamJsonMarshaller JSON implementation ofAdaptrisMarshallerusing XStream.XStreamMarshaller XStream version ofAdaptrisMarshallerXStreamMarshallerImpl Abstract XStream version ofAdaptrisMarshaller -
Enum Summary Enum Description AdapterMarshallerFactory.MarshallingOutput ConfiguredComponentState -
Exception Summary Exception Description CoreException StandardExceptionin thecorepackage and sub-packages.OutOfStateException ProduceException Exceptionthrown byAdaptrisMessageProducers.ServiceException Exceptionthrown byServices.UnresolvedMetadataException