Edit Javadoc.

This commit is contained in:
John Blum
2018-09-20 00:03:00 -07:00
parent b6e47a6578
commit b3e22eb05b
4 changed files with 38 additions and 4 deletions

View File

@@ -19,8 +19,10 @@ package org.springframework.geode.boot.actuate.autoconfigure;
import org.apache.geode.cache.GemFireCache;
import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
import org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Configuration;
@@ -32,9 +34,19 @@ import org.springframework.geode.boot.actuate.autoconfigure.config.PeerCacheHeal
import org.springframework.geode.boot.autoconfigure.ClientCacheAutoConfiguration;
/**
* The GeodeHealthIndicatorAutoConfiguration class...
* Spring Boot {@link EnableAutoConfiguration auto-configuration} for Apache Geode/Pivotal GemFire
* {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
* @see org.apache.geode.cache.GemFireCache
* @see org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator
* @see org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.Import
* @see org.springframework.geode.boot.actuate.autoconfigure.config.BaseGeodeHealthIndicatorConfiguration
* @see org.springframework.geode.boot.actuate.autoconfigure.config.ClientCacheHealthIndicatorConfiguration
* @see org.springframework.geode.boot.actuate.autoconfigure.config.PeerCacheHealthIndicatorConfiguration
* @see org.springframework.geode.boot.autoconfigure.ClientCacheAutoConfiguration
* @since 1.0.0
*/
@Configuration

View File

@@ -16,7 +16,10 @@
package org.springframework.geode.boot.actuate.autoconfigure.config;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.GemFireCache;
import org.apache.geode.cache.client.ClientCache;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@@ -26,10 +29,14 @@ import org.springframework.geode.boot.actuate.GeodeIndexesHealthIndicator;
import org.springframework.geode.boot.actuate.GeodeRegionsHealthIndicator;
/**
* The BaseGeodeHealthIndicatorConfiguration class...
* Spring {@link Configuration @Configuration} class declaring Spring beans for general Apache Geode/Pivotal GemFire
* peer {@link Cache} and {@link ClientCache} {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
* @see org.apache.geode.cache.Cache
* @see org.apache.geode.cache.GemFireCache
* @see org.apache.geode.cache.client.ClientCache
* @see org.springframework.boot.actuate.health.HealthIndicator
* @see org.springframework.context.ApplicationContext
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration

View File

@@ -20,6 +20,7 @@ import org.apache.geode.cache.Cache;
import org.apache.geode.cache.GemFireCache;
import org.apache.geode.cache.client.ClientCache;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
@@ -32,9 +33,15 @@ import org.springframework.geode.boot.actuate.GeodeContinuousQueriesHealthIndica
import org.springframework.geode.boot.actuate.GeodePoolsHealthIndicator;
/**
* The ClientCacheHealthIndicatorConfiguration class...
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode/Pivotal GemFire
* {@link ClientCache} {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
* @see org.apache.geode.cache.GemFireCache
* @see org.apache.geode.cache.client.ClientCache
* @see org.springframework.boot.actuate.health.HealthIndicator
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.geode.boot.actuate.GeodeContinuousQueriesHealthIndicator
* @see org.springframework.geode.boot.actuate.GeodePoolsHealthIndicator
* @since 1.0.0

View File

@@ -25,6 +25,7 @@ import org.apache.geode.cache.server.CacheServer;
import org.apache.geode.cache.server.ServerLoadProbe;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
@@ -42,9 +43,16 @@ import org.springframework.geode.core.util.ObjectUtils;
import org.springframework.lang.Nullable;
/**
* The PeerCacheHealthIndicatorConfiguration class...
* Spring {@link Configuration @Configuration} class declaring Spring beans for Apache Geode/Pivotal GemFire
* peer {@link Cache} {@link HealthIndicator HealthIndicators}.
*
* @author John Blum
* @see org.apache.geode.cache.Cache
* @see org.apache.geode.cache.GemFireCache
* @see org.springframework.beans.factory.config.BeanPostProcessor
* @see org.springframework.boot.actuate.health.HealthIndicator
* @see org.springframework.context.annotation.Bean
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.geode.boot.actuate.GeodeAsyncEventQueuesHealthIndicator
* @see org.springframework.geode.boot.actuate.GeodeCacheServersHealthIndicator
* @see org.springframework.geode.boot.actuate.GeodeGatewayReceiversHealthIndicator