org.apache.camel

Interface SuspendableService

All Superinterfaces:

Service

All Known Subinterfaces:

CamelContext, ModelCamelContext, StatefulService

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 SuspendableService
extends Service

A Service which is also capable of suspending and resuming.

This is useable for services which needs more fine grained control at runtime supporting suspension. Other services may select to mimic suspending by just stopping the service.

For example this is use by the JmsConsumer which suspends the Spring JMS listener instead of stopping the consumer totally.

Version:

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isSuspended() Tests whether the service is suspended or not.
void	resume() Resumes the service.
void	suspend() Suspends the service.

Methods inherited from interface org.apache.camel.Service

start, stop

Method Detail

suspend

void suspend()
             throws Exception

Suspends the service.

Throws:

Exception - is thrown if suspending failed

resume

void resume()
            throws Exception

Resumes the service.

Throws:

Exception - is thrown if resuming failed

isSuspended

boolean isSuspended()

Tests whether the service is suspended or not.

Returns:

true if suspended