Return-Path: X-Original-To: apmail-geode-commits-archive@minotaur.apache.org Delivered-To: apmail-geode-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 40508197D3 for ; Mon, 25 Apr 2016 18:39:47 +0000 (UTC) Received: (qmail 8229 invoked by uid 500); 25 Apr 2016 18:39:47 -0000 Delivered-To: apmail-geode-commits-archive@geode.apache.org Received: (qmail 8198 invoked by uid 500); 25 Apr 2016 18:39:47 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 8118 invoked by uid 99); 25 Apr 2016 18:39:47 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 25 Apr 2016 18:39:47 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 869BF1A0100 for ; Mon, 25 Apr 2016 18:39:46 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.021 X-Spam-Level: X-Spam-Status: No, score=-4.021 tagged_above=-999 required=6.31 tests=[KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id y2qf0i93vxGA for ; Mon, 25 Apr 2016 18:39:36 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 6F6845FCAB for ; Mon, 25 Apr 2016 18:39:29 +0000 (UTC) Received: (qmail 6189 invoked by uid 99); 25 Apr 2016 18:39:28 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 25 Apr 2016 18:39:28 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 8712BE03E1; Mon, 25 Apr 2016 18:39:28 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dbarnes@apache.org To: commits@geode.incubator.apache.org Date: Mon, 25 Apr 2016 18:39:44 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [17/51] [partial] incubator-geode git commit: Relocate javadocs to a consistently-named directory ('latest' rather than '') http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/ce8354fe/releases/latest/javadoc/com/gemstone/gemfire/cache/Cache.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/com/gemstone/gemfire/cache/Cache.html b/releases/latest/javadoc/com/gemstone/gemfire/cache/Cache.html new file mode 100644 index 0000000..acaad98 --- /dev/null +++ b/releases/latest/javadoc/com/gemstone/gemfire/cache/Cache.html @@ -0,0 +1,1234 @@ + + + + + +Cache (Apache Geode 1.0.0-incubating.M2) + + + + + + + + + + + + +
+
com.gemstone.gemfire.cache
+

Interface Cache

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.AutoCloseable, GemFireCache, RegionService
    +
    +
    +
    +
    public interface Cache
    +extends GemFireCache
    +
    Caches are obtained from the CacheFactory.create() method. + See CacheFactory for common usage patterns for creating the cache instance. +

    + When a cache is created a DistributedSystem is also created. + This system tells the cache where to find other caches on the network + and how to communicate with them. + The system can also specify a + "cache-xml-file" + property which will cause this cache to be initialized with the contents + of that file. The contents must comply with the + "doc-files/cache8_0.dtd" file + and the top level element must be a cache element. +

    + When a cache will no longer be used it should be closed. + Once it is closed any attempt to use it or any Region + obtained from it will cause a CacheClosedException to be thrown. + +

    A cache can have multiple root regions, each with a different name.

    +
    +
    Since:
    +
    2.0
    +
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        @Deprecated
        +void close(boolean keepalive)
        +
        Deprecated. as of 6.5 use ClientCache.close(boolean) instead.
        +
        Terminates this object cache and releases all the resources. + Calls Region.close() on each region in the cache. + After this cache is closed, any further + method call on this cache or any region object will throw + CacheClosedException, unless otherwise noted.
        +
        +
        Parameters:
        +
        keepalive - whether the server should keep the durable client's queues alive for the timeout period
        +
        Throws:
        +
        CacheClosedException - if the cache is already closed.
        +
        +
      • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getLoggerI18n

        +
        @Deprecated
        +LogWriterI18n getLoggerI18n()
        +
        Deprecated. as of 6.5 use getLogger().convertToLogWriterI18n() instead
        +
        Internal GemStone method for accessing the internationalized + logging object for GemFire, use GemFireCache.getLogger() instead. + This method does not throw + CacheClosedException if the cache is closed.
        +
        +
        Returns:
        +
        the logging object
        +
        +
      • +
      + + + +
        +
      • +

        getSecurityLoggerI18n

        +
        @Deprecated
        +LogWriterI18n getSecurityLoggerI18n()
        +
        Deprecated. as of 6.5 use getSecurityLogger().convertToLogWriterI18n() instead
        +
        Internal GemStone method for accessing the internationalized + logging object for GemFire, use GemFireCache.getSecurityLogger() instead. + This method does not throw + CacheClosedException if the cache is closed.
        +
        +
        Returns:
        +
        the security logging object
        +
        +
      • +
      + + + +
        +
      • +

        getLockTimeout

        +
        int getLockTimeout()
        +
        Gets the number of seconds a cache operation will wait to obtain + a distributed lock lease. + This method does not throw + CacheClosedException if the cache is closed.
        +
      • +
      + + + +
        +
      • +

        setLockTimeout

        +
        void setLockTimeout(int seconds)
        +
        Sets the number of seconds a cache operation may wait to obtain a + distributed lock lease before timing out.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if seconds is less than zero
        +
        +
      • +
      + + + +
        +
      • +

        getMessageSyncInterval

        +
        int getMessageSyncInterval()
        +
        Gets the frequency (in seconds) at which a message will be sent by the + primary cache-server to all the secondary cache-server nodes to remove the + events which have already been dispatched from the queue.
        +
        +
        Returns:
        +
        The time interval in seconds
        +
        +
      • +
      + + + +
        +
      • +

        setMessageSyncInterval

        +
        void setMessageSyncInterval(int seconds)
        +
        Sets the frequency (in seconds) at which a message will be sent by the + primary cache-server node to all the secondary cache-server nodes to remove + the events which have already been dispatched from the queue.
        +
        +
        Parameters:
        +
        seconds - - + the time interval in seconds
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if seconds is less than zero
        +
        +
      • +
      + + + +
        +
      • +

        getLockLease

        +
        int getLockLease()
        +
        Gets the length, in seconds, of distributed lock leases obtained + by this cache. + This method does not throw + CacheClosedException if the cache is closed.
        +
      • +
      + + + +
        +
      • +

        setLockLease

        +
        void setLockLease(int seconds)
        +
        Sets the length, in seconds, of distributed lock leases obtained + by this cache.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if seconds is less than zero.
        +
        +
      • +
      + + + +
        +
      • +

        getSearchTimeout

        +
        int getSearchTimeout()
        +
        Gets the number of seconds a cache + get operation + can spend searching for a value before it times out. + The search includes any time spent loading the object. + When the search times out it causes the get to fail by throwing + an exception. + This method does not throw + CacheClosedException if the cache is closed.
        +
      • +
      + + + +
        +
      • +

        setSearchTimeout

        +
        void setSearchTimeout(int seconds)
        +
        Sets the number of seconds a cache get operation can spend searching + for a value.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if seconds is less than zero
        +
        +
      • +
      + + + +
        +
      • +

        addCacheServer

        +
        CacheServer addCacheServer()
        +
        Creates a new cache server, with the default configuration, + that will allow clients to access this cache. +

        For the default configuration see the constants in + CacheServer.

        +
        +
        Since:
        +
        5.7
        +
        See Also:
        +
        CacheServer
        +
        +
      • +
      + + + +
        +
      • +

        getCacheServers

        +
        java.util.List<CacheServer> getCacheServers()
        +
        Returns a collection of all of the CacheServers + that can serve the contents of this Cache to clients.
        +
        +
        Since:
        +
        5.7
        +
        See Also:
        +
        addCacheServer()
        +
        +
      • +
      + + + +
        +
      • +

        setGatewayConflictResolver

        +
        void setGatewayConflictResolver(GatewayConflictResolver resolver)
        +
        Adds a gateway event conflict resolution resolver. This is invoked + if an event is processed that comes from a different distributed system + than the last event to modify the affected entry. It may alter + the event or disallow the event. If it does neither the event is applied + to the cache if its timestamp is newer than what is in the cache or if + it is the same and the event's distributed system ID is larger than that + of the last event to modify the affected entry.
        +
        +
        Parameters:
        +
        resolver -
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getGatewayConflictResolver

        +
        GatewayConflictResolver getGatewayConflictResolver()
        +
        Returns the current gateway event conflict resolver
        +
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        setIsServer

        +
        void setIsServer(boolean isServer)
        +
        Sets whether or not this Cache resides in a + long-running "cache server" VM. A cache server may be an + application VM or may be a stand-along VM launched using administration API or the cacheserver command line + utility.
        +
        +
        Since:
        +
        4.0
        +
        +
      • +
      + + + +
        +
      • +

        isServer

        +
        boolean isServer()
        +
        Returns whether or not this cache resides in a "cache server" VM.
        +
        +
        Since:
        +
        4.0
        +
        See Also:
        +
        setIsServer(boolean)
        +
        +
      • +
      + + + +
        +
      • +

        readyForEvents

        +
        @Deprecated
        +void readyForEvents()
        +
        Deprecated. as of 6.5 use ClientCache.readyForEvents() instead.
        +
        Notifies the server that this client is ready to receive updates. + This method is used by durable clients to notify servers that they + are ready to receive updates. As soon as the server receives this message, + it will forward updates to this client (if necessary). +

        + Durable clients must call this method after they are done creating regions. + If it is called before the client creates the regions then updates will be lost. + Any time a new Pool is created and regions have been added to it then + this method needs to be called again. +

        +
        +
        Throws:
        +
        java.lang.IllegalStateException - if called by a non-durable client
        +
        Since:
        +
        5.5
        +
        +
      • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getGatewaySenders

        +
        java.util.Set<GatewaySender> getGatewaySenders()
        +
        Returns all GatewaySenders for this Cache.
        +
        +
        Returns:
        +
        Set of GatewaySenders
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getGatewaySender

        +
        GatewaySender getGatewaySender(java.lang.String id)
        +
        Returns the GatewaySender with the given id added to this Cache.
        +
        +
        Returns:
        +
        GatewaySender with id
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getGatewayReceivers

        +
        java.util.Set<GatewayReceiver> getGatewayReceivers()
        +
        Returns all GatewayReceivers for this Cache
        +
        +
        Returns:
        +
        Set of GatewaySenders
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getAsyncEventQueues

        +
        java.util.Set<AsyncEventQueue> getAsyncEventQueues()
        +
        Returns all AsyncEventQueues for this Cache
        +
        +
        Returns:
        +
        Set of AsyncEventQueue
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getAsyncEventQueue

        +
        AsyncEventQueue getAsyncEventQueue(java.lang.String id)
        +
        Returns the AsyncEventQueue with the given id added to this Cache.
        +
        +
        Returns:
        +
        AsyncEventQueue with id
        +
        Since:
        +
        7.0
        +
        +
      • +
      + + + +
        +
      • +

        getMembers

        +
        java.util.Set<DistributedMember> getMembers()
        +
        Returns a set of the other non-administrative members in the distributed system.
        +
        +
        Since:
        +
        6.6
        +
        +
      • +
      + + + +
        +
      • +

        getAdminMembers

        +
        java.util.Set<DistributedMember> getAdminMembers()
        +
        Returns a set of the administrative members in the distributed system.
        +
        +
        Since:
        +
        6.6
        +
        +
      • +
      + + + +
        +
      • +

        getMembers

        +
        java.util.Set<DistributedMember> getMembers(Region r)
        +
        Returns a set of the members in the distributed system that have the + given region. For regions with local scope an empty set is returned.
        +
        +
        Parameters:
        +
        r - a Region in the cache
        +
        Since:
        +
        6.6
        +
        +
      • +
      + + + +
        +
      • +

        getSnapshotService

        +
        CacheSnapshotService getSnapshotService()
        +
        Obtains the snapshot service to allow the cache data to be imported + or exported.
        +
        +
        Returns:
        +
        the snapshot service
        +
        +
      • +
      + + + +
        +
      • +

        isReconnecting

        +
        boolean isReconnecting()
        +
        Test to see whether the Cache is in the process of reconnecting + and recreating a new cache after it has been removed from the system + by other members or has shut down due to missing Roles and is reconnecting.

        + This will also return true if the Cache has finished reconnecting. + When reconnect has completed you can use getReconnectedCache() to + retrieve the new cache instance.

        +
        +
        Returns:
        +
        true if the Cache is attempting to reconnect or has finished reconnecting
        +
        +
      • +
      + + + +
        +
      • +

        waitUntilReconnected

        +
        boolean waitUntilReconnected(long time,
        +                             java.util.concurrent.TimeUnit units)
        +                      throws java.lang.InterruptedException
        +
        Wait for the Cache to finish reconnecting to the distributed system + and recreate a new Cache.
        +
        +
        Parameters:
        +
        time - amount of time to wait, or -1 to wait forever
        +
        units -
        +
        Returns:
        +
        true if the cache was reconnected
        +
        Throws:
        +
        java.lang.InterruptedException - if the thread is interrupted while waiting
        +
        See Also:
        +
        getReconnectedCache()
        +
        +
      • +
      + + + +
        +
      • +

        stopReconnecting

        +
        void stopReconnecting()
        +
        Force the Cache to stop reconnecting. If the Cache + is currently connected this will disconnect and close it.
        +
      • +
      + + + +
        +
      • +

        getReconnectedCache

        +
        Cache getReconnectedCache()
        +
        Returns the new Cache if there was an auto-reconnect and the cache was + recreated.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + + +