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,TransactionManager,Workflow,WorkflowInterceptor
- All Known Implementing Classes:
AbstractJdbcSequenceNumberService,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,ConditionFunction,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,EmbeddedScriptingService,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,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,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,PasConsumer,PasPollingConsumer,PasProducer,PayloadFromTemplateService,PayloadHashingService,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,ResponseProducerImpl,ResultSetTranslatorBase,ResultSetTranslatorImp,RetrieveFromCacheService,RetryFromJetty,RetryingCacheProxy,RetryingServiceWrapper,RetryMessageErrorHandler,RetryMessageErrorHandlerImp,RetryOnceStandaloneProducer,RetryStoreDeleteService,RetryStoreListService,RetryStoreServiceImpl,RetryStoreWriteService,RootProcessingExceptionHandler,ScheduledTaskPoller,ScriptingService,ScriptingServiceImp,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,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 ComponentLifecycleDefines standard lifecycle operations for components in the framework. Refer toStateManagedComponentfor methods which control permitted state transitions.- See Also:
StateManagedComponent
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default voidclose()Closes the component.default voidinit()Initialises the component.default voidstart()Starts the component.default voidstop()Stop the component
-
-
-
Method Detail
-
init
default void init() throws CoreExceptionInitialises the component.Component initialisation includes config verification, creation of connections etc.
- Throws:
CoreException- wrapping any underlyingExceptions- Implementation Note:
- The default implementation is no-op
-
start
default void start() throws CoreExceptionStarts 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 underlyingExceptions- Implementation Note:
- The default implementation is no-op
-
stop
default void stop()
Stop the componentA stopped component is not expected to be ready to process messages. In the case of
AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing aRuntimeExceptionmay 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
RuntimeExceptionmay cause unintended consequences- Implementation Note:
- The default implementation is no-op
-
-