Package com.zeroc.Ice

Interface LocatorRegistryPrx

All Superinterfaces:
ObjectPrx
public interface LocatorRegistryPrx extends ObjectPrx
The Ice locator registry interface. This interface is used by servers to register adapter endpoints with the locator.

The LocatorRegistry interface is intended to be used by Ice internals and by locator implementations. Regular user code should not attempt to use any functionality of this interface directly.

  • Method Details

    • setAdapterDirectProxy

      default void setAdapterDirectProxy(String id, ObjectPrx proxy) throws AdapterAlreadyActiveException, AdapterNotFoundException
      Set the adapter endpoints with the locator registry.
      Parameters:
      id - The adapter id.
      proxy - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      Throws:
      AdapterAlreadyActiveException - Raised if an adapter with the same id is already active.
      AdapterNotFoundException - Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.

    • setAdapterDirectProxy

      default void setAdapterDirectProxy(String id, ObjectPrx proxy, Map<String,String> context) throws AdapterAlreadyActiveException, AdapterNotFoundException
      Set the adapter endpoints with the locator registry.
      Parameters:
      id - The adapter id.
      proxy - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      context - The Context map to send with the invocation.
      Throws:
      AdapterAlreadyActiveException - Raised if an adapter with the same id is already active.
      AdapterNotFoundException - Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.

    • setAdapterDirectProxyAsync

      default CompletableFuture<Void> setAdapterDirectProxyAsync(String id, ObjectPrx proxy)
      Set the adapter endpoints with the locator registry.
      Parameters:
      id - The adapter id.
      proxy - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      Returns:
      A future that will be completed when the invocation completes.

    • setAdapterDirectProxyAsync

      default CompletableFuture<Void> setAdapterDirectProxyAsync(String id, ObjectPrx proxy, Map<String,String> context)
      Set the adapter endpoints with the locator registry.
      Parameters:
      id - The adapter id.
      proxy - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • setReplicatedAdapterDirectProxy

      default void setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx p) throws AdapterAlreadyActiveException, AdapterNotFoundException, InvalidReplicaGroupIdException
      Set the adapter endpoints with the locator registry.
      Parameters:
      adapterId - The adapter id.
      replicaGroupId - The replica group id.
      p - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      Throws:
      AdapterAlreadyActiveException - Raised if an adapter with the same id is already active.
      AdapterNotFoundException - Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.
      InvalidReplicaGroupIdException - Raised if the given replica group doesn't match the one registered with the locator registry for this object adapter.

    • setReplicatedAdapterDirectProxy

      default void setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx p, Map<String,String> context) throws AdapterAlreadyActiveException, AdapterNotFoundException, InvalidReplicaGroupIdException
      Set the adapter endpoints with the locator registry.
      Parameters:
      adapterId - The adapter id.
      replicaGroupId - The replica group id.
      p - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      context - The Context map to send with the invocation.
      Throws:
      AdapterAlreadyActiveException - Raised if an adapter with the same id is already active.
      AdapterNotFoundException - Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.
      InvalidReplicaGroupIdException - Raised if the given replica group doesn't match the one registered with the locator registry for this object adapter.

    • setReplicatedAdapterDirectProxyAsync

      default CompletableFuture<Void> setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx p)
      Set the adapter endpoints with the locator registry.
      Parameters:
      adapterId - The adapter id.
      replicaGroupId - The replica group id.
      p - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      Returns:
      A future that will be completed when the invocation completes.

    • setReplicatedAdapterDirectProxyAsync

      default CompletableFuture<Void> setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx p, Map<String,String> context)
      Set the adapter endpoints with the locator registry.
      Parameters:
      adapterId - The adapter id.
      replicaGroupId - The replica group id.
      p - The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • setServerProcessProxy

      default void setServerProcessProxy(String id, ProcessPrx proxy) throws ServerNotFoundException
      Set the process proxy for a server.
      Parameters:
      id - The server id.
      proxy - The process proxy.
      Throws:
      ServerNotFoundException - Raised if the server cannot be found.

    • setServerProcessProxy

      default void setServerProcessProxy(String id, ProcessPrx proxy, Map<String,String> context) throws ServerNotFoundException
      Set the process proxy for a server.
      Parameters:
      id - The server id.
      proxy - The process proxy.
      context - The Context map to send with the invocation.
      Throws:
      ServerNotFoundException - Raised if the server cannot be found.

    • setServerProcessProxyAsync

      default CompletableFuture<Void> setServerProcessProxyAsync(String id, ProcessPrx proxy)
      Set the process proxy for a server.
      Parameters:
      id - The server id.
      proxy - The process proxy.
      Returns:
      A future that will be completed when the invocation completes.

    • setServerProcessProxyAsync

      default CompletableFuture<Void> setServerProcessProxyAsync(String id, ProcessPrx proxy, Map<String,String> context)
      Set the process proxy for a server.
      Parameters:
      id - The server id.
      proxy - The process proxy.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj, String facet)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static LocatorRegistryPrx uncheckedCast(ObjectPrx obj)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type.

    • uncheckedCast

      static LocatorRegistryPrx uncheckedCast(ObjectPrx obj, String facet)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type.

    • ice_context

      default LocatorRegistryPrx ice_context(Map<String,String> newContext)
      Returns 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 specified per-proxy context.

    • ice_adapterId

      default LocatorRegistryPrx ice_adapterId(String newAdapterId)
      Returns 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 specified adapter ID.

    • ice_endpoints

      default LocatorRegistryPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns 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 specified endpoints.

    • ice_locatorCacheTimeout

      default LocatorRegistryPrx ice_locatorCacheTimeout(int newTimeout)
      Returns 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 specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default LocatorRegistryPrx ice_invocationTimeout(int newTimeout)
      Returns 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 specified invocation timeout.

    • ice_connectionCached

      default LocatorRegistryPrx ice_connectionCached(boolean newCache)
      Returns 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

      default LocatorRegistryPrx ice_endpointSelection(EndpointSelectionType newType)
      Returns 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.
      See Also:

    • ice_secure

      default LocatorRegistryPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      Specified by:
      ice_secure in interface ObjectPrx
      Parameters:
      b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.
      Returns:
      A proxy with the specified selection policy.

    • ice_encodingVersion

      default LocatorRegistryPrx ice_encodingVersion(EncodingVersion e)
      Returns 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_preferSecure

      default LocatorRegistryPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      Specified by:
      ice_preferSecure in interface ObjectPrx
      Parameters:
      b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.
      Returns:
      A proxy with the specified selection policy.

    • ice_router

      default LocatorRegistryPrx ice_router(RouterPrx router)
      Returns 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

      default LocatorRegistryPrx ice_locator(LocatorPrx locator)
      Returns 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

      default LocatorRegistryPrx ice_collocationOptimized(boolean b)
      Returns 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

      default LocatorRegistryPrx ice_twoway()
      Returns 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

      default LocatorRegistryPrx ice_oneway()
      Returns 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

      default LocatorRegistryPrx ice_batchOneway()
      Returns 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

      default LocatorRegistryPrx ice_datagram()
      Returns 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

      default LocatorRegistryPrx ice_batchDatagram()
      Returns 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

      default LocatorRegistryPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      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 setting.

    • ice_timeout

      default LocatorRegistryPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting.
      Specified by:
      ice_timeout in interface ObjectPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

      default LocatorRegistryPrx ice_connectionId(String connectionId)
      Returns 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

      default LocatorRegistryPrx ice_fixed(Connection connection)
      Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy 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()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.