Module com.zeroc.ice
Package com.zeroc.Ice

Interface LocatorRegistryPrx

All Superinterfaces:
ObjectPrx
public interface LocatorRegistryPrx extends ObjectPrx
A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object.

  • Method Details

    • setAdapterDirectProxy

      default void setAdapterDirectProxy(String id, ObjectPrx proxy) throws AdapterNotFoundException, AdapterAlreadyActiveException
      Registers or unregisters the endpoints of an object adapter.
      Parameters:
      id - The adapter ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      Throws:
      AdapterAlreadyActiveException - Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.
      AdapterNotFoundException - Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.

    • setAdapterDirectProxy

      default void setAdapterDirectProxy(String id, ObjectPrx proxy, Map<String,String> context) throws AdapterNotFoundException, AdapterAlreadyActiveException
      Registers or unregisters the endpoints of an object adapter.
      Parameters:
      id - The adapter ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      context - The Context map to send with the invocation.
      Throws:
      AdapterAlreadyActiveException - Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.
      AdapterNotFoundException - Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.

    • setAdapterDirectProxyAsync

      default CompletableFuture<Void> setAdapterDirectProxyAsync(String id, ObjectPrx proxy)
      Registers or unregisters the endpoints of an object adapter.
      Parameters:
      id - The adapter ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      Returns:
      A future that will be completed when the invocation completes.

    • setAdapterDirectProxyAsync

      default CompletableFuture<Void> setAdapterDirectProxyAsync(String id, ObjectPrx proxy, Map<String,String> context)
      Registers or unregisters the endpoints of an object adapter.
      Parameters:
      id - The adapter ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      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 proxy) throws AdapterNotFoundException, AdapterAlreadyActiveException, InvalidReplicaGroupIdException
      Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica group.
      Parameters:
      adapterId - The adapter ID.
      replicaGroupId - The replica group ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      Throws:
      AdapterAlreadyActiveException - Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.
      AdapterNotFoundException - Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.
      InvalidReplicaGroupIdException - Thrown when the given replica group does not match the replica group associated with the adapter ID in the locator's database.

    • setReplicatedAdapterDirectProxy

      default void setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx proxy, Map<String,String> context) throws AdapterNotFoundException, AdapterAlreadyActiveException, InvalidReplicaGroupIdException
      Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica group.
      Parameters:
      adapterId - The adapter ID.
      replicaGroupId - The replica group ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      context - The Context map to send with the invocation.
      Throws:
      AdapterAlreadyActiveException - Thrown when an object adapter with the same adapter ID has already registered its endpoints. Since this operation is marked idempotent, this exception may be thrown when the Ice client runtime retries an invocation with a non-null proxy.
      AdapterNotFoundException - Thrown when the locator only allows registered object adapters to register their endpoints and no object adapter with this adapter ID was registered with the locator.
      InvalidReplicaGroupIdException - Thrown when the given replica group does not match the replica group associated with the adapter ID in the locator's database.

    • setReplicatedAdapterDirectProxyAsync

      default CompletableFuture<Void> setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx proxy)
      Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica group.
      Parameters:
      adapterId - The adapter ID.
      replicaGroupId - The replica group ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      Returns:
      A future that will be completed when the invocation completes.

    • setReplicatedAdapterDirectProxyAsync

      default CompletableFuture<Void> setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx proxy, Map<String,String> context)
      Registers or unregisters the endpoints of an object adapter. This object adapter is a member of a replica group.
      Parameters:
      adapterId - The adapter ID.
      replicaGroupId - The replica group ID.
      proxy - A dummy proxy created by the object adapter. proxy carries the object adapter's endpoints. The locator considers an object adapter to be active after it has registered its endpoints. When proxy is null, the endpoints are unregistered and the locator considers the object adapter inactive.
      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
      Registers a proxy to the ProcessPrx object of a server application.
      Parameters:
      id - The server ID.
      proxy - A proxy to the ProcessPrx object of the server. This proxy is never null.
      Throws:
      ServerNotFoundException - Thrown when the locator does not know a server application with a server ID of id.

    • setServerProcessProxy

      default void setServerProcessProxy(String id, ProcessPrx proxy, Map<String,String> context) throws ServerNotFoundException
      Registers a proxy to the ProcessPrx object of a server application.
      Parameters:
      id - The server ID.
      proxy - A proxy to the ProcessPrx object of the server. This proxy is never null.
      context - The Context map to send with the invocation.
      Throws:
      ServerNotFoundException - Thrown when the locator does not know a server application with a server ID of id.

    • setServerProcessProxyAsync

      default CompletableFuture<Void> setServerProcessProxyAsync(String id, ProcessPrx proxy)
      Registers a proxy to the ProcessPrx object of a server application.
      Parameters:
      id - The server ID.
      proxy - A proxy to the ProcessPrx object of the server. This proxy is never null.
      Returns:
      A future that will be completed when the invocation completes.

    • setServerProcessProxyAsync

      default CompletableFuture<Void> setServerProcessProxyAsync(String id, ProcessPrx proxy, Map<String,String> context)
      Registers a proxy to the ProcessPrx object of a server application.
      Parameters:
      id - The server ID.
      proxy - A proxy to the ProcessPrx object of the server. This proxy is never null.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • createProxy

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

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source 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)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      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 object does not support this type.

    • checkedCast

      static LocatorRegistryPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      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 LocatorRegistryPrx 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. Throws a local exception if a communication error occurs.
      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 object does not support this type.

    • uncheckedCast

      static LocatorRegistryPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A new proxy for this type.

    • uncheckedCast

      static LocatorRegistryPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type.

    • ice_context

      LocatorRegistryPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the new timeout.

    • ice_invocationTimeout

      LocatorRegistryPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      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.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

      LocatorRegistryPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified caching policy.

    • ice_endpointSelection

      LocatorRegistryPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified endpoint selection policy.
      See Also:

    • ice_encodingVersion

      LocatorRegistryPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified encoding version.

    • ice_router

      LocatorRegistryPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified router.

    • ice_locator

      LocatorRegistryPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified locator.

    • ice_collocationOptimized

      LocatorRegistryPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      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:
      The proxy with the specified collocation optimization.

    • ice_twoway

      LocatorRegistryPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a new 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

      LocatorRegistryPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Returns 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 setting.

    • ice_connectionId

      LocatorRegistryPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      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

      LocatorRegistryPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a new 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 "::Ice::LocatorRegistry"