org.apache.sling.hc.util

Class HealthCheckFilter

java.lang.Object

org.apache.sling.hc.util.HealthCheckFilter

public class HealthCheckFilter
extends java.lang.Object

Select from available HealthCheck services. Once this filter object and the returned health check services are no longer be used dispose() should be called, to free the service references. This class is not thread safe and instances shouldn't be used concurrently from different threads.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OMIT_PREFIX

Constructor Summary

Constructors

Constructor and Description
HealthCheckFilter(org.osgi.framework.BundleContext bc) Create a new filter object

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose all used service references
java.util.List<HealthCheck>	getTaggedHealthChecks(java.lang.String... tags) Get all health check services with one of the supplied tags.
org.osgi.framework.ServiceReference[]	getTaggedHealthCheckServiceReferences(boolean combineWithOr, java.lang.String... tags) Get all service references for health check services with one of the supplied tags.
org.osgi.framework.ServiceReference[]	getTaggedHealthCheckServiceReferences(java.lang.String... tags) Get all service references for health check services with one of the supplied tags.

Methods inherited from class java.lang.Object

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

Field Detail

OMIT_PREFIX

public static final java.lang.String OMIT_PREFIX

See Also:

Constant Field Values

Constructor Detail

HealthCheckFilter

public HealthCheckFilter(org.osgi.framework.BundleContext bc)

Create a new filter object

Method Detail

getTaggedHealthChecks

public java.util.List<HealthCheck> getTaggedHealthChecks(java.lang.String... tags)

Get all health check services with one of the supplied tags.

Returns:

A list of services - might be the empty list if none matches

getTaggedHealthCheckServiceReferences

public org.osgi.framework.ServiceReference[] getTaggedHealthCheckServiceReferences(java.lang.String... tags)

Get all service references for health check services with one of the supplied tags. Uses logical "and" to combine tags.

Returns:

An array of service references - might be an empty error if none matches

getTaggedHealthCheckServiceReferences

public org.osgi.framework.ServiceReference[] getTaggedHealthCheckServiceReferences(boolean combineWithOr,
                                                                                   java.lang.String... tags)

Get all service references for health check services with one of the supplied tags.

Parameters:

combineWithOr - If true will return all health checks that have at least one of the tags set. If false will return only health checks that have all given tags assigned.

tags - the tags to look for

Returns:

An array of service references - might be an empty error if none matches

dispose

public void dispose()

Dispose all used service references