Package com.adaptris.core

Interface ComponentLifecycle

All Known Subinterfaces:
AccessTokenBuilder, AccessTokenWriter, AdaptrisComponent, AdaptrisConnection, AdaptrisMessageConsumer, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, AggregatingConsumer<T>, AggregatingConsumeService<T>, AggregatingJmsConsumer, Cache, Condition, ConnectedService, ConnectionErrorHandler, DynamicPollingTemplate.TemplateProvider, EventHandler, FailedMessageRetrier, IdentityBuilder, IdentityVerifier, MessageCache, MessageErrorDigester, MessageTypeTranslator, MessageValidator, Poller, PollingTrigger.MessageProvider, ProcessedItemCache, ProcessingExceptionHandler, ProducerSessionFactory, ResultSetTranslator, RetryStore, Service, ServiceCollection, ServiceExtractor, ServiceWrapper, StateManagedComponent, StateManagedComponentContainer, StatisticManager, SyntaxIdentifier, TimestampGenerator, TransactionManager, Workflow, WorkflowInterceptor
All Known Implementing Classes:
AbstractJdbcSequenceNumberService, AcknowledgeService, ActiveJmsConnectionErrorHandler, Adapter, AdaptrisConnectionImp, AdaptrisMessageConsumerImp, AdaptrisMessageProducerImp, AdaptrisMessageWorkerImp, AdaptrisPollingConsumer, AddExtendedLoggingContext, AddFormattedMetadataService, AddLoggingContext, AddMetadataService, AddNamespaceObjectMetadata, AddPayloadService, AddTimestampMetadataService, AddToCacheService, AddValueToCache, AdvancedJdbcPooledConnection, AdvancedMessageSplitterService, AggregatingConsumerImpl, AggregatingConsumeServiceImpl, AggregatingFsConsumer, AggregatingFsConsumeService, AggregatingFtpConsumer, AggregatingFtpConsumeService, AggregatingJmsConsumeService, AggregatingQueueConsumer, AllowsRetriesConnection, AllRowsMetadataTranslator, AlwaysFailService, AlwaysFailVerifier, AlwaysMatchSyntaxIdentifier, AutoConvertMessageTranslator, Base64DecodeMetadataService, Base64DecodeService, Base64EncodeMetadataService, Base64EncodeService, Base64MetadataService, Base64Service, BaseJmsPollingConsumerImpl, BaseStatisticManager, BasicJavaxJmsMessageTranslator, BasicJettyConsumer, BasicMessageSplitterService, BasicXmlSchemaValidator, BlobMessageTranslator, BranchingHttpRequestService, BranchingServiceCollection, BranchingServiceEnabler, BranchingServiceImp, BytesMessageTranslator, CacheConnection, CacheServiceBase, CacheServiceImpl, Case, CaseDefault, ChangeCharEncodingService, Channel, ChannelCloseErrorHandler, ChannelList, CheckAndRetrieve, CheckCacheService, CheckMetadataValueService, CheckUniqueMetadataValueService, ClearCacheService, ClearExceptionService, ClearLoggingContext, CloneMessageServiceList, CompositeIdentityBuilder, ConditionAnd, ConditionExpression, ConditionImpl, ConditionListImpl, ConditionMetadata, ConditionNever, ConditionNot, ConditionOr, ConditionPayload, ConditionWithOperator, ConnectionErrorHandlerImp, ConvertObjectMetadataService, CopyMetadataService, CoreSecurityService, CreateQueryStringFromMetadata, DatabaseConnection, DecodingService, DecryptionService, DefaultEventHandler, DefaultFailedMessageRetrier, DefaultProducerSessionFactory, DefaultServiceExtractor, DefinedJmsProducer, DoWhile, DuplicateMessageRoutingService, DuplicateMetadataValueService, DynamicJmxOperationService, DynamicPollingTemplate, DynamicServiceExecutor, DynamicSharedService, ElseService, EmbeddedConnection, EmptyIdentityBuilder, EncodingService, EncryptionOnlyService, EncryptionService, EncryptionSigningService, EventHandlerBase, EventHandlerBase.EventEmissary, ExceptionHandlingServiceWrapper, ExceptionReportService, ExistsInCache, ExpiringMapCache, ExtendedXmlSchemaValidator, ExtractMetadataService, ExtractorWithConnection, FailedMessageRetrierImp, FailoverJdbcConnection, FailoverJmsConnection, FilesystemRetryStore, FileTransferConnection, FileTransferConnectionUsingPassword, FindAndReplaceService, FirstRowMetadataTranslator, FixedIntervalPoller, FlattenMimeParts, ForEach, FormDataFromMetadata, FormDataToMetadata, FsConsumer, FsConsumerImpl, FsImmediateEventPoller, FsProducer, FtpConnection, FtpConnectionImp, FtpConsumer, FtpConsumerImpl, FtpProducer, FtpRecursiveConsumer, FtpSslConnection, GaussianIntervalPoller, GenerateUniqueMetadataValueService, GetAndCacheOauthToken, GetOauthToken, GetValueFromCache, GunzipService, GzipService, HexToStringService, HttpConnection, HttpProducer, HttpRequestService, HttpRequestServiceImpl, HttpsConnection, IdentityBuilderImpl, IdentityVerifierImpl, IfElse, InFlightWorkflowInterceptor, InlineItemCache, InputOutputService, JdbcBatchingDataCaptureService, JdbcConnection, JdbcDataCaptureService, JdbcDataCaptureServiceImpl, JdbcDataQueryService, JdbcIteratingDataCaptureServiceImpl, JdbcMapInsert, JdbcMapUpsert, JdbcPooledConnection, JdbcPooledConnectionImpl, JdbcRawDataCaptureService, JdbcRetryStore, JdbcService, JdbcServiceList, JdbcServiceWithParameters, JdbcStoredProcedureProducer, JettyAsyncWorkflowInterceptor, JettyConnection, JettyHashUserRealmVerifier, JettyMessageConsumer, JettyNoBacklogInterceptor, JettyPoolingWorkflowInterceptor, JettyResponseService, JettyRouteCondition, JettyRouteSpec, JettyRoutingService, JettyWorkflowInterceptorImpl, JmsAsyncProducer, JmsAsyncProducerEventHandler, JmsConnection, JmsConnectionErrorHandler, JmsConnectionErrorHandlerImpl, JmsConsumer, JmsConsumerImpl, JmsPollingConsumer, JmsPollingConsumerImpl, JmsProducer, JmsProducerImpl, JmsSyncConsumer, JmsTransactedWorkflow, JmxConnection, JmxNotificationConsumer, JmxOperationCallService, JmxOperationImpl, JmxOperationServiceImpl, JmxSubmitMessageInterceptor, JmxWaitService, LargeFsConsumer, LargeFsProducer, LargeMessageWorkflow, LastMessageTimestampGenerator, LoggingContextWorkflowInterceptor, LoggingService, LoggingServiceImpl, LogMessageService, LruBoundedMessageCache, MapMessageTranslator, MapMetadataService, MappedMetadataIdentityBuilder, MarshallingItemCache, MergeResultSetIntoXmlPayload, MessageCountNotification, MessageCountProducerSessionFactory, MessageErrorDigesterImp, MessageMetricsInterceptor, MessageMetricsInterceptorByMetadata, MessageMetricsInterceptorImpl, MessageSizeProducerSessionFactory, MessageSplitterServiceImp, MessageThresholdNotification, MessageTypeTranslatorImp, MessageValidatorImpl, MetadataAccessTokenWriter, MetadataAppenderService, MetadataBranchingServiceImp, MetadataComparisonService, MetadataCountInterceptor, MetadataExistsBranchingService, MetadataFilterService, MetadataHashingService, MetadataIdentityBuilder, MetadataIdentityBuilderImpl, MetadataIdentitySequenceNumberService, MetadataIdentityVerifier, MetadataKeyToCapitalCase, MetadataKeyToLowerCase, MetadataKeyToUpperCase, MetadataMetricsInterceptorImpl, MetadataProducerSessionFactory, MetadataResultSetTranslatorImpl, MetadataServiceImpl, MetadataToPayloadService, MetadataTotalsInterceptor, MetadataValueBranchingService, MetadataValueEscapeDoubleQuote, MetadataValueEscapeSingleQuote, MetadataValueToLowerCase, MetadataValueToUpperCase, MetricsInterceptorImpl, MimePartSelector, MimeServiceExtractor, MovingNonDeletingFsConsumer, MultipartMessageBuilder, MultiPayloadXmlTransformService, MultiProducerWorkflow, NoCache, NonDeletingFsConsumer, NoOpConnection, NoOpResultSetTranslator, NoRetries, NotifyingInterceptor, NotifyingInterceptorByCount, NullCacheImplementation, NullConnection, NullConnectionErrorHandler, NullMessageConsumer, NullMessageErrorDigester, NullMessageProducer, NullProcessingExceptionHandler, NullService, OauthTokenGetter, ObjectMessageTranslator, OffsetTimestampGenerator, PasConsumer, PasPollingConsumer, PasProducer, PayloadFromTemplateService, PayloadHashingService, PayloadPathDecryptionService, PayloadPathEncryptionService, PayloadToMetadataService, PerMessageProducerSessionFactory, PluggableJdbcPooledConnection, PollerImp, PollingTrigger, PooledSplitJoinService, PoolingMessageSplitterService, PoolingWorkflow, ProduceOnlyProducerImp, ProducerSessionFactoryImpl, ProducingStatisticManager, PtpConsumer, PtpPollingConsumer, PtpProducer, QuartzCronPoller, RandomIntervalPoller, ReadFileService, ReadMetadataFromFilesystem, ReformatDateService, ReformatMetadata, ReformatMetadataKey, RegexpMetadataService, RegexpService, RegexpSyntaxIdentifier, RelaxedFtpConsumer, RelaxedFtpProducer, RemoveFromCacheService, RemoveKeyFromCache, RemoveLoggingContext, ReplaceMetadataValue, ReportBuilder, RequestReplyProducerBase, RequestReplyProducerImp, RequestReplyWorkflow, ResolveExpressionService, ResponseProducerImpl, ResultSetTranslatorBase, ResultSetTranslatorImp, RetrieveFromCacheService, RetryFromJetty, RetryingCacheProxy, RetryingServiceWrapper, RetryMessageErrorHandler, RetryMessageErrorHandlerImp, RetryMessagesService, RetryOnceStandaloneProducer, RetryServiceImp, RetryStoreDeleteService, RetryStoreListService, RetryStoreServiceImpl, RetryStoreWriteService, RootProcessingExceptionHandler, ScheduledTaskPoller, ServiceCollectionImp, ServiceExtractorImpl, ServiceFromCache, ServiceFromDatabase, ServiceFromDataInputParameter, ServiceFromUrl, ServiceImp, ServiceList, ServiceListBase, SharedComponentList, SharedConnection, SharedService, SharedServiceImpl, SharedTransactionManager, ShortCutJettyResponse, SigningService, SimplePayloadResultSetTranslator, SimpleSequenceNumberService, SingleKeyCacheService, SingleKeyValueCacheImpl, SizeBasedBranchingService, SlowMessageNotification, SplittingXmlPayloadTranslator, StandaloneConsumer, StandaloneProducer, StandaloneRequestor, StandardHttpProducer, StandardMessageErrorDigester, StandardProcessingExceptionHandler, StandardResponseProducer, StandardSftpConnection, StandardStatisticManager, StandardWorkflow, StandardWorkflowImpl, StatelessServiceWrapper, StaticIdentitySequenceNumberService, StaticPollingTemplate, StopProcessingService, StoreMessageForRetryService, StoreMetadataValueService, StringToHexService, StyledResultTranslatorImp, Switch, SwitchPayloadService, SymmetricKeyCryptographyService, SyntaxBranchingService, SyntaxIdentifierBase, SyntaxIdentifierImpl, SyntaxRoutingService, SystemCommandExecutorService, TextMessageTranslator, ThenService, ThreadContextWorkflow, ThrottlingInterceptor, ThrowExceptionService, TimedInactivityProducerSessionFactory, TranscodingService, TraversingFsConsumer, TrimMetadataService, UrlDecodeMetadataService, UrlEncodedMetadataValues, UrlEncodeMetadataService, UseXmlCharsetAsEncodingService, Utf8BomRemover, ValidateMetadataService, VerifyIdentityService, WaitService, While, WorkflowImp, WorkflowInterceptorImpl, WorkflowList, WorkflowWithObjectPool, WriteMetadataToFilesystem, XmlBasicValidator, XmlPayloadTranslator, XmlPayloadTranslatorImpl, XmlRuleValidator, XmlSchemaValidatorImpl, XmlSyntaxIdentifierImpl, XmlTransformService, XmlValidationService, XpathMetadataService, XpathNodeIdentifier, XpathObjectMetadataService, XPathService, XpathSyntaxIdentifier, XStreamItemCache
public interface ComponentLifecycle
Defines standard lifecycle operations for components in the framework. Refer to StateManagedComponent for methods which control permitted state transitions.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
    Closes the component.
    default void
    init()
    Initialises the component.
    default void
    start()
    Starts the component.
    default void
    stop()
    Stop the component

  • Method Details

    • init

      default void init() throws CoreException
      Initialises the component.

      Component initialisation includes config verification, creation of connections etc.

      Throws:
      CoreException - wrapping any underlying Exceptions
      Implementation Note:
      The default implementation is no-op

    • start

      default void start() throws CoreException
      Starts the component.

      Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

      Throws:
      CoreException - wrapping any underlying Exceptions
      Implementation Note:
      The default implementation is no-op

    • stop

      default void stop()
      Stop the component

      A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

      Implementation Note:
      The default implementation is no-op

    • close

      default void close()
      Closes the component.

      A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

      Implementation Note:
      The default implementation is no-op