Package com.adaptris.core

Interface StateManagedComponent

All Superinterfaces:
AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension
All Known Subinterfaces:
AdaptrisConnection, AggregatingConsumeService<T>, ConnectedService, DynamicPollingTemplate.TemplateProvider, EventHandler, Service, ServiceCollection, ServiceWrapper, StateManagedComponentContainer, Workflow
All Known Implementing Classes:
AbstractJdbcSequenceNumberService, AcknowledgeService, Adapter, AdaptrisConnectionImp, AdaptrisMessageConsumerImp, AdaptrisPollingConsumer, AddExtendedLoggingContext, AddFormattedMetadataService, AddLoggingContext, AddMetadataService, AddNamespaceObjectMetadata, AddPayloadService, AddTimestampMetadataService, AddToCacheService, AddValueToCache, AdvancedJdbcPooledConnection, AdvancedMessageSplitterService, AggregatingConsumeServiceImpl, AggregatingFsConsumeService, AggregatingFtpConsumeService, AggregatingJmsConsumeService, AllowsRetriesConnection, AlwaysFailService, Base64DecodeMetadataService, Base64DecodeService, Base64EncodeMetadataService, Base64EncodeService, Base64MetadataService, Base64Service, BaseJmsPollingConsumerImpl, BasicJettyConsumer, BasicMessageSplitterService, BranchingHttpRequestService, BranchingServiceCollection, BranchingServiceEnabler, BranchingServiceImp, CacheConnection, CacheServiceBase, CacheServiceImpl, ChangeCharEncodingService, Channel, CheckAndRetrieve, CheckCacheService, CheckMetadataValueService, CheckUniqueMetadataValueService, ClearCacheService, ClearExceptionService, ClearLoggingContext, CloneMessageServiceList, ConvertObjectMetadataService, CopyMetadataService, CoreSecurityService, CreateQueryStringFromMetadata, DatabaseConnection, DecodingService, DecryptionService, DefaultEventHandler, DoWhile, DuplicateMessageRoutingService, DuplicateMetadataValueService, DynamicJmxOperationService, DynamicServiceExecutor, DynamicSharedService, EmbeddedConnection, EncodingService, EncryptionOnlyService, EncryptionService, EncryptionSigningService, EventHandlerBase, ExceptionHandlingServiceWrapper, ExceptionReportService, ExtractMetadataService, FailoverJdbcConnection, FailoverJmsConnection, FileTransferConnection, FileTransferConnectionUsingPassword, FindAndReplaceService, FlattenMimeParts, ForEach, FormDataFromMetadata, FormDataToMetadata, FsConsumer, FsConsumerImpl, FtpConnection, FtpConnectionImp, FtpConsumer, FtpConsumerImpl, FtpRecursiveConsumer, FtpSslConnection, GenerateUniqueMetadataValueService, GetAndCacheOauthToken, GetOauthToken, GetValueFromCache, GunzipService, GzipService, HexToStringService, HttpConnection, HttpRequestService, HttpRequestServiceImpl, HttpsConnection, IfElse, InFlightWorkflowInterceptor, InputOutputService, JdbcBatchingDataCaptureService, JdbcConnection, JdbcDataCaptureService, JdbcDataCaptureServiceImpl, JdbcDataQueryService, JdbcIteratingDataCaptureServiceImpl, JdbcMapInsert, JdbcMapUpsert, JdbcPooledConnection, JdbcPooledConnectionImpl, JdbcRawDataCaptureService, JdbcService, JdbcServiceList, JdbcServiceWithParameters, JettyAsyncWorkflowInterceptor, JettyConnection, JettyMessageConsumer, JettyNoBacklogInterceptor, JettyPoolingWorkflowInterceptor, JettyResponseService, JettyRoutingService, JettyWorkflowInterceptorImpl, JmsConnection, JmsConsumer, JmsConsumerImpl, JmsPollingConsumer, JmsPollingConsumerImpl, JmsSyncConsumer, JmsTransactedWorkflow, JmxConnection, JmxNotificationConsumer, JmxOperationCallService, JmxOperationImpl, JmxOperationServiceImpl, JmxWaitService, LargeFsConsumer, LargeMessageWorkflow, LoggingContextWorkflowInterceptor, LoggingService, LoggingServiceImpl, LogMessageService, MapMetadataService, MessageCountNotification, MessageMetricsInterceptor, MessageMetricsInterceptorByMetadata, MessageMetricsInterceptorImpl, MessageSplitterServiceImp, MessageThresholdNotification, MetadataAppenderService, MetadataBranchingServiceImp, MetadataComparisonService, MetadataCountInterceptor, MetadataExistsBranchingService, MetadataFilterService, MetadataHashingService, MetadataIdentitySequenceNumberService, MetadataKeyToCapitalCase, MetadataKeyToLowerCase, MetadataKeyToUpperCase, MetadataMetricsInterceptorImpl, MetadataServiceImpl, MetadataToPayloadService, MetadataTotalsInterceptor, MetadataValueBranchingService, MetadataValueEscapeDoubleQuote, MetadataValueEscapeSingleQuote, MetadataValueToLowerCase, MetadataValueToUpperCase, MetricsInterceptorImpl, MimePartSelector, MovingNonDeletingFsConsumer, MultipartMessageBuilder, MultiPayloadXmlTransformService, MultiProducerWorkflow, NonDeletingFsConsumer, NoOpConnection, NotifyingInterceptor, NotifyingInterceptorByCount, NullConnection, NullMessageConsumer, NullProcessingExceptionHandler, NullService, OauthTokenGetter, PasConsumer, PasPollingConsumer, PayloadFromTemplateService, PayloadHashingService, PayloadPathDecryptionService, PayloadPathEncryptionService, PayloadToMetadataService, PluggableJdbcPooledConnection, PollingTrigger, PooledSplitJoinService, PoolingMessageSplitterService, PoolingWorkflow, PtpConsumer, PtpPollingConsumer, ReadFileService, ReadMetadataFromFilesystem, ReformatDateService, ReformatMetadata, ReformatMetadataKey, RegexpMetadataService, RegexpService, RelaxedFtpConsumer, RemoveFromCacheService, RemoveKeyFromCache, RemoveLoggingContext, ReplaceMetadataValue, RequestReplyWorkflow, ResolveExpressionService, RetrieveFromCacheService, RetryingServiceWrapper, RetryMessageErrorHandler, RetryMessageErrorHandlerImp, RetryMessagesService, RetryOnceStandaloneProducer, RetryServiceImp, RetryStoreDeleteService, RetryStoreListService, RetryStoreServiceImpl, RetryStoreWriteService, RootProcessingExceptionHandler, ServiceCollectionImp, ServiceImp, ServiceList, ServiceListBase, SharedConnection, SharedService, SharedServiceImpl, ShortCutJettyResponse, SigningService, SimpleSequenceNumberService, SingleKeyCacheService, SingleKeyValueCacheImpl, SizeBasedBranchingService, SlowMessageNotification, StandaloneConsumer, StandaloneProducer, StandaloneRequestor, StandardProcessingExceptionHandler, StandardSftpConnection, StandardWorkflow, StandardWorkflowImpl, StatelessServiceWrapper, StaticIdentitySequenceNumberService, StopProcessingService, StoreMessageForRetryService, StoreMetadataValueService, StringToHexService, Switch, SwitchPayloadService, SymmetricKeyCryptographyService, SyntaxBranchingService, SyntaxRoutingService, SystemCommandExecutorService, ThreadContextWorkflow, ThrottlingInterceptor, ThrowExceptionService, TranscodingService, TraversingFsConsumer, TrimMetadataService, UrlDecodeMetadataService, UrlEncodedMetadataValues, UrlEncodeMetadataService, UseXmlCharsetAsEncodingService, Utf8BomRemover, ValidateMetadataService, VerifyIdentityService, WaitService, While, WorkflowImp, WorkflowInterceptorImpl, WorkflowWithObjectPool, WriteMetadataToFilesystem, XmlTransformService, XmlValidationService, XpathMetadataService, XpathObjectMetadataService, XPathService
public interface StateManagedComponent extends AdaptrisComponent

Specifies methods for components which manage state transitions.

See Also:

  • Method Details

    • retrieveComponentState

      ComponentState retrieveComponentState()

      Returns the last recorde ComponentState.

      Returns:
      the current ComponentState

    • changeState

      void changeState(ComponentState newState)

      Updates the state for the component ComponentState.

    • requestInit

      void requestInit() throws CoreException

      Request this component is init'd.

      Throws:
      CoreException - wrapping any underlying Exceptions

    • requestStart

      void requestStart() throws CoreException

      Request this component is started.

      Throws:
      CoreException - wrapping any underlying Exceptions

    • requestStop

      void requestStop()

      Request this component is stopped.

    • requestClose

      void requestClose()

      Request this component is closed.