Edit Javadoc.
Resolves gh-14.
This commit is contained in:
@@ -19,17 +19,25 @@ package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.Cache;
|
||||
import org.apache.geode.cache.client.ClientCache;
|
||||
import org.apache.geode.cache.control.ResourceManager;
|
||||
import org.apache.geode.cache.server.CacheServer;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.NestedConfigurationProperty;
|
||||
|
||||
/**
|
||||
* Spring Boot {@link ConfigurationProperties} that apply to an Apache Geode / Pivotal GemFire peer {@link Cache}
|
||||
* and correspond to Spring Data for Apache Geode/Pivotal GemFire's well-known, documented {@link Properties}.
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire peer {@link Cache},
|
||||
* {@link ClientCache} and {@link CacheServer} objects.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.apache.geode.cache.client.ClientCache
|
||||
* @see org.apache.geode.cache.control.ResourceManager
|
||||
* @see org.apache.geode.cache.server.CacheServer
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @see org.springframework.boot.context.properties.NestedConfigurationProperty
|
||||
* @since 1.0.0
|
||||
|
||||
@@ -16,14 +16,23 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.server.CacheServer;
|
||||
import org.apache.geode.cache.server.ClientSubscriptionConfig;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.data.gemfire.server.SubscriptionEvictionPolicy;
|
||||
|
||||
/**
|
||||
* The CacheServerProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link CacheServer}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.server.CacheServer
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,21 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.client.ClientCache;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The ClientCacheProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link ClientCache}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.client.ClientCache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,22 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.client.ClientCache;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The ClientSecurityProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire {@link ClientCache}
|
||||
* Security (authentication & authorization).
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.client.ClientCache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,12 +16,24 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.DataPolicy;
|
||||
import org.apache.geode.cache.Region;
|
||||
import org.apache.geode.cache.RegionShortcut;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The ClusterProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure the {@link DataPolicy} of all {@link Region Regions}
|
||||
* in an Apache Geode / Pivotal GemFire cluster.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Region
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,12 +16,24 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.DiskStore;
|
||||
import org.apache.geode.cache.DiskStoreFactory;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The DiskStoreProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire
|
||||
* {@link DiskStore DiskStores}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.DiskStore
|
||||
* @see org.apache.geode.cache.DiskStoreFactory
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,23 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.Region;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The EntityProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure the application base {@link Package package}
|
||||
* containing the application entity classes. The entity classes are then used to create and configure
|
||||
* Apache Geode / Pivotal GemFire {@link Region Regions}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Region
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,25 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.distributed.Locator;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The LocatorProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an embedded Apache Geode / Pivotal GemFire
|
||||
* {@link Locator}.
|
||||
*
|
||||
* A {@link Locator} enables location services used by nodes to join an existing cluster as a peer member
|
||||
* and is also used by clients to discover servers in the cluster.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.distributed.Locator
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,19 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The LoggingProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire logging.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,20 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The ManagementProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire management services,
|
||||
* such as HTTP.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,23 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The ManagerProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an embedded Apache Geode / Pivotal GemFire
|
||||
* {@literal Manager}.
|
||||
*
|
||||
* A {@literal Manager} allows users to manage a cluster with tools like {@literal Gfsh} or {@literal Pulse}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.distributed.Locator
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,27 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The PdxProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire
|
||||
* {@literal PDX} serialization.
|
||||
*
|
||||
* PDX serialization is an alternative serialization format to Java Serialization provided by
|
||||
* Apache Geode / Pivotal GemFire. PDX enables interoperability with native language clients (e.g. C++),
|
||||
* enables objects stored in GemFire/Geode to be queried without causing deserialization and is a more efficient
|
||||
* format than Java Serialization. While PDX is more robust in some ways, it is less robust in others. For example,
|
||||
* PDX does not handle cyclic references in the object graph.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.distributed.Locator
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,21 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.Cache;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The PeerCacheProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire peer {@link Cache}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,10 +16,22 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.Cache;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The PeerSecurityProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire peer {@link Cache}
|
||||
* Security (authentication & authorization).
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,12 +16,23 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.client.Pool;
|
||||
import org.apache.geode.cache.client.PoolFactory;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The PoolProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure an Apache Geode / Pivotal GemFire peer {@link Pool}.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.client.Pool
|
||||
* @see org.apache.geode.cache.client.PoolFactory
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,12 +16,23 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.NestedConfigurationProperty;
|
||||
|
||||
/**
|
||||
* The SecurityProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire Security.
|
||||
*
|
||||
* Security configuration covers Authentication & Authorization (AUTH) as well as Secure Transport using SSL
|
||||
* (i.e. securing data in motion). Securing data at rest (e.g. disk based encryption) is not yet supported.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,12 +16,24 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.data.gemfire.config.annotation.EnableMemcachedServer;
|
||||
|
||||
/**
|
||||
* The ServiceProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire embedded services.
|
||||
*
|
||||
* Currently, the supported embedded services include HTTP service (Jetty), Memcached (protocol) server
|
||||
* and a Redis (protocol) server.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
@@ -16,13 +16,26 @@
|
||||
|
||||
package org.springframework.geode.boot.autoconfigure.configuration.support;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import org.apache.geode.cache.Cache;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.boot.context.properties.NestedConfigurationProperty;
|
||||
import org.springframework.data.gemfire.config.annotation.EnableSsl;
|
||||
|
||||
/**
|
||||
* The SslProperties class...
|
||||
* Spring Boot {@link ConfigurationProperties} used to configure Apache Geode / Pivotal GemFire Socket layer SSL.
|
||||
*
|
||||
* The SSL configuration is used to secure communications and data in motion between clients and servers
|
||||
* as well as between peers in a cluster.
|
||||
*
|
||||
* The configuration {@link Properties} are based on well-known, documented Spring Data for Apache Geode/Pivotal GemFire
|
||||
* (SDG) {@link Properties}.
|
||||
*
|
||||
* @author John Blum
|
||||
* @see java.util.Properties
|
||||
* @see org.apache.geode.cache.Cache
|
||||
* @see org.springframework.boot.context.properties.ConfigurationProperties
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SuppressWarnings("unused")
|
||||
|
||||
Reference in New Issue
Block a user