Class ServiceHelper

java.lang.Object

org.apache.camel.support.service.ServiceHelper

public final class ServiceHelper
extends Object

A collection of helper methods for working with Service objects.

Method Summary

Modifier and Type	Method	Description
static void	buildService(@Nullable Object value)	Builds the given value if it's a Service or a collection of it.
static void	buildService(@Nullable Object @Nullable ... services)	Builds each element of the given services if services itself is not null, otherwise this method would return immediately.
static Set<Service>	getChildServices(Service service)	Gathers all child services by navigating the service to recursively gather all child services.
static Set<Service>	getChildServices(Service service, boolean includeErrorHandler)	Gathers all child services by navigating the service to recursively gather all child services.
static void	initService(@Nullable Object value)	Initializes the given value if it's a Service or a collection of it.
static void	initService(@Nullable Object @Nullable ... services)	Initializes each element of the given services if services itself is not null, otherwise this method would return immediately.
static boolean	isStarted(@Nullable Object value)	Is the given service starting or already started?
static boolean	isStarted(@Nullable StatefulService service)	Is the given service starting or already started?
static boolean	isStopped(@Nullable Object value)	Is the given service stopping or already stopped?
static boolean	isStopped(@Nullable StatefulService service)	Is the given service stopping or already stopped?
static boolean	isSuspended(@Nullable Object value)	Is the given service suspending or already suspended?
static boolean	isSuspended(@Nullable StatefulService service)	Is the given service suspending or already suspended?
static boolean	resumeService(@Nullable Object service)	Resumes the given service.
static void	resumeServices(@Nullable Collection<?> services)	Resumes each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	startService(@Nullable Iterable<?> value)	Starts the given value if it's a Service or a collection of it.
static void	startService(@Nullable Object value)	Starts the given value if it's a Service or a collection of it.
static void	startService(@Nullable Object @Nullable ... services)	Starts each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	startService(@Nullable Service service)	Starts the given value if it's a Service or a collection of it.
static void	stopAndShutdownService(@Nullable Object value)	Stops and shutdowns the given service, rethrowing the first exception caught.
static void	stopAndShutdownService(@Nullable ShutdownableService service)	Stops and shutdowns the given service, rethrowing the first exception caught.
static void	stopAndShutdownServices(@Nullable Object @Nullable ... services)	Stops and shutdowns each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	stopAndShutdownServices(@Nullable Collection<?> services)	Stops and shutdowns each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	stopService(@Nullable Iterable<?> value)	Stops the given value, rethrowing the first exception caught.
static void	stopService(@Nullable Object value)	Stops the given value, rethrowing the first exception caught.
static void	stopService(@Nullable Object @Nullable ... services)	Stops each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	stopService(@Nullable Collection<?> services)	Stops each element of the given services if services itself is not null, otherwise this method would return immediately.
static void	stopService(@Nullable Service service)	Stops the given value, rethrowing the first exception caught.
static boolean	suspendService(@Nullable Object service)	Suspends the given service.
static void	suspendServices(@Nullable Collection<?> services)	Suspends each element of the given services if services itself is not null, otherwise this method would return immediately.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

buildService

public static void buildService(@Nullable Object value)

Builds the given value if it's a Service or a collection of it.

Calling this method has no effect if value is null.

buildService

public static void buildService(@Nullable Object @Nullable ... services)

Builds each element of the given services if services itself is not null, otherwise this method would return immediately.

See Also:

• buildService(Object)

initService

public static void initService(@Nullable Object value)

Initializes the given value if it's a Service or a collection of it.

Calling this method has no effect if value is null.

initService

public static void initService(@Nullable Object @Nullable ... services)

Initializes each element of the given services if services itself is not null, otherwise this method would return immediately.

See Also:

• initService(Object)

startService

public static void startService(@Nullable Object value)

Starts the given value if it's a Service or a collection of it.

Calling this method has no effect if value is null.

startService

public static void startService(@Nullable Service service)

Starts the given value if it's a Service or a collection of it.

Calling this method has no effect if value is null.

startService

public static void startService(@Nullable Iterable<?> value)

Starts the given value if it's a Service or a collection of it.

Calling this method has no effect if value is null.

startService

public static void startService(@Nullable Object @Nullable ... services)

Starts each element of the given services if services itself is not null, otherwise this method would return immediately.

See Also:

• startService(Object)

stopService

public static void stopService(@Nullable Object @Nullable ... services)

Stops each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while stopping the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• stopService(Collection)

stopService

public static void stopService(@Nullable Object value)

Stops the given value, rethrowing the first exception caught.

Calling this method has no effect if value is null.

See Also:

• Service.stop()
• stopService(Collection)

stopService

public static void stopService(@Nullable Service service)

Stops the given value, rethrowing the first exception caught.

Calling this method has no effect if value is null.

See Also:

• Service.stop()
• stopService(Collection)

stopService

public static void stopService(@Nullable Iterable<?> value)

Stops the given value, rethrowing the first exception caught.

Calling this method has no effect if value is null.

See Also:

• Service.stop()
• stopService(Collection)

stopService

public static void stopService(@Nullable Collection<?> services)

Stops each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while stopping the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• stopService(Object)

stopAndShutdownServices

public static void stopAndShutdownServices(@Nullable Object @Nullable ... services)

Stops and shutdowns each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while stopping/shutting down the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• stopAndShutdownServices(Collection)

stopAndShutdownService

public static void stopAndShutdownService(@Nullable Object value)

Stops and shutdowns the given service, rethrowing the first exception caught.

Calling this method has no effect if value is null.

See Also:

• stopService(Object)
• ShutdownableService.shutdown()

stopAndShutdownService

public static void stopAndShutdownService(@Nullable ShutdownableService service)

Stops and shutdowns the given service, rethrowing the first exception caught.

Calling this method has no effect if value is null.

See Also:

• stopService(Object)
• ShutdownableService.shutdown()

stopAndShutdownServices

public static void stopAndShutdownServices(@Nullable Collection<?> services)

Stops and shutdowns each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while stopping/shutting down the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• stopService(Object)
• ShutdownableService.shutdown()

resumeServices

public static void resumeServices(@Nullable Collection<?> services)

Resumes each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while resuming the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• resumeService(Object)

resumeService

public static boolean resumeService(@Nullable Object service)

Resumes the given service.

If service is both Suspendable and SuspendableService then its SuspendableService.resume() is called but only if service is already suspended.

If service is not a Suspendable and SuspendableService then its Service.start() is called.

Calling this method has no effect if service is null.

Parameters:

service - the service

Returns:

true if either resume method or startService(Object) was called, false otherwise.

Throws:

Exception - is thrown if error occurred

See Also:

• startService(Object)

suspendServices

public static void suspendServices(@Nullable Collection<?> services)

Suspends each element of the given services if services itself is not null, otherwise this method would return immediately.

If there's any exception being thrown while suspending the elements one after the other this method would rethrow the first such exception being thrown.

See Also:

• suspendService(Object)

suspendService

public static boolean suspendService(@Nullable Object service)

Suspends the given service.

If service is both Suspendable and SuspendableService then its SuspendableService.suspend() is called but only if service is not already suspended.

If service is not a Suspendable and SuspendableService then its Service.stop() is called.

Calling this method has no effect if service is null.

Parameters:

service - the service

Returns:

true if either the suspend method or stopService(Object) was called, false otherwise.

Throws:

Exception - is thrown if error occurred

See Also:

• stopService(Object)

isStopped

public static boolean isStopped(@Nullable Object value)

Is the given service stopping or already stopped?

Returns:

true if stopping or already stopped, false otherwise

See Also:

• StatefulService.isStopping()
• StatefulService.isStopped()

isStopped

public static boolean isStopped(@Nullable StatefulService service)

Is the given service stopping or already stopped?

Returns:

true if stopping or already stopped, false otherwise

See Also:

• StatefulService.isStopping()
• StatefulService.isStopped()

isStarted

public static boolean isStarted(@Nullable Object value)

Is the given service starting or already started?

Returns:

true if starting or already started, false otherwise

See Also:

• StatefulService.isStarting()
• StatefulService.isStarted()

isStarted

public static boolean isStarted(@Nullable StatefulService service)

Is the given service starting or already started?

Returns:

true if starting or already started, false otherwise

See Also:

• StatefulService.isStarting()
• StatefulService.isStarted()

isSuspended

public static boolean isSuspended(@Nullable Object value)

Is the given service suspending or already suspended?

Returns:

true if suspending or already suspended, false otherwise

See Also:

• StatefulService.isSuspending()
• SuspendableService.isSuspended()

isSuspended

public static boolean isSuspended(@Nullable StatefulService service)

Is the given service suspending or already suspended?

Returns:

true if suspending or already suspended, false otherwise

See Also:

• StatefulService.isSuspending()
• SuspendableService.isSuspended()

getChildServices

public static Set<Service> getChildServices(Service service)

Gathers all child services by navigating the service to recursively gather all child services.

The returned set does not include the children being error handler.

Parameters:

service - the service

Returns:

the services, including the parent service, and all its children

getChildServices

public static Set<Service> getChildServices(Service service,
 boolean includeErrorHandler)

Gathers all child services by navigating the service to recursively gather all child services.

Parameters:

service - the service

includeErrorHandler - whether to include error handlers

Returns:

the services, including the parent service, and all its children