Module com.zeroc.ice

Package com.zeroc.Ice

Interface LocatorPrx

All Superinterfaces:

ObjectPrx

All Known Subinterfaces:

LocatorPrx

public interface LocatorPrx
extends ObjectPrx

Client applications use the Locator object to resolve Ice indirect proxies. This object also allows server applications to retrieve a proxy to the associated LocatorRegistryPrx object where they can register their object adapters.

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

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static LocatorPrx	checkedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static LocatorPrx	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 LocatorPrx	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 LocatorPrx	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 LocatorPrx	createProxy(Communicator communicator, String proxyString)	Creates a new proxy that implements LocatorPrx.
default ObjectPrx	findAdapterById(String id)	Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
default ObjectPrx	findAdapterById(String id, Map<String,String> context)	Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
default CompletableFuture<ObjectPrx>	findAdapterByIdAsync(String id)	Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
default CompletableFuture<ObjectPrx>	findAdapterByIdAsync(String id, Map<String,String> context)	Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).
default ObjectPrx	findObjectById(Identity id)	Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
default ObjectPrx	findObjectById(Identity id, Map<String,String> context)	Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
default CompletableFuture<ObjectPrx>	findObjectByIdAsync(Identity id)	Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
default CompletableFuture<ObjectPrx>	findObjectByIdAsync(Identity id, Map<String,String> context)	Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object.
default LocatorRegistryPrx	getRegistry()	Gets a proxy to the locator registry.
default LocatorRegistryPrx	getRegistry(Map<String,String> context)	Gets a proxy to the locator registry.
default CompletableFuture<LocatorRegistryPrx>	getRegistryAsync()	Gets a proxy to the locator registry.
default CompletableFuture<LocatorRegistryPrx>	getRegistryAsync(Map<String,String> context)	Gets a proxy to the locator registry.
LocatorPrx	ice_adapterId(String newAdapterId)	Creates a proxy that is identical to this proxy, except for the adapter ID.
LocatorPrx	ice_batchDatagram()	Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
LocatorPrx	ice_batchOneway()	Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
LocatorPrx	ice_collocationOptimized(boolean b)	Creates a proxy that is identical to this proxy, except for collocation optimization.
LocatorPrx	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.
LocatorPrx	ice_connectionCached(boolean newCache)	Creates a proxy that is identical to this proxy, except for connection caching.
LocatorPrx	ice_connectionId(String connectionId)	Creates a proxy that is identical to this proxy, except for its connection ID.
LocatorPrx	ice_context(Map<String,String> newContext)	Creates a proxy that is identical to this proxy, except for the per-proxy context.
LocatorPrx	ice_datagram()	Creates a proxy that is identical to this proxy, but uses datagram invocations.
LocatorPrx	ice_encodingVersion(EncodingVersion e)	Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
LocatorPrx	ice_endpoints(Endpoint[] newEndpoints)	Creates a proxy that is identical to this proxy, except for the endpoints.
LocatorPrx	ice_endpointSelection(EndpointSelectionType newType)	Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
LocatorPrx	ice_fixed(Connection connection)	Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
LocatorPrx	ice_invocationTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorPrx	ice_invocationTimeout(Duration newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
LocatorPrx	ice_locator(LocatorPrx locator)	Creates a proxy that is identical to this proxy, except for the locator.
LocatorPrx	ice_locatorCacheTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the locator cache timeout.
LocatorPrx	ice_oneway()	Creates a proxy that is identical to this proxy, but uses oneway invocations.
LocatorPrx	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.
LocatorPrx	ice_twoway()	Creates a proxy that is identical to this proxy, but uses twoway invocations.
static LocatorPrx	uncheckedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy.
static LocatorPrx	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

findObjectById

default ObjectPrx findObjectById(Identity id)
                          throws ObjectNotFoundException

Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using findAdapterById(java.lang.String).

Parameters:

id - The identity.

Returns:

A dummy proxy, or null if an object with the requested identity was not found.

Throws:

ObjectNotFoundException - Thrown when an object with the requested identity was not found. The caller should treat this exception like a null return value.

findObjectById

default ObjectPrx findObjectById(Identity id,
 Map<String,String> context)
                          throws ObjectNotFoundException

Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using findAdapterById(java.lang.String).

Parameters:

id - The identity.

context - the Context map to send with the invocation

Returns:

A dummy proxy, or null if an object with the requested identity was not found.

Throws:

ObjectNotFoundException - Thrown when an object with the requested identity was not found. The caller should treat this exception like a null return value.

findObjectByIdAsync

default CompletableFuture<ObjectPrx> findObjectByIdAsync(Identity id)

Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using findAdapterById(java.lang.String).

Parameters:

id - The identity.

Returns:

A dummy proxy, or null if an object with the requested identity was not found.

findObjectByIdAsync

default CompletableFuture<ObjectPrx> findObjectByIdAsync(Identity id,
 Map<String,String> context)

Finds an object by identity and returns a dummy proxy with the endpoint(s) that can be used to reach this object. This dummy proxy may be an indirect proxy that requires further resolution using findAdapterById(java.lang.String).

Parameters:

id - The identity.

context - the Context map to send with the invocation

Returns:

A dummy proxy, or null if an object with the requested identity was not found.

findAdapterById

default ObjectPrx findAdapterById(String id)
                           throws AdapterNotFoundException

Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).

Parameters:

id - The adapter ID.

Returns:

A dummy proxy with the adapter's endpoints, or null if an object adapter with id was not found.

Throws:

AdapterNotFoundException - Thrown when an object adapter with this adapter ID was not found. The caller should treat this exception like a null return value.

findAdapterById

default ObjectPrx findAdapterById(String id,
 Map<String,String> context)
                           throws AdapterNotFoundException

Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).

Parameters:

id - The adapter ID.

context - the Context map to send with the invocation

Returns:

A dummy proxy with the adapter's endpoints, or null if an object adapter with id was not found.

Throws:

AdapterNotFoundException - Thrown when an object adapter with this adapter ID was not found. The caller should treat this exception like a null return value.

findAdapterByIdAsync

default CompletableFuture<ObjectPrx> findAdapterByIdAsync(String id)

Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).

Parameters:

id - The adapter ID.

Returns:

A dummy proxy with the adapter's endpoints, or null if an object adapter with id was not found.

findAdapterByIdAsync

default CompletableFuture<ObjectPrx> findAdapterByIdAsync(String id,
 Map<String,String> context)

Finds an object adapter by adapter ID and returns a dummy proxy with the object adapter's endpoint(s).

Parameters:

id - The adapter ID.

context - the Context map to send with the invocation

Returns:

A dummy proxy with the adapter's endpoints, or null if an object adapter with id was not found.

getRegistry

default LocatorRegistryPrx getRegistry()

Gets a proxy to the locator registry.

Returns:

A proxy to the locator registry, or null if this locator has no associated registry.

getRegistry

default LocatorRegistryPrx getRegistry(Map<String,String> context)

Gets a proxy to the locator registry.

Parameters:

context - the Context map to send with the invocation

Returns:

A proxy to the locator registry, or null if this locator has no associated registry.

getRegistryAsync

default CompletableFuture<LocatorRegistryPrx> getRegistryAsync()

Gets a proxy to the locator registry.

Returns:

A proxy to the locator registry, or null if this locator has no associated registry.

getRegistryAsync

default CompletableFuture<LocatorRegistryPrx> getRegistryAsync(Map<String,String> context)

Gets a proxy to the locator registry.

Parameters:

context - the Context map to send with the invocation

Returns:

A proxy to the locator registry, or null if this locator has no associated registry.

createProxy

static LocatorPrx createProxy(Communicator communicator,
 String proxyString)

Creates a new proxy that implements LocatorPrx.

Parameters:

communicator - the communicator of the new proxy

proxyString - the string representation of the proxy

Returns:

the new proxy

checkedCast

static LocatorPrx 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 LocatorPrx 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 LocatorPrx 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 LocatorPrx 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 LocatorPrx 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 LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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

LocatorPrx 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::Locator"