org.apache.jackrabbit.oak.spi.whiteboard

Class WhiteboardUtils

java.lang.Object

org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils

public class WhiteboardUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WhiteboardUtils.ScheduleExecutionInstanceTypes

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMX_OAK_DOMAIN JMX Domain name under which Oak related JMX MBeans are registered

Constructor Summary

Constructors

Constructor and Description
WhiteboardUtils()

Method Summary

Modifier and Type	Method and Description
static <T> T	getService(@NotNull Whiteboard wb, @NotNull Class<T> type) Returns the one of the currently available services from the whiteboard of the tracked type.
static <T> T	getService(@NotNull Whiteboard wb, @NotNull Class<T> type, @Nullable Predicate<T> predicate) Returns the one of the currently available services from the whiteboard of the tracked type.
static <T> T	getService(@NotNull Whiteboard wb, @NotNull Class<T> type, Predicate<T> predicate) Deprecated. use getService(Whiteboard, Class, Predicate) instead
static <T> @NotNull List<T>	getServices(@NotNull Whiteboard wb, @NotNull Class<T> type) Returns the currently available services from the whiteboard of the tracked type.
static <T> @NotNull List<T>	getServices(@NotNull Whiteboard wb, @NotNull Class<T> type, @Nullable Predicate<T> predicate) Returns the currently available services from the whiteboard of the tracked type.
static <T> @NotNull List<T>	getServices(@NotNull Whiteboard wb, @NotNull Class<T> type, Predicate<T> predicate) Deprecated. use getServices(Whiteboard, Class, java.util.function.Predicate) instead
static <T> Registration	registerMBean(Whiteboard whiteboard, Class<T> iface, T bean, String type, String name)
static <T> Registration	registerMBean(Whiteboard whiteboard, Class<T> iface, T bean, String type, String name, Map<String,String> attrs)
static Registration	scheduleWithFixedDelay(Whiteboard whiteboard, Runnable runnable, long delayInSeconds)
static Registration	scheduleWithFixedDelay(Whiteboard whiteboard, Runnable runnable, long delayInSeconds, boolean runOnSingleClusterNode, boolean useDedicatedPool)
static Registration	scheduleWithFixedDelay(Whiteboard whiteboard, Runnable runnable, Map<String,Object> extraProps, long delayInSeconds, boolean runOnSingleClusterNode, boolean useDedicatedPool)
static Registration	scheduleWithFixedDelay(Whiteboard whiteboard, Runnable runnable, Map<String,Object> extraProps, long delayInSeconds, WhiteboardUtils.ScheduleExecutionInstanceTypes scheduleExecutionInstanceTypes, boolean useDedicatedPool)

Methods inherited from class java.lang.Object

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

Field Detail

JMX_OAK_DOMAIN

public static final String JMX_OAK_DOMAIN

JMX Domain name under which Oak related JMX MBeans are registered

See Also:

Constant Field Values

Constructor Detail

WhiteboardUtils

public WhiteboardUtils()

Method Detail

scheduleWithFixedDelay

public static Registration scheduleWithFixedDelay(Whiteboard whiteboard,
                                                  Runnable runnable,
                                                  long delayInSeconds)

scheduleWithFixedDelay

public static Registration scheduleWithFixedDelay(Whiteboard whiteboard,
                                                  Runnable runnable,
                                                  long delayInSeconds,
                                                  boolean runOnSingleClusterNode,
                                                  boolean useDedicatedPool)

scheduleWithFixedDelay

public static Registration scheduleWithFixedDelay(Whiteboard whiteboard,
                                                  Runnable runnable,
                                                  Map<String,Object> extraProps,
                                                  long delayInSeconds,
                                                  boolean runOnSingleClusterNode,
                                                  boolean useDedicatedPool)

scheduleWithFixedDelay

public static Registration scheduleWithFixedDelay(Whiteboard whiteboard,
                                                  Runnable runnable,
                                                  Map<String,Object> extraProps,
                                                  long delayInSeconds,
                                                  WhiteboardUtils.ScheduleExecutionInstanceTypes scheduleExecutionInstanceTypes,
                                                  boolean useDedicatedPool)

registerMBean

public static <T> Registration registerMBean(Whiteboard whiteboard,
                                             Class<T> iface,
                                             T bean,
                                             String type,
                                             String name)

registerMBean

public static <T> Registration registerMBean(Whiteboard whiteboard,
                                             Class<T> iface,
                                             T bean,
                                             String type,
                                             String name,
                                             Map<String,String> attrs)

getServices

@NotNull
public static <T> @NotNull List<T> getServices(@NotNull
                                                        @NotNull Whiteboard wb,
                                                        @NotNull
                                                        @NotNull Class<T> type)

Returns the currently available services from the whiteboard of the tracked type. Note that the underlying tracker is closed automatically.

Parameters:

wb - the whiteboard

type - the service type

Returns:

a list of services

getService

@Nullable
public static <T> T getService(@NotNull
                                         @NotNull Whiteboard wb,
                                         @NotNull
                                         @NotNull Class<T> type)

Returns the one of the currently available services from the whiteboard of the tracked type. Note that the underlying tracker is closed automatically.

Returns:

one service or null

getServices

@NotNull
public static <T> @NotNull List<T> getServices(@NotNull
                                                        @NotNull Whiteboard wb,
                                                        @NotNull
                                                        @NotNull Class<T> type,
                                                        @Nullable
                                                        @Nullable Predicate<T> predicate)

Returns the currently available services from the whiteboard of the tracked type. If predicate is not null the returned list is limited to the ones that match the predicate. Note that the underlying tracker is stopped automatically after the services are returned.

Parameters:

wb - the whiteboard

type - the service type

predicate - filtering predicate or null

Returns:

a list of services

getServices

@NotNull
 @Deprecated
public static <T> @NotNull List<T> getServices(@NotNull
                                                                     @NotNull Whiteboard wb,
                                                                     @NotNull
                                                                     @NotNull Class<T> type,
                                                                     @Nullable
                                                                     Predicate<T> predicate)

Deprecated. use getServices(Whiteboard, Class, java.util.function.Predicate) instead

getService

@Nullable
public static <T> T getService(@NotNull
                                         @NotNull Whiteboard wb,
                                         @NotNull
                                         @NotNull Class<T> type,
                                         @Nullable
                                         @Nullable Predicate<T> predicate)

Returns the one of the currently available services from the whiteboard of the tracked type. If predicate is not null only a service that match the predicate is returned. Note that the underlying tracker is closed automatically.

Parameters:

wb - the whiteboard

type - the service type

predicate - filtering predicate or null

Returns:

one service or null

getService

@Nullable
 @Deprecated
public static <T> T getService(@NotNull
                                                      @NotNull Whiteboard wb,
                                                      @NotNull
                                                      @NotNull Class<T> type,
                                                      @Nullable
                                                      Predicate<T> predicate)

Deprecated. use getService(Whiteboard, Class, Predicate) instead