Module com.zeroc.icegrid
Package com.zeroc.IceGrid

Interface QueryPrx

All Superinterfaces:
ObjectPrx
public interface QueryPrx extends ObjectPrx
Finds well-known Ice objects registered with the IceGrid registry.

Remarks: The Slice compiler generated this proxy interface from Slice interface ::IceGrid::Query.

  • Method Details

    • findObjectById

      default ObjectPrx findObjectById(Identity id)
      Finds a well-known object by identity.
      Parameters:
      id - The identity.
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectById

      default ObjectPrx findObjectById(Identity id, Map<String,String> context)
      Finds a well-known object by identity.
      Parameters:
      id - The identity.
      context - the Context map to send with the invocation
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByIdAsync

      default CompletableFuture<ObjectPrx> findObjectByIdAsync(Identity id)
      Finds a well-known object by identity.
      Parameters:
      id - The identity.
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByIdAsync

      default CompletableFuture<ObjectPrx> findObjectByIdAsync(Identity id, Map<String,String> context)
      Finds a well-known object by identity.
      Parameters:
      id - The identity.
      context - the Context map to send with the invocation
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByType

      default ObjectPrx findObjectByType(String type)
      Finds a well-known object by type. If there are several objects registered for the given type, the object is randomly selected.
      Parameters:
      type - The object type.
      Returns:
      A proxy to a well-known object with the specified type, or null if no such object is registered.

    • findObjectByType

      default ObjectPrx findObjectByType(String type, Map<String,String> context)
      Finds a well-known object by type. If there are several objects registered for the given type, the object is randomly selected.
      Parameters:
      type - The object type.
      context - the Context map to send with the invocation
      Returns:
      A proxy to a well-known object with the specified type, or null if no such object is registered.

    • findObjectByTypeAsync

      default CompletableFuture<ObjectPrx> findObjectByTypeAsync(String type)
      Finds a well-known object by type. If there are several objects registered for the given type, the object is randomly selected.
      Parameters:
      type - The object type.
      Returns:
      A proxy to a well-known object with the specified type, or null if no such object is registered.

    • findObjectByTypeAsync

      default CompletableFuture<ObjectPrx> findObjectByTypeAsync(String type, Map<String,String> context)
      Finds a well-known object by type. If there are several objects registered for the given type, the object is randomly selected.
      Parameters:
      type - The object type.
      context - the Context map to send with the invocation
      Returns:
      A proxy to a well-known object with the specified type, or null if no such object is registered.

    • findObjectByTypeOnLeastLoadedNode

      default ObjectPrx findObjectByTypeOnLeastLoadedNode(String type, LoadSample sample)
      Finds a well-known object by type on the least-loaded node. If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.
      Parameters:
      type - The object type.
      sample - The sampling interval.
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByTypeOnLeastLoadedNode

      default ObjectPrx findObjectByTypeOnLeastLoadedNode(String type, LoadSample sample, Map<String,String> context)
      Finds a well-known object by type on the least-loaded node. If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.
      Parameters:
      type - The object type.
      sample - The sampling interval.
      context - the Context map to send with the invocation
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByTypeOnLeastLoadedNodeAsync

      default CompletableFuture<ObjectPrx> findObjectByTypeOnLeastLoadedNodeAsync(String type, LoadSample sample)
      Finds a well-known object by type on the least-loaded node. If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.
      Parameters:
      type - The object type.
      sample - The sampling interval.
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findObjectByTypeOnLeastLoadedNodeAsync

      default CompletableFuture<ObjectPrx> findObjectByTypeOnLeastLoadedNodeAsync(String type, LoadSample sample, Map<String,String> context)
      Finds a well-known object by type on the least-loaded node. If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.
      Parameters:
      type - The object type.
      sample - The sampling interval.
      context - the Context map to send with the invocation
      Returns:
      A proxy to the well-known object, or null if no such object is registered.

    • findAllObjectsByType

      default ObjectPrx[] findAllObjectsByType(String type)
      Finds all the well-known objects with the given type.
      Parameters:
      type - The object type.
      Returns:
      A list of proxies to the well-known objects with the specified type. Can be empty.

    • findAllObjectsByType

      default ObjectPrx[] findAllObjectsByType(String type, Map<String,String> context)
      Finds all the well-known objects with the given type.
      Parameters:
      type - The object type.
      context - the Context map to send with the invocation
      Returns:
      A list of proxies to the well-known objects with the specified type. Can be empty.

    • findAllObjectsByTypeAsync

      default CompletableFuture<ObjectPrx[]> findAllObjectsByTypeAsync(String type)
      Finds all the well-known objects with the given type.
      Parameters:
      type - The object type.
      Returns:
      A list of proxies to the well-known objects with the specified type. Can be empty.

    • findAllObjectsByTypeAsync

      default CompletableFuture<ObjectPrx[]> findAllObjectsByTypeAsync(String type, Map<String,String> context)
      Finds all the well-known objects with the given type.
      Parameters:
      type - The object type.
      context - the Context map to send with the invocation
      Returns:
      A list of proxies to the well-known objects with the specified type. Can be empty.

    • findAllReplicas

      default ObjectPrx[] findAllReplicas(ObjectPrx proxy)
      Finds all the replicas of a well-known object.
      Parameters:
      proxy - A proxy that identifies the well-known object.
      Returns:
      A list of proxies to the replicas of the well-known object specified by proxy. Can be empty.

    • findAllReplicas

      default ObjectPrx[] findAllReplicas(ObjectPrx proxy, Map<String,String> context)
      Finds all the replicas of a well-known object.
      Parameters:
      proxy - A proxy that identifies the well-known object.
      context - the Context map to send with the invocation
      Returns:
      A list of proxies to the replicas of the well-known object specified by proxy. Can be empty.

    • findAllReplicasAsync

      default CompletableFuture<ObjectPrx[]> findAllReplicasAsync(ObjectPrx proxy)
      Finds all the replicas of a well-known object.
      Parameters:
      proxy - A proxy that identifies the well-known object.
      Returns:
      A list of proxies to the replicas of the well-known object specified by proxy. Can be empty.

    • findAllReplicasAsync

      default CompletableFuture<ObjectPrx[]> findAllReplicasAsync(ObjectPrx proxy, Map<String,String> context)
      Finds all the replicas of a well-known object.
      Parameters:
      proxy - A proxy that identifies the well-known object.
      context - the Context map to send with the invocation
      Returns:
      A list of proxies to the replicas of the well-known object specified by proxy. Can be empty.

    • createProxy

      static QueryPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements QueryPrx.
      Parameters:
      communicator - the communicator of the new proxy
      proxyString - the string representation of the proxy
      Returns:
      the new proxy

    • checkedCast

      static QueryPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      Returns:
      a proxy for this type, or null if the target object does not support this type

    • checkedCast

      static QueryPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      context - the Context map to send with the invocation
      Returns:
      a new proxy for this type, or null if the target object does not support this type

    • checkedCast

      static QueryPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      facet - the name of the desired facet
      Returns:
      a new proxy for this type, or null if the facet does not support this type.

    • checkedCast

      static QueryPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
      Parameters:
      obj - the source proxy
      facet - the name of the desired facet
      context - the Context map to send with the invocation
      Returns:
      a new proxy for this type, or null if the target object does not support this type.

    • uncheckedCast

      static QueryPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - the source proxy
      Returns:
      a new proxy with this type or null if obj is null

    • uncheckedCast

      static QueryPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - the source proxy
      facet - the name of the desired facet
      Returns:
      a new proxy with this type or null if obj is null

    • ice_context

      QueryPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - the context for the new proxy
      Returns:
      a proxy with the new per-proxy context

    • ice_adapterId

      QueryPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Parameters:
      newAdapterId - the adapter ID for the new proxy
      Returns:
      a proxy with the new adapter ID

    • ice_endpoints

      QueryPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Parameters:
      newEndpoints - the endpoints for the new proxy
      Returns:
      a proxy with the new endpoints

    • ice_locatorCacheTimeout

      QueryPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - the new locator cache timeout (in seconds)
      Returns:
      a proxy with the new timeout
      See Also:

    • ice_invocationTimeout

      QueryPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - the new invocation timeout (in milliseconds)
      Returns:
      a proxy with the new timeout

    • ice_invocationTimeout

      QueryPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - the new invocation timeout
      Returns:
      a proxy with the new timeout

    • ice_connectionCached

      QueryPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Parameters:
      newCache - true if the new proxy should cache connections, false otherwise
      Returns:
      a proxy with the specified caching policy

    • ice_endpointSelection

      QueryPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Parameters:
      newType - the new endpoint selection policy
      Returns:
      a proxy with the specified endpoint selection policy

    • ice_encodingVersion

      QueryPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - the encoding version to use to marshal request parameters
      Returns:
      a proxy with the specified encoding version

    • ice_router

      QueryPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - the router for the new proxy
      Returns:
      a proxy with the specified router

    • ice_locator

      QueryPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Parameters:
      locator - the locator for the new proxy
      Returns:
      a proxy with the specified locator

    • ice_collocationOptimized

      QueryPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Parameters:
      b - true if the new proxy enables collocation optimization, false otherwise
      Returns:
      a proxy with the specified collocation optimization

    • ice_twoway

      QueryPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      a proxy that uses twoway invocations

    • ice_oneway

      QueryPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      a proxy that uses oneway invocations

    • ice_batchOneway

      QueryPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      a proxy that uses batch oneway invocations

    • ice_datagram

      QueryPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      a proxy that uses datagram invocations

    • ice_batchDatagram

      QueryPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      a proxy that uses batch datagram invocations

    • ice_compress

      QueryPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy, false disables compression.
      Returns:
      a proxy with the specified compression override setting

    • ice_connectionId

      QueryPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - the connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      a proxy with the specified connection ID

    • ice_fixed

      QueryPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - the fixed proxy connection
      Returns:
      a fixed proxy bound to the given connection

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceGrid::Query"