You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ji...@apache.org on 2016/04/08 18:26:34 UTC

[16/36] incubator-geode git commit: GEODE-564: javadocs for CacheFactory.create() need to list AuthenticationFailedException

GEODE-564: javadocs for CacheFactory.create() need to list AuthenticationFailedException

 * ClientCacheFactory seems to be missing AuthenticationFailedException.
 * ClientCacheFactory seems to be missing CacheExistsException, TimeoutException,
   CacheWriterException, RegionExistsException
 * AthenticationRequiredException be thrown if distributed system
   is in secure mode and this client/peer has not set the security credentials.
 * IllegalStateException is thrown if a cache already exists and is not compatible
   with new cache configuration


Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/e7b7360b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/e7b7360b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/e7b7360b

Branch: refs/heads/feature/GEODE-17-2
Commit: e7b7360b3c546dc7a2df26f1965185ee18c2c88a
Parents: 3898a0e
Author: Sai Boorlagadda <sb...@pivotal.io>
Authored: Tue Apr 5 12:08:37 2016 -0700
Committer: Sai Boorlagadda <sb...@pivotal.io>
Committed: Tue Apr 5 16:09:21 2016 -0700

----------------------------------------------------------------------
 .../gemstone/gemfire/cache/CacheFactory.java    |  5 +++++
 .../cache/client/ClientCacheFactory.java        | 23 ++++++++++++++++++--
 2 files changed, 26 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/e7b7360b/geode-core/src/main/java/com/gemstone/gemfire/cache/CacheFactory.java
----------------------------------------------------------------------
diff --git a/geode-core/src/main/java/com/gemstone/gemfire/cache/CacheFactory.java b/geode-core/src/main/java/com/gemstone/gemfire/cache/CacheFactory.java
index bcb9f13..bd3b55f 100755
--- a/geode-core/src/main/java/com/gemstone/gemfire/cache/CacheFactory.java
+++ b/geode-core/src/main/java/com/gemstone/gemfire/cache/CacheFactory.java
@@ -204,6 +204,11 @@ public class CacheFactory {
    * @throws RegionExistsException
    *         If the declarative caching XML file describes a region
    *         that already exists (including the root region).
+   * @throws IllegalStateException if cache already exists and is not compatible
+   *         with the new configuration.
+   * @throws AuthenticationFailedException if authentication fails.
+   * @throws AuthenticationRequiredException if the distributed system is in secure mode 
+   *         and this new member is not configured with security credentials.
    * @since 6.5
    */
   public Cache create()

http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/e7b7360b/geode-core/src/main/java/com/gemstone/gemfire/cache/client/ClientCacheFactory.java
----------------------------------------------------------------------
diff --git a/geode-core/src/main/java/com/gemstone/gemfire/cache/client/ClientCacheFactory.java b/geode-core/src/main/java/com/gemstone/gemfire/cache/client/ClientCacheFactory.java
index 99e11a0..49efff1 100644
--- a/geode-core/src/main/java/com/gemstone/gemfire/cache/client/ClientCacheFactory.java
+++ b/geode-core/src/main/java/com/gemstone/gemfire/cache/client/ClientCacheFactory.java
@@ -159,12 +159,31 @@ public class ClientCacheFactory {
    * Create a singleton client cache. If a client cache already exists in this
    * vm that is not compatible with this factory's configuration then create
    * will fail.
-   * <p> While creating the cache instance any declarative cache configuration (cache.xml) is processed and used to initialize the created cache.
+   * <p> While creating the cache instance any declarative cache configuration (cache.xml) 
+   * is processed and used to initialize the created cache.
    * <P>Note that the cache that is produced is a singleton. Before a different instance
    * can be produced the old one must be {@link ClientCache#close closed}.
+   * 
    * @return the singleton client cache
+   * 
+   * @throws CacheXmlException
+   *         If a problem occurs while parsing the declarative caching
+   *         XML file.
+   * @throws TimeoutException
+   *         If a {@link Region#put(Object, Object)} times out while initializing the
+   *         cache.
+   * @throws CacheWriterException
+   *         If a <code>CacheWriterException</code> is thrown while
+   *         initializing the cache.
+   * @throws RegionExistsException
+   *         If the declarative caching XML file describes a region
+   *         that already exists (including the root region).
    * @throws IllegalStateException if a client cache already exists and it
-   * is not compatible with this factory's configuration.
+   *         is not compatible with this factory's configuration.
+   * @throws IllegalStateException if mcast-port or locator is set on client cache.
+   * @throws AuthenticationFailedException if authentication fails.
+   * @throws AuthenticationRequiredException if server is in secure mode and client cache
+   *         is not configured with security credentials.
    */
   public ClientCache create() {
     return basicCreate();