org.apache.camel

Interface StatefulService

All Superinterfaces:

Service, ShutdownableService, SuspendableService

All Known Implementing Classes:

AbstractApiComponent, AbstractApiConsumer, AbstractApiEndpoint, AbstractApiProducer, AggregateProcessor, AggregationStrategyBeanAdapter, AOPProcessor, BacklogDebugger, BacklogTracer, BaseTypeConverterRegistry, BatchProcessor, BeanComponent, BeanEndpoint, BeanProcessor, BindingComponent, BindingConsumerProcessor, BindingEndpoint, BindingNameComponent, BindingProducer, BrowseComponent, BrowseEndpoint, CamelInternalProcessor, CamelLogger, CatchProcessor, ChildServiceSupport, ChoiceProcessor, CircuitBreakerLoadBalancer, ClassComponent, CollectionProducer, ConsumerCache, ControlBusComponent, ControlBusEndpoint, ControlBusProducer, ConvertBodyProcessor, DataFormatBinding, DataFormatComponent, DataFormatEndpoint, DataSetComponent, DataSetConsumer, DataSetEndpoint, DeadLetterChannel, DefaultAsyncProducer, DefaultCamelContext, DefaultChannel, DefaultComponent, DefaultConsumer, DefaultConsumerTemplate, DefaultEndpoint, DefaultErrorHandler, DefaultExecutorServiceManager, DefaultExecutorServiceStrategy, DefaultInflightRepository, DefaultManagementAgent, DefaultManagementLifecycleStrategy, DefaultManagementStrategy, DefaultPackageScanClassResolver, DefaultPollingEndpoint, DefaultProducer, DefaultProducerServicePool, DefaultProducerTemplate, DefaultRestRegistry, DefaultRoute, DefaultRuntimeEndpointRegistry, DefaultScheduledPollConsumer, DefaultScheduledPollConsumerScheduler, DefaultServicePool, DefaultShutdownStrategy, DefaultStreamCachingStrategy, DefaultTimeoutMap, DefaultTypeConverter, Delayer, DelayInterceptor, DelayProcessorSupport, DelegateAsyncProcessor, DelegateProcessor, DelegateSyncProcessor, DirectBlockingProducer, DirectComponent, DirectConsumer, DirectEndpoint, DirectProducer, DirectVmBlockingProducer, DirectVmComponent, DirectVmConsumer, DirectVmEndpoint, DirectVmProcessor, DirectVmProducer, DynamicRouter, EmptyProducerCache, Enricher, ErrorHandlerSupport, EventDrivenConsumerRoute, EventDrivenPollingConsumer, EventNotifierSupport, EventNotifierSupport, ExchangePatternProcessor, FailOverLoadBalancer, FatalFallbackErrorHandler, FileComponent, FileConsumer, FileEndpoint, FileIdempotentRepository, FilterProcessor, FinallyProcessor, GenericFileComponent, GenericFileConsumer, GenericFileEndpoint, GenericFileProducer, HandleFaultInterceptor, HeaderFilterStrategyComponent, IdempotentConsumer, InstrumentationProcessor, InterceptEndpointProcessor, InterceptorToAsyncProcessorBridge, JmxNotificationEventNotifier, LanguageComponent, LanguageEndpoint, LanguageProducer, LazyLoadingTypeConverter, LoadBalancerConsumer, LoadBalancerSupport, LogComponent, LogEndpoint, LoggingErrorHandler, LoggingEventNotifier, LogProcessor, LogProducer, LoopProcessor, Main, Main, MainSupport, MainSupport, ManagedManagementStrategy, MarshalProcessor, MemoryAggregationRepository, MemoryIdempotentRepository, MockComponent, MockEndpoint, MulticastProcessor, OnCompletionProcessor, Pipeline, PollEnricher, PollingConsumerSupport, PredicateValidatingProcessor, ProcessorEndpoint, ProcessorPollingConsumer, ProducerCache, PropertiesComponent, PublishEventNotifier, QueueLoadBalancer, RandomLoadBalancer, RecipientList, RecipientListProcessor, RedeliveryErrorHandler, RefComponent, Resequencer, ResourceEndpoint, RestBindingProcessor, RestComponent, RestEndpoint, RollbackProcessor, RoundRobinLoadBalancer, RoutePolicySupport, RouteService, RoutingSlip, SamplingThrottler, ScheduledBatchPollingConsumer, ScheduledPollConsumer, ScheduledPollEndpoint, SedaComponent, SedaConsumer, SedaEndpoint, SedaPollingConsumer, SedaProducer, SendProcessor, ServiceSupport, ServiceSupport, SetBodyProcessor, SharedProducerServicePool, SimpleLoadBalancerSupport, SortProcessor, Splitter, StickyLoadBalancer, StopProcessor, StreamCachingInterceptor, StreamResequencer, StubComponent, TestComponent, TestEndpoint, ThreadsProcessor, Throttler, ThrottlingInflightRoutePolicy, ThroughputLogger, ThrowExceptionProcessor, TimerComponent, TimerConsumer, TimerEndpoint, TimerListenerManager, TopicLoadBalancer, TraceInterceptor, TransformProcessor, TryProcessor, UnmarshalProcessor, UriEndpointComponent, ValidatorComponent, VmComponent, WebSpherePackageScanClassResolver, WeightedLoadBalancer, WeightedRandomLoadBalancer, WeightedRoundRobinLoadBalancer, WireTapProcessor, WrapProcessor, XPathBuilder, XsltBuilder, XsltComponent, XsltEndpoint

public interface StatefulService
extends SuspendableService, ShutdownableService

A Service which has all the lifecycle events and offers details about its current state.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceStatus	getStatus() Returns the current status
String	getVersion() Returns the version of this service
boolean	isRunAllowed() Helper methods so the service knows if it should keep running.
boolean	isStarted() Whether the service is started
boolean	isStarting() Whether the service is starting
boolean	isStopped() Whether the service is stopped
boolean	isStopping() Whether the service is stopping
boolean	isSuspending() Whether the service is suspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.Service

start, stop

Method Detail

getStatus

ServiceStatus getStatus()

Returns the current status

Returns:

the current status

isStarted

boolean isStarted()

Whether the service is started

Returns:

true if this service has been started

isStarting

boolean isStarting()

Whether the service is starting

Returns:

true if this service is being started

isStopping

boolean isStopping()

Whether the service is stopping

Returns:

true if this service is in the process of stopping

isStopped

boolean isStopped()

Whether the service is stopped

Returns:

true if this service is stopped

isSuspending

boolean isSuspending()

Whether the service is suspending

Returns:

true if this service is in the process of suspending

isRunAllowed

boolean isRunAllowed()

Helper methods so the service knows if it should keep running. Returns false if the service is being stopped or is stopped.

Returns:

true if the service should continue to run.

getVersion

String getVersion()

Returns the version of this service

Returns:

the version