ComponentLifecycle (Base Interlok)

All Known Subinterfaces:

AccessTokenBuilder, AdaptrisComponent, AdaptrisConnection, AdaptrisMessageConsumer, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, AggregatingConsumer<T>, AggregatingConsumeService<T>, AggregatingJmsConsumer, Cache, ConnectedService, ConnectionErrorHandler, DynamicPollingTemplate.TemplateProvider, EventHandler, FailedMessageRetrier, IdentityBuilder, IdentityVerifier, LogHandler, MessageCache, MessageErrorDigester, MessageTypeTranslator, MessageValidator, Poller, PollingTrigger.MessageProvider, ProcessedItemCache, ProcessingExceptionHandler, ProducerSessionFactory, ResultSetTranslator, Service, ServiceCollection, ServiceExtractor, ServiceWrapper, StateManagedComponent, StateManagedComponentContainer, StatisticManager, TransactionManager, Workflow, WorkflowInterceptor

All Known Implementing Classes:

AbstractJdbcSequenceNumberService, ActiveJmsConnectionErrorHandler, Adapter, AdaptrisConnectionImp, AdaptrisMessageConsumerImp, AdaptrisMessageProducerImp, AdaptrisMessageWorkerImp, AdaptrisPollingConsumer, AddFormattedMetadataService, AddLoggingContext, AddMetadataService, AddNamespaceObjectMetadata, AddTimestampMetadataService, AddToCacheService, AdvancedJdbcPooledConnection, AdvancedMessageSplitterService, AggregatingConsumerImpl, AggregatingConsumeServiceImpl, AggregatingFsConsumer, AggregatingFsConsumeService, AggregatingFtpConsumer, AggregatingFtpConsumeService, AggregatingJmsConsumeService, AggregatingQueueConsumer, AllowsRetriesConnection, AllRowsMetadataTranslator, AlwaysFailService, AlwaysFailVerifier, AutoConvertMessageTranslator, Base64DecodeMetadataService, Base64DecodeService, Base64EncodeMetadataService, Base64EncodeService, BaseStatisticManager, BasicJavaxJmsMessageTranslator, BasicJettyConsumer, BasicMessageSplitterService, BlobMessageTranslator, BranchingHttpRequestService, BranchingServiceCollection, BranchingServiceEnabler, BranchingServiceImp, BytesMessageTranslator, CacheConnection, CacheServiceBase, ChangeCharEncodingService, Channel, ChannelCloseErrorHandler, ChannelList, CheckAndRetrieve, CheckCacheService, CheckMetadataValueService, CheckUniqueMetadataValueService, CloneMessageServiceList, CompositeIdentityBuilder, ConfirmServiceImp, ConnectionErrorHandlerImp, ConvertObjectMetadataService, CopyMetadataService, CoreSecurityService, CreateQueryStringFromMetadata, DatabaseConnection, DecodingService, DecryptionService, DefaultEventHandler, DefaultFailedMessageRetrier, DefaultMailConsumer, DefaultProducerSessionFactory, DefaultServiceExtractor, DefaultSmtpProducer, DefinedJmsProducer, DuplicateMessageRoutingService, DuplicateMetadataValueService, DynamicJmxOperationService, DynamicPollingTemplate, DynamicServiceExecutor, DynamicServiceLocator, DynamicSharedService, EmbeddedConnection, EmbeddedScriptingService, EmptyIdentityBuilder, EncodingService, EncryptionOnlyService, EncryptionService, EncryptionSigningService, EventHandlerBase, EventHandlerBase.EventEmissary, ExceptionHandlingServiceWrapper, ExceptionReportService, ExpiringMapCache, ExtractorWithConnection, FailedMessageRetrierImp, FailoverJdbcConnection, FailoverJmsConnection, FfTransformService, FileLogHandler, FileTransferConnection, FileTransferConnectionUsingPassword, FindAndReplaceService, FirstRowMetadataTranslator, FixedIntervalPoller, FlattenMimeParts, FsConsumer, FsConsumerImpl, FsImmediateEventPoller, FsProducer, FtpConnection, FtpConnectionImp, FtpConsumer, FtpConsumerImpl, FtpProducer, FtpSslConnection, GaussianIntervalPoller, GenerateUniqueMetadataValueService, GetOauthToken, GunzipService, GzipService, HexToStringService, HttpConnection, HttpProducer, HttpRequestService, HttpRequestServiceImpl, HttpsConnection, IdentityBuilderImpl, IdentityVerifierImpl, 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, JettyRoutingService, JettyWorkflowInterceptorImpl, JmsAsyncProducer, JmsConnection, JmsConnectionErrorHandler, JmsConnectionErrorHandlerImpl, JmsConsumer, JmsConsumerImpl, JmsPollingConsumer, JmsPollingConsumerImpl, JmsProducer, JmsProducerImpl, JmsReplyToWorkflow, JmsTransactedWorkflow, JmxConnection, JmxNotificationConsumer, JmxOperationCallService, JmxOperationImpl, JmxOperationServiceImpl, JmxSubmitMessageInterceptor, JmxWaitService, LargeFsConsumer, LargeFsProducer, LargeMessageWorkflow, LoggingContextWorkflowInterceptor, LoggingService, LoggingServiceImpl, LogHandlerImp, LogMessageService, LruBoundedMessageCache, MailConsumerImp, MailProducer, MapMessageTranslator, MapMetadataService, MappedMetadataIdentityBuilder, MarshallingItemCache, MergeResultSetIntoXmlPayload, MessageConsumer, MessageCountNotification, MessageCountProducerSessionFactory, MessageErrorDigesterImp, MessageMetricsInterceptor, MessageMetricsInterceptorByMetadata, MessageMetricsInterceptorImpl, MessageSizeProducerSessionFactory, MessageSplitterServiceImp, MessageThresholdNotification, MessageTypeTranslatorImp, MessageValidatorImpl, MetadataAppenderService, MetadataBranchingServiceImp, MetadataComparisonService, MetadataCountInterceptor, MetadataExistsBranchingService, MetadataFilterService, MetadataHashingService, MetadataIdentityBuilder, MetadataIdentityBuilderImpl, MetadataIdentitySequenceNumberService, MetadataIdentityVerifier, MetadataKeyToCapitalCase, MetadataKeyToLowerCase, MetadataKeyToUpperCase, MetadataMetricsInterceptorImpl, MetadataProducerSessionFactory, MetadataResultSetTranslatorImpl, MetadataServiceImpl, MetadataToPayloadService, MetadataTotalsInterceptor, MetadataValueBranchingService, MetadataValueToLowerCase, MetadataValueToUpperCase, MetricsInterceptorImpl, MimeHeadersAsMetadataService, MimePartSelector, MimeServiceExtractor, MovingNonDeletingFsConsumer, MultiAttachmentSmtpProducer, MultiProducerWorkflow, NoCache, NonDeletingFsConsumer, NoOpConnection, NoOpResultSetTranslator, NoRetries, NotifyingInterceptor, NotifyingInterceptorByCount, NullCacheImplementation, NullConnection, NullConnectionErrorHandler, NullLogHandler, NullMessageConsumer, NullMessageErrorDigester, NullMessageProducer, NullProcessingExceptionHandler, NullService, ObjectMessageTranslator, ParsingMailConsumerImpl, PasConsumer, PasPollingConsumer, PasProducer, PayloadFromMetadataService, PayloadHashingService, PayloadToMetadataService, PerMessageProducerSessionFactory, PollerImp, PollingTrigger, PoolingMessageSplitterService, PoolingSplitJoinService, PoolingWorkflow, ProduceOnlyProducerImp, ProducerSessionFactoryImpl, ProducingStatisticManager, PtpConsumer, PtpPollingConsumer, PtpProducer, QuartzCronPoller, RandomIntervalPoller, RawMailConsumer, ReadFileService, ReadMetadataFromFilesystem, ReformatDateService, ReformatMetadata, ReformatMetadataKey, RegexpMetadataService, RegexpService, RelaxedFtpConsumer, RelaxedFtpProducer, RemoveFromCacheService, RemoveLoggingContext, ReplaceMetadataValue, RequestParameterConverterService, RequestReplyProducerImp, RequestReplyWorkflow, ResponseProducerImpl, ResultSetTranslatorBase, ResultSetTranslatorImp, RetrieveFromCacheService, RetryingCacheProxy, RetryingServiceWrapper, RetryMessageErrorHandler, RetryMessageErrorHandlerImp, RetryOnceStandaloneProducer, RootProcessingExceptionHandler, ScheduledTaskPoller, ScriptingService, ScriptingServiceImp, ServiceCollectionImp, ServiceExtractorImpl, ServiceFromCache, ServiceFromDatabase, ServiceFromDataInputParameter, ServiceFromUrl, ServiceImp, ServiceList, ServiceListBase, SetUpConfirmationServiceImp, SftpConnection, SftpKeyAuthConnection, SharedComponentList, SharedConnection, SharedService, SharedServiceImpl, SharedTransactionManager, ShortCutJettyResponse, SigningService, SimplePayloadResultSetTranslator, SimpleSequenceNumberService, SizeBasedBranchingService, SlowMessageNotification, SplitJoinService, SplittingXmlPayloadTranslator, StandaloneConsumer, StandaloneProducer, StandaloneRequestor, StandardHttpProducer, StandardMessageErrorDigester, StandardProcessingExceptionHandler, StandardResponseProducer, StandardSftpConnection, StandardStatisticManager, StandardWorkflow, StandardWorkflowImpl, StatelessServiceWrapper, StaticIdentitySequenceNumberService, StaticPollingTemplate, StopProcessingService, StoreMetadataValueService, StringToHexService, StyledResultTranslatorImp, SymmetricKeyCryptographyService, SyntaxBranchingService, SyntaxRoutingService, SystemCommandExecutorService, TextMessageTranslator, ThrottlingInterceptor, ThrowExceptionService, TimedInactivityProducerSessionFactory, TranscodingService, TransformService, TraversingFsConsumer, TrimMetadataService, UrlDecodeMetadataService, UrlEncodeMetadataService, UseXmlCharsetAsEncodingService, Utf8BomRemover, ValidateMetadataService, VerifyIdentityService, WaitService, WorkflowImp, WorkflowInterceptorImpl, WorkflowList, WriteMetadataToFilesystem, XmlBasicValidator, XmlPayloadTranslator, XmlPayloadTranslatorImpl, XmlRuleValidator, XmlSchemaValidator, XmlTransformService, XmlValidationService, XpathMetadataService, XpathObjectMetadataService, XPathService, 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:

StateManagedComponent

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and 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 Detail
  - 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 Requirements:
    
    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 Requirements:
    
    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 Requirements:
    
    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 Requirements:
    
    The default implementation is no-op

Interface ComponentLifecycle

Method Summary

Method Detail

init

start

stop

close