org.apache.sling.hc.util

Class HealthCheckMetadata

java.lang.Object

org.apache.sling.hc.util.HealthCheckMetadata

@ProviderType
public class HealthCheckMetadata
extends java.lang.Object

This class helps retrieving meta data information about a health check service.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
HealthCheckMetadata(org.osgi.framework.ServiceReference ref)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAsyncCronExpression() Return the cron expression used for asynchronous execution.
java.lang.String	getMBeanName() The mbean name of the health check as defined through the HealthCheck.MBEAN_NAME property.
java.lang.String	getName() The name of the health check as defined through the HealthCheck.NAME property.
java.lang.Long	getResultCacheTtlInMs() TTL for the result cache in ms.
long	getServiceId() Return the service id.
org.osgi.framework.ServiceReference	getServiceReference() Get the service reference.
java.util.List<java.lang.String>	getTags() Return the list of defined tags for this check as set through tags
java.lang.String	getTitle() The title of the health check.
java.lang.Long	getWarningsStickForMinutes() Make warnings stick for the given amount of time.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HealthCheckMetadata

public HealthCheckMetadata(org.osgi.framework.ServiceReference ref)

Method Detail

getName

public java.lang.String getName()

The name of the health check as defined through the HealthCheck.NAME property.

Returns:

The name or null

getMBeanName

public java.lang.String getMBeanName()

The mbean name of the health check as defined through the HealthCheck.MBEAN_NAME property.

Returns:

The mbean name or null

getTitle

public java.lang.String getTitle()

The title of the health check. If the health check has a name, this is used as the title. Otherwise the description, PID and service ID are checked for values.

getTags

public java.util.List<java.lang.String> getTags()

Return the list of defined tags for this check as set through tags

Returns:

getAsyncCronExpression

public java.lang.String getAsyncCronExpression()

Return the cron expression used for asynchronous execution.

getServiceId

public long getServiceId()

Return the service id.

getServiceReference

public org.osgi.framework.ServiceReference getServiceReference()

Get the service reference.

getResultCacheTtlInMs

public java.lang.Long getResultCacheTtlInMs()

TTL for the result cache in ms.

Returns:

TTL for the result cache or null if not configured.

getWarningsStickForMinutes

public java.lang.Long getWarningsStickForMinutes()

Make warnings stick for the given amount of time.

Returns:

Time to make warn results sticky in minutes.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object