Package org.apache.felix.hc.api.execution

Class HealthCheckMetadata

  • @ProviderType
public class HealthCheckMetadata
extends Object
    This class helps retrieving meta data information about a health check service.
    Since:
    1.1

    • Constructor Detail

      • HealthCheckMetadata

        public HealthCheckMetadata​(ServiceReference ref)
        Creates a HealthCheckMetadata from an OSGi service based on the service properties.
        Parameters:
        ref - the ServiceReference for the HC service

    • Method Detail

      • getName

        public String getName()
        The name of the health check as defined through the HealthCheck.NAME property.
        Returns:
        The name or null

      • getMBeanName

        public 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 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.
        Returns:
        The computed title

      • getTags

        public List<String> getTags()
        Return the list of defined tags for this check as set through tags
        Returns:
        list of tags (may be empty but never returns null)

      • getAsyncCronExpression

        public String getAsyncCronExpression()
        Return the cron expression used for asynchronous execution.
        Returns:
        the async cron expression (or null if not set)

      • getAsyncIntervalInSec

        public Long getAsyncIntervalInSec()
        Return the interval in sec used for asynchronous execution.
        Returns:
        the async interval (or null if not set)

      • getServiceId

        public long getServiceId()
        Return the service id.
        Returns:
        the service id (never null)

      • getServiceReference

        public ServiceReference getServiceReference()
        Get the service reference.
        Returns:
        the service reference (never null)

      • getResultCacheTtlInMs

        public Long getResultCacheTtlInMs()
        TTL for the result cache in ms.
        Returns:
        TTL for the result cache or null if not configured.

      • getKeepNonOkResultsStickyForSec

        public Long getKeepNonOkResultsStickyForSec()
        Makes non-ok results stick for the given amount of time.
        Returns:
        Time to make non-ok results sticky in seconds.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object