Ice::ObjectAdapter

Overview

local interface ObjectAdapter

The object adapter provides an up-call interface from the Ice run time to the implementation of Ice objects. The object adapter is responsible for receiving requests from endpoints, and for mapping between servants, identities, and proxies.

Used By

::Freeze::ServantInitializer::initialize
Communicator::createObjectAdapter
Communicator::createObjectAdapterWithEndpoints
Communicator::createObjectAdapterWithRouter
Connection::getAdapter
Connection::setAdapter
Current::adapter

Operation Index

getName: Get the name of this object adapter.
getCommunicator: Get the communicator this object adapter belongs to.
activate: Activate all endpoints that belong to this object adapter.
hold: Temporarily hold receiving and dispatching requests.
waitForHold: Wait until the object adapter holds requests.
deactivate: Deactivate all endpoints that belong to this object adapter.
waitForDeactivate: Wait until the object adapter has deactivated.
isDeactivated: Check whether object adapter has been deacivated.
destroy: Destroys the object adapter and cleans up all resources held by the object adapter.
add: Add a servant to this object adapter's Active Servant Map.
addFacet: Like add, but with a facet.
addWithUUID: Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as its identity.
addFacetWithUUID: Like addWithUUID, but with a facet.
remove: Remove a servant (that is, the default facet) from the object adapter's Active Servant Map.
removeFacet: Like remove, but with a facet.
removeAllFacets: Remove all facets with the given identity from the Active Servant Map.
find: Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it implements.
findFacet: Like find, but with a facet.
findAllFacets: Find all facets with the given identity in the Active Servant Map.
findByProxy: Look up a servant in this object adapter's Active Servant Map, given a proxy.
addServantLocator: Add a Servant Locator to this object adapter.
findServantLocator: Find a Servant Locator installed with this object adapter.
createProxy: Create a proxy for the object with the given identity.
createDirectProxy: Create a direct proxy for the object with the given identity.
createIndirectProxy: Create an indirect proxy for the object with the given identity.
setLocator: Set an Ice locator for this object adapter.
refreshPublishedEndpoints: Refresh the set of published endpoints.

Operations

string getName()

Get the name of this object adapter.

Return Value

This object adapter's name.

Communicator getCommunicator()

Get the communicator this object adapter belongs to.

Return Value

This object adapter's communicator.

void activate()

Activate all endpoints that belong to this object adapter. After activation, the object adapter can dispatch requests received through its endpoints.

void hold()

Temporarily hold receiving and dispatching requests. The object adapter can be reactivated with the activate operation.

Holding is not immediate, i.e., after hold returns, the object adapter might still be active for some time. You can use waitForHold to wait until holding is complete.

void waitForHold()

Wait until the object adapter holds requests. Calling hold initiates holding of requests, and waitForHold only returns when holding of requests has been completed.

void deactivate()

Deactivate all endpoints that belong to this object adapter. After deactivation, the object adapter stops receiving requests through its endpoints. Object adapters that have been deactivated must not be reactivated again, and cannot be used otherwise. Attempts to use a deactivated object adapter raise ObjectAdapterDeactivatedException; however, attempts to deactivate an already deactivated object adapter are ignored and do nothing.

After deactivate returns, no new requests are processed by the object adapter. However, requests that have been started before deactivate was called might still be active. You can use waitForDeactivate to wait for the completion of all requests for this object adapter.

void waitForDeactivate()

Wait until the object adapter has deactivated. Calling deactivate initiates object adapter deactivation, and waitForDeactivate only returns when deactivation has been completed.

bool isDeactivated()

Check whether object adapter has been deacivated.

Return Value

Whether adapter has been deactivated.

void destroy()

Destroys the object adapter and cleans up all resources held by the object adapter. If object adapter has not yet been deactivated, destroy implicitly initiates the deactivation and waits for it to finish. Once destroy has returned it is possible to recreate an object adapter with the same name. Subsequent calls to destroy are ignored.

Object* add(Object servant, Identity id)

Add a servant to this object adapter's Active Servant Map. Note that one servant can implement several Ice objects by registering the servant with multiple identities. Adding a servant with an identity that is in the map already throws AlreadyRegisteredException.

Parameters

servant: The servant to add.
id: The identity of the Ice object that is implemented by the servant.

Return Value

A proxy that matches the given identity and this object adapter.

Object* addFacet(Object servant, Identity id, string facet)

Like add, but with a facet. Calling add(servant, * id) is equivalent to calling addFacet with an empty facet.

Parameters

servant: The servant to add.
id: The identity of the Ice object that is implemented by the servant.
facet: The facet. An empty facet means the default facet.

Return Value

A proxy that matches the given identity, facet, and this object adapter.

Object* addWithUUID(Object servant)

Add a servant to this object adapter's Active Servant Map, using an automatically generated UUID as its identity. Note that the generated UUID identity can be accessed using the proxy's ice_getIdentity operation.

Parameters

servant: The servant to add.

Return Value

A proxy that matches the generated UUID identity and this object adapter.

Object* addFacetWithUUID(Object servant, string facet)

Like addWithUUID, but with a facet. Calling addWithUUID(servant) is equivalent to calling addFacetWithUUID with an empty facet.

Parameters

servant: The servant to add.
facet: The facet. An empty facet means the default facet.

Return Value

A proxy that matches the generated UUID identity, facet, and this object adapter.

Object remove(Identity id)

Remove a servant (that is, the default facet) from the object adapter's Active Servant Map.

Parameters

id: The identity of the Ice object that is implemented by the servant. If the servant implements multiple Ice objects, remove has to be called for all those Ice objects. Removing an identity that is not in the map throws NotRegisteredException.

Return Value

The removed servant.

Object removeFacet(Identity id, string facet)

Like remove, but with a facet. Calling remove(id) is equivalent to calling removeFacet with an empty facet.

Parameters

id: The identity of the Ice object that is implemented by the servant.
facet: The facet. An empty facet means the default facet.

Return Value

The removed servant.

FacetMap removeAllFacets(Identity id)

Remove all facets with the given identity from the Active Servant Map. The operation completely removes the Ice object, including its default facet. Removing an identity that is not in the map throws NotRegisteredException.

Parameters

id: The identity of the Ice object to be removed.

Return Value

A collection containing all the facet names and servants of the removed Ice object.

Object find(Identity id)

Look up a servant in this object adapter's Active Servant Map by the identity of the Ice object it implements.

This operation only tries to lookup a servant in the Active Servant Map. It does not attempt to find a servant by using any installed ServantLocator.

Parameters

id: The identity of the Ice object for which the servant should be returned.

Return Value

The servant that implements the Ice object with the given identity, or null if no such servant has been found.

Object findFacet(Identity id, string facet)

Like find, but with a facet. Calling find(id) is equivalent to calling findFacet with an empty facet.

Parameters

id: The identity of the Ice object for which the servant should be returned.
facet: The facet. An empty facet means the default facet.

Return Value

The servant that implements the Ice object with the given identity and facet, or null if no such servant has been found.

FacetMap findAllFacets(Identity id)

Find all facets with the given identity in the Active Servant Map.

Parameters

id: The identity of the Ice object for which the facets should be returned.

Return Value

A collection containing all the facet names and servants that have been found, or an empty map if there is no facet for the given identity.

Object findByProxy(Object* proxy)

Look up a servant in this object adapter's Active Servant Map, given a proxy.

This operation only tries to lookup a servant in the Active Servant Map. It does not attempt to find a servant via any installed ServantLocators.

Parameters

proxy: The proxy for which the servant should be returned.

Return Value

The servant that matches the proxy, or null if no such servant has been found.

void addServantLocator(ServantLocator locator, string category)

Add a Servant Locator to this object adapter. Adding a servant locator for a category for which a servant locator is already registered throws AlreadyRegisteredException. To dispatch operation calls on servants, the object adapter tries to find a servant for a given Ice object identity and facet in the following order:

The object adapter tries to find a servant for the identity and facet in the Active Servant Map.
If no servant has been found in the Active Servant Map, the object adapter tries to find a locator for the category component of the identity. If a locator is found, the object adapter tries to find a servant using this locator.
If no servant has been found by any of the preceding steps, the object adapter tries to find a locator for an empty category, regardless of the category contained in the identity. If a locator is found, the object adapter tries to find a servant using this locator.
If no servant has been found with any of the preceding steps, the object adapter gives up and the caller receives ObjectNotExistException or FacetNotExistException.

Only one locator for the empty category can be installed.

Parameters

locator: The locator to add.
category: The category for which the Servant Locator can locate servants, or an empty string if the Servant Locator does not belong to any specific category.

ServantLocator findServantLocator(string category)

Find a Servant Locator installed with this object adapter.

Parameters

category: The category for which the Servant Locator can locate servants, or an empty string if the Servant Locator does not belong to any specific category.

Return Value

The Servant Locator, or null if no Servant Locator was found for the given category.

Object* createProxy(Identity id)

Create a proxy for the object with the given identity. If this object adapter is configured with an adapter id, the return value is an indirect proxy that refers to the adapter id. If a replica group id is also defined, the return value is an indirect proxy that refers to the replica group id. Otherwise, if no adapter id is defined, the return value is a direct proxy containing this object adapter's published endpoints.

Parameters

id: The object's identity.

Return Value

A proxy for the object with the given identity.

Object* createDirectProxy(Identity id)

Create a direct proxy for the object with the given identity. The returned proxy contains this object adapter's published endpoints.

Parameters

id: The object's identity.

Return Value

A proxy for the object with the given identity.

Object* createIndirectProxy(Identity id)

Create an indirect proxy for the object with the given identity. If this object adapter is configured with an adapter id, the return value refers to the adapter id. Otherwise, the return value contains only the object identity.

Parameters

id: The object's identity.

Return Value

A proxy for the object with the given identity.

void setLocator(Locator* loc)

Set an Ice locator for this object adapter. By doing so, the object adapter will register itself with the locator registry when it is activated for the first time. Furthermore, the proxies created by this object adapter will contain the adapter name instead of its endpoints.

Parameters

loc: The locator used by this object adapter.

void refreshPublishedEndpoints()

Refresh the set of published endpoints. The run time re-reads the PublishedEndpoints property if it is set and re-reads the list of local interfaces if the adapter is configured to listen on all endpoints. This operation is useful to refresh the endpoint information that is published in the proxies that are created by an object adapter if the network interfaces used by a host changes.

Ice::ObjectAdapter

Overview

local interface ObjectAdapter

Used By

See Also

Operation Index

Operations

string getName()

Return Value

Communicator getCommunicator()

Return Value

See Also

void activate()

See Also

void hold()

See Also

void waitForHold()

See Also

void deactivate()

See Also

void waitForDeactivate()

See Also

bool isDeactivated()

Return Value

See Also

void destroy()

See Also

Object* add(Object servant, Identity id)

Parameters

Return Value

See Also

Object* addFacet(Object servant, Identity id, string facet)

Parameters

Return Value

See Also

Object* addWithUUID(Object servant)

Parameters

Return Value

See Also

Object* addFacetWithUUID(Object servant, string facet)

Parameters

Return Value

See Also

Object remove(Identity id)

Parameters

Return Value

See Also

Object removeFacet(Identity id, string facet)

Parameters

Return Value

See Also

FacetMap removeAllFacets(Identity id)

Parameters

Return Value

See Also

Object find(Identity id)

Parameters

Return Value

See Also

Object findFacet(Identity id, string facet)

Parameters

Return Value

See Also

FacetMap findAllFacets(Identity id)

Parameters

Return Value

See Also

Object findByProxy(Object* proxy)

Parameters

Return Value

See Also

void addServantLocator(ServantLocator locator, string category)

Parameters

See Also

ServantLocator findServantLocator(string category)

Parameters

Return Value

See Also

Object* createProxy(Identity id)

Parameters