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.

Remarks: The Slice compiler generated this proxy interface from Slice interface ::Ice::LocatorRegistry.

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static LocatorRegistryPrx	checkedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
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.
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.
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.
static LocatorRegistryPrx	createProxy(Communicator communicator, String proxyString)	Creates a new proxy that implements LocatorRegistryPrx.
LocatorRegistryPrx	ice_adapterId(String newAdapterId)	Creates a proxy that is identical to this proxy, except for the adapter ID.
LocatorRegistryPrx	ice_batchDatagram()	Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
LocatorRegistryPrx	ice_batchOneway()	Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
LocatorRegistryPrx	ice_collocationOptimized(boolean b)	Creates a proxy that is identical to this proxy, except for collocation optimization.
LocatorRegistryPrx	ice_compress(boolean co)	Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
LocatorRegistryPrx	ice_connectionCached(boolean newCache)	Creates a proxy that is identical to this proxy, except for connection caching.
LocatorRegistryPrx	ice_connectionId(String connectionId)	Creates a proxy that is identical to this proxy, except for its connection ID.
LocatorRegistryPrx	ice_context(Map<String,String> newContext)	Creates a proxy that is identical to this proxy, except for the per-proxy context.
LocatorRegistryPrx	ice_datagram()	Creates a proxy that is identical to this proxy, but uses datagram invocations.
LocatorRegistryPrx	ice_encodingVersion(EncodingVersion e)	Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
LocatorRegistryPrx	ice_endpoints(Endpoint[] newEndpoints)	Creates a proxy that is identical to this proxy, except for the endpoints.
LocatorRegistryPrx	ice_endpointSelection(EndpointSelectionType newType)	Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
LocatorRegistryPrx	ice_fixed(Connection connection)	Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
LocatorRegistryPrx	ice_invocationTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorRegistryPrx	ice_invocationTimeout(Duration newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorRegistryPrx	ice_locator(LocatorPrx locator)	Creates a proxy that is identical to this proxy, except for the locator.
LocatorRegistryPrx	ice_locatorCacheTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the locator cache timeout.
LocatorRegistryPrx	ice_oneway()	Creates a proxy that is identical to this proxy, but uses oneway invocations.
LocatorRegistryPrx	ice_router(RouterPrx router)	Creates a proxy that is identical to this proxy, except for the router.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
LocatorRegistryPrx	ice_twoway()	Creates a proxy that is identical to this proxy, but uses twoway invocations.
default void	setAdapterDirectProxy(String id, ObjectPrx proxy)	Registers or unregisters the endpoints of an object adapter.
default void	setAdapterDirectProxy(String id, ObjectPrx proxy, Map<String,String> context)	Registers or unregisters the endpoints of an object adapter.
default CompletableFuture<Void>	setAdapterDirectProxyAsync(String id, ObjectPrx proxy)	Registers or unregisters the endpoints of an object adapter.
default CompletableFuture<Void>	setAdapterDirectProxyAsync(String id, ObjectPrx proxy, Map<String,String> context)	Registers or unregisters the endpoints of an object adapter.
default void	setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx proxy)	Registers or unregisters the endpoints of an object adapter.
default void	setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx proxy, Map<String,String> context)	Registers or unregisters the endpoints of an object adapter.
default CompletableFuture<Void>	setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx proxy)	Registers or unregisters the endpoints of an object adapter.
default CompletableFuture<Void>	setReplicatedAdapterDirectProxyAsync(String adapterId, String replicaGroupId, ObjectPrx proxy, Map<String,String> context)	Registers or unregisters the endpoints of an object adapter.
default void	setServerProcessProxy(String id, ProcessPrx proxy)	Registers a proxy to the ProcessPrx object of a server application.
default void	setServerProcessProxy(String id, ProcessPrx proxy, Map<String,String> context)	Registers a proxy to the ProcessPrx object of a server application.
default CompletableFuture<Void>	setServerProcessProxyAsync(String id, ProcessPrx proxy)	Registers a proxy to the ProcessPrx object of a server application.
default CompletableFuture<Void>	setServerProcessProxyAsync(String id, ProcessPrx proxy, Map<String,String> context)	Registers a proxy to the ProcessPrx object of a server application.
static LocatorRegistryPrx	uncheckedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy.
static LocatorRegistryPrx	uncheckedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy.

Methods inherited from interface com.zeroc.Ice.ObjectPrx

equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isTwoway, ice_locatorCacheTimeout, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync

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.

Parameters:

obj - the source proxy

Returns:

a proxy for this type, or null if the target 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.

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 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.

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.

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 LocatorRegistryPrx 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 LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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:

• Locator

ice_invocationTimeout

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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

LocatorRegistryPrx 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 "::Ice::LocatorRegistry"