Package com.oracle.coherence.grpc.proxy

Interface NamedCacheService

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String SERVICE_NAME
      The name of the gRPC service.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CompletionStage<com.google.protobuf.Empty> addIndex​(com.oracle.coherence.grpc.AddIndexRequest request)
      Add an index to a cache.
      CompletionStage<com.google.protobuf.BytesValue> aggregate​(com.oracle.coherence.grpc.AggregateRequest request)
      Execute an AggregateRequest against a cache and return the result serialized in a BytesValue.
      CompletionStage<com.google.protobuf.Empty> clear​(com.oracle.coherence.grpc.ClearRequest request)
      Clear a cache.
      CompletionStage<com.google.protobuf.BoolValue> containsEntry​(com.oracle.coherence.grpc.ContainsEntryRequest request)
      Returns true if this map contains a mapping for the specified key to the specified value.
      CompletionStage<com.google.protobuf.BoolValue> containsKey​(com.oracle.coherence.grpc.ContainsKeyRequest request)
      Returns true if this map contains a mapping for the specified key.
      CompletionStage<com.google.protobuf.BoolValue> containsValue​(com.oracle.coherence.grpc.ContainsValueRequest request)
      Returns true if this map contains a mapping for the specified value.
      <Req> CacheRequestHolder<Req,​Void> createRequestHolder​(Req request, String sScope, String sCacheName, String format)
      Create a CacheRequestHolder for a given request.
      CompletionStage<com.google.protobuf.Empty> destroy​(com.oracle.coherence.grpc.DestroyRequest request)
      Destroy a cache.
      <T> Filter<T> ensureFilter​(com.google.protobuf.ByteString bytes, Serializer serializer)
      Obtain a Filter from the serialized data in a ByteString.
      void entrySet​(com.oracle.coherence.grpc.EntrySetRequest request, io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.Entry> observer)
      Stream a set of cache entries to a StreamObserver.
      io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.MapListenerRequest> events​(io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.MapListenerResponse> observer)
      Add a MapListener to a cache and stream the events received to the StreamObserver.
      CompletionStage<com.oracle.coherence.grpc.OptionalValue> get​(com.oracle.coherence.grpc.GetRequest request)
      Get a value for a given key from a cache.
      void getAll​(com.oracle.coherence.grpc.GetAllRequest request, io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.Entry> observer)
      Obtain a stream of mappings of keys to values for all of the specified keys.
      <T> Filter<T> getFilter​(com.google.protobuf.ByteString bytes, Serializer serializer)
      Obtain a Filter from the serialized data in a ByteString.
      CompletionStage<com.google.protobuf.BytesValue> invoke​(com.oracle.coherence.grpc.InvokeRequest request)
      Invoke an InvocableMap.EntryProcessor against an entry in a cache.
      void invokeAll​(com.oracle.coherence.grpc.InvokeAllRequest request, io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.Entry> observer)
      Invoke an InvocableMap.EntryProcessor against multiple entries in a cache.
      CompletionStage<com.google.protobuf.BoolValue> isEmpty​(com.oracle.coherence.grpc.IsEmptyRequest request)
      Determine whether a cache is empty.
      CompletionStage<com.google.protobuf.BoolValue> isReady​(com.oracle.coherence.grpc.IsReadyRequest request)
      Determine whether a cache is Ready.
      void keySet​(com.oracle.coherence.grpc.KeySetRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.BytesValue> observer)
      Stream a set of cache keys to a StreamObserver.
      void nextEntrySetPage​(com.oracle.coherence.grpc.PageRequest request, io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.EntryResult> observer)
      Obtain the next page of a paged entry set request.
      void nextKeySetPage​(com.oracle.coherence.grpc.PageRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.BytesValue> observer)
      Obtain the next page of a paged key set request.
      CompletionStage<com.google.protobuf.BytesValue> put​(com.oracle.coherence.grpc.PutRequest request)
      Associate the specified value with the specified key in this cache.
      CompletionStage<com.google.protobuf.Empty> putAll​(com.oracle.coherence.grpc.PutAllRequest request)
      Add the specified key value pair mappings to this cache.
      CompletionStage<com.google.protobuf.BytesValue> putIfAbsent​(com.oracle.coherence.grpc.PutIfAbsentRequest request)
      If the specified key is not already associated with a value (or is mapped to null) associate it with the given value and returns null, else return the current value.
      CompletionStage<com.google.protobuf.BytesValue> remove​(com.oracle.coherence.grpc.RemoveRequest request)
      Remove the mapping that is associated with the specified key.
      CompletionStage<com.google.protobuf.Empty> removeIndex​(com.oracle.coherence.grpc.RemoveIndexRequest request)
      Remove an index from a cache.
      CompletionStage<com.google.protobuf.BoolValue> removeMapping​(com.oracle.coherence.grpc.RemoveMappingRequest request)
      Remove the mapping that is associated with the specified key only if the mapping exists in the cache.
      CompletionStage<com.google.protobuf.BytesValue> replace​(com.oracle.coherence.grpc.ReplaceRequest request)
      Replace the entry for the specified key only if it is currently mapped to some value.
      CompletionStage<com.google.protobuf.BoolValue> replaceMapping​(com.oracle.coherence.grpc.ReplaceMappingRequest request)
      Replace the mapping for the specified key only if currently mapped to the specified value.
      CompletionStage<com.google.protobuf.Int32Value> size​(com.oracle.coherence.grpc.SizeRequest request)
      Determine the number of entries in a cache.
      CompletionStage<com.google.protobuf.Empty> truncate​(com.oracle.coherence.grpc.TruncateRequest request)
      Removes all mappings from this map.
      void values​(com.oracle.coherence.grpc.ValuesRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.BytesValue> observer)
      Stream a set of cache values to a StreamObserver.

    • Method Detail

      • addIndex

        CompletionStage<com.google.protobuf.Empty> addIndex​(com.oracle.coherence.grpc.AddIndexRequest request)
        Add an index to a cache.
        Parameters:
        request - the AddIndexRequest containing the name of the cache to add the index to, the serialized ValueExtractor to use to create the index and the optional serialized Comparator to sort the index
        Returns:
        a CompletionStage that will complete when the index is created

      • aggregate

        CompletionStage<com.google.protobuf.BytesValue> aggregate​(com.oracle.coherence.grpc.AggregateRequest request)
        Execute an AggregateRequest against a cache and return the result serialized in a BytesValue.
        Parameters:
        request - the AggregateRequest to execute
        Returns:
        the serialized aggregation result

      • clear

        CompletionStage<com.google.protobuf.Empty> clear​(com.oracle.coherence.grpc.ClearRequest request)
        Clear a cache.
        Parameters:
        request - the ClearRequest to execute
        Returns:
        a CompletionStage that will complete when the cache has been cleared.
        See Also:
        NamedMap.clear()

      • containsEntry

        CompletionStage<com.google.protobuf.BoolValue> containsEntry​(com.oracle.coherence.grpc.ContainsEntryRequest request)
        Returns true if this map contains a mapping for the specified key to the specified value.
        Parameters:
        request - the request which contains the key and value whose presence in this map is to be tested
        Returns:
        a CompletionStage that will complete with {code true} if this map contains a mapping for the specified key to the specified value
        See Also:
        Map.containsKey(Object)

      • containsKey

        CompletionStage<com.google.protobuf.BoolValue> containsKey​(com.oracle.coherence.grpc.ContainsKeyRequest request)
        Returns true if this map contains a mapping for the specified key.
        Parameters:
        request - the request which contains the key whose presence in this map is to be tested
        Returns:
        a CompletionStage that will complete with {code true} if this map contains a mapping for the specified key
        See Also:
        Map.containsKey(Object)

      • containsValue

        CompletionStage<com.google.protobuf.BoolValue> containsValue​(com.oracle.coherence.grpc.ContainsValueRequest request)
        Returns true if this map contains a mapping for the specified value.
        Parameters:
        request - the request which contains the value whose presence in this map is to be tested
        Returns:
        a CompletionStage that will complete with {code true} if this map contains a mapping for the specified value
        See Also:
        Map.containsKey(Object)

      • destroy

        CompletionStage<com.google.protobuf.Empty> destroy​(com.oracle.coherence.grpc.DestroyRequest request)
        Destroy a cache.
        Parameters:
        request - the DestroyRequest containing the name of the cache to destroy
        Returns:
        a CompletionStage that will complete when the cache is destroyed

      • events

        io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.MapListenerRequest> events​(io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.MapListenerResponse> observer)
        Add a MapListener to a cache and stream the events received to the StreamObserver.
        Parameters:
        observer - the StreamObserver to receive events
        Returns:
        a StreamObserver that will be closed by the client to end event subscription

      • get

        CompletionStage<com.oracle.coherence.grpc.OptionalValue> get​(com.oracle.coherence.grpc.GetRequest request)
        Get a value for a given key from a cache.
        Parameters:
        request - the GetRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the Map.get(Object)
        See Also:
        Map.get(Object)

      • getAll

        void getAll​(com.oracle.coherence.grpc.GetAllRequest request,
            io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.Entry> observer)
        Obtain a stream of mappings of keys to values for all of the specified keys.
        Parameters:
        request - the GetAllRequest request containing the cache name and collection of keys to obtain the mappings for
        observer - the StreamObserver to stream the results back to

      • invokeAll

        void invokeAll​(com.oracle.coherence.grpc.InvokeAllRequest request,
               io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.Entry> observer)
        Invoke an InvocableMap.EntryProcessor against multiple entries in a cache.
        Parameters:
        request - the InvokeRequest containing the serialized keys or serialized Filter to use to identify the entries and the serialized InvocableMap.EntryProcessor
        observer - the StreamObserver to observer the invocation results

      • isEmpty

        CompletionStage<com.google.protobuf.BoolValue> isEmpty​(com.oracle.coherence.grpc.IsEmptyRequest request)
        Determine whether a cache is empty.
        Parameters:
        request - the IsEmptyRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the Map.isEmpty()
        See Also:
        Map.isEmpty()

      • isReady

        CompletionStage<com.google.protobuf.BoolValue> isReady​(com.oracle.coherence.grpc.IsReadyRequest request)
        Determine whether a cache is Ready.
        Parameters:
        request - the IsReadyRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the NamedMap.isReady()
        Since:
        14.1.1.2206.5
        See Also:
        NamedMap.isReady()

      • keySet

        void keySet​(com.oracle.coherence.grpc.KeySetRequest request,
            io.grpc.stub.StreamObserver<com.google.protobuf.BytesValue> observer)
        Stream a set of cache keys to a StreamObserver.
        Parameters:
        request - the KeySetRequest to execute
        observer - the StreamObserver to stream the keys to
        See Also:
        QueryMap.keySet(com.tangosol.util.Filter)

      • nextEntrySetPage

        void nextEntrySetPage​(com.oracle.coherence.grpc.PageRequest request,
                      io.grpc.stub.StreamObserver<com.oracle.coherence.grpc.EntryResult> observer)
        Obtain the next page of a paged entry set request.
        Parameters:
        request - the PageRequest to execute
        observer - the StreamObserver that will receive the responses

      • nextKeySetPage

        void nextKeySetPage​(com.oracle.coherence.grpc.PageRequest request,
                    io.grpc.stub.StreamObserver<com.google.protobuf.BytesValue> observer)
        Obtain the next page of a paged key set request.
        Parameters:
        request - the PageRequest to execute
        observer - the StreamObserver that will receive the responses

      • put

        CompletionStage<com.google.protobuf.BytesValue> put​(com.oracle.coherence.grpc.PutRequest request)
        Associate the specified value with the specified key in this cache. If the cache previously contained a mapping for the key, the old value is replaced by the specified value.
        Parameters:
        request - the PutRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the Map.put(Object, Object)
        See Also:
        Map.put(Object, Object)

      • putAll

        CompletionStage<com.google.protobuf.Empty> putAll​(com.oracle.coherence.grpc.PutAllRequest request)
        Add the specified key value pair mappings to this cache. If the cache previously contained a mappings for the keys, the old value is replaced by the specified value.
        Parameters:
        request - the PutAllRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the Map.putAll(java.util.Map)
        See Also:
        Map.putAll(java.util.Map)

      • putIfAbsent

        CompletionStage<com.google.protobuf.BytesValue> putIfAbsent​(com.oracle.coherence.grpc.PutIfAbsentRequest request)
        If the specified key is not already associated with a value (or is mapped to null) associate it with the given value and returns null, else return the current value.
        Parameters:
        request - the PutIfAbsentRequest to execute
        Returns:
        a CompletionStage that will complete with the previous value associated with the specified key, or null if there was no mapping for the key. A null return can also indicate that the map previously associated null with the key, if the implementation supports null values
        See Also:
        Map.putIfAbsent(Object, Object)

      • remove

        CompletionStage<com.google.protobuf.BytesValue> remove​(com.oracle.coherence.grpc.RemoveRequest request)
        Remove the mapping that is associated with the specified key.
        Parameters:
        request - the RemoveRequest to execute
        Returns:
        a CompletionStage that will complete with the previous value associated with specified key, or null if there was no mapping for key.
        See Also:
        Map.remove(Object)

      • removeIndex

        CompletionStage<com.google.protobuf.Empty> removeIndex​(com.oracle.coherence.grpc.RemoveIndexRequest request)
        Remove an index from a cache.
        Parameters:
        request - the RemoveIndexRequest containing the name of the cache to remove the index from, the serialized ValueExtractor that was used to create the index
        Returns:
        a CompletionStage that will complete when the index is removed

      • removeMapping

        CompletionStage<com.google.protobuf.BoolValue> removeMapping​(com.oracle.coherence.grpc.RemoveMappingRequest request)
        Remove the mapping that is associated with the specified key only if the mapping exists in the cache.
        Parameters:
        request - the RemoveMappingRequest to execute
        Returns:
        a CompletionStage that will complete with true if the removal was successful, false otherwise
        See Also:
        Map.remove(Object, Object)

      • replace

        CompletionStage<com.google.protobuf.BytesValue> replace​(com.oracle.coherence.grpc.ReplaceRequest request)
        Replace the entry for the specified key only if it is currently mapped to some value.
        Parameters:
        request - the ReplaceRequest to execute
        Returns:
        a CompletionStage that will complete with the previous value associated with specified key, or null if there was no mapping for key.
        See Also:
        Map.replace(Object, Object)

      • replaceMapping

        CompletionStage<com.google.protobuf.BoolValue> replaceMapping​(com.oracle.coherence.grpc.ReplaceMappingRequest request)
        Replace the mapping for the specified key only if currently mapped to the specified value.
        Parameters:
        request - the ReplaceMappingRequest to execute
        Returns:
        a CompletionStage that will complete with the previous value associated with the specified key, or null if there was no mapping for the key. A null return can also indicate that the map previously associated null with the key, if the implementation supports null values
        See Also:
        Map.replace(Object, Object, Object)

      • size

        CompletionStage<com.google.protobuf.Int32Value> size​(com.oracle.coherence.grpc.SizeRequest request)
        Determine the number of entries in a cache.
        Parameters:
        request - the SizeRequest to execute
        Returns:
        a CompletionStage that will complete with the result of the Map.size()
        See Also:
        Map.size()

      • truncate

        CompletionStage<com.google.protobuf.Empty> truncate​(com.oracle.coherence.grpc.TruncateRequest request)
        Removes all mappings from this map.

        Note: the removal of entries caused by this truncate operation will not be observable. This includes any registered listeners, triggers, or interceptors. However, a CacheLifecycleEvent is raised to notify subscribers of the execution of this operation.

        Parameters:
        request - the TruncateRequest containing the name of the cache to truncate
        Returns:
        a CompletionStage that completes when the truncate operation has completed

      • createRequestHolder

        <Req> CacheRequestHolder<Req,​Void> createRequestHolder​(Req request,
                                                             String sScope,
                                                             String sCacheName,
                                                             String format)
        Create a CacheRequestHolder for a given request.
        Type Parameters:
        Req - the type of the request
        Parameters:
        request - the request object to add to the holder
        sScope - the scope name to use to identify the CCF to obtain the cache from
        sCacheName - the name of the cache that the request executes against
        format - the optional serialization format used by requests that contain a payload
        Returns:
        the CacheRequestHolder holding the request

      • ensureFilter

        <T> Filter<T> ensureFilter​(com.google.protobuf.ByteString bytes,
                           Serializer serializer)
        Obtain a Filter from the serialized data in a ByteString.

        If the ByteString is null or ByteString.EMPTY then an AlwaysFilter is returned.

        Type Parameters:
        T - the Filter type
        Parameters:
        bytes - the ByteString containing the serialized Filter
        serializer - the serializer to use
        Returns:
        a deserialized Filter

      • getFilter

        <T> Filter<T> getFilter​(com.google.protobuf.ByteString bytes,
                        Serializer serializer)
        Obtain a Filter from the serialized data in a ByteString.
        Type Parameters:
        T - the Filter type
        Parameters:
        bytes - the ByteString containing the serialized Filter
        serializer - the serializer to use
        Returns:
        a deserialized Filter or null if no filter is set