Module com.zeroc.ice

Package com.zeroc.Ice

Interface LocatorRegistry

All Superinterfaces:

Object

public interface LocatorRegistry
extends Object

A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
void	setAdapterDirectProxy(String id, ObjectPrx proxy, Current current)	Registers or unregisters the endpoints of an object adapter.
void	setReplicatedAdapterDirectProxy(String adapterId, String replicaGroupId, ObjectPrx proxy, Current current)	Registers or unregisters the endpoints of an object adapter.
void	setServerProcessProxy(String id, ProcessPrx proxy, Current current)	Registers a proxy to the ProcessPrx object of a server application.

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

setAdapterDirectProxy

void setAdapterDirectProxy(String id,
 ObjectPrx proxy,
 Current current)
                    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.

current - the Current object of the incoming request

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.

setReplicatedAdapterDirectProxy

void setReplicatedAdapterDirectProxy(String adapterId,
 String replicaGroupId,
 ObjectPrx proxy,
 Current current)
                              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.

current - the Current object of the incoming request

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.

setServerProcessProxy

void setServerProcessProxy(String id,
 ProcessPrx proxy,
 Current current)
                    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.

current - the Current object of the incoming request

Throws:

ServerNotFoundException - Thrown when the locator does not know a server application with a server ID of id.

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::Ice::LocatorRegistry"

dispatch

default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request)
                                            throws UserException

Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

UserException - if a UserException is thrown, Ice will marshal it as the response payload.