Ice::ObjectAdapter

Ice Reference Documentation
<<< Previous | Slice Documentation | Next >>>

# `Ice::ObjectAdapter`

## Overview

    local interface ObjectAdapter

The object adapter, which 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

### See Also

`Communicator`, `ServantLocator`

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

`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 (that is, completely remove the Ice object, including its default facet).

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

`createReverseProxy`

  Create a "reverse proxy" for the object with the given identity.

`setLocator`

  Set an Ice locator for this object adapter.

## `getName`

    string getName();

Get the name of this object adapter.

### Return Value

This object adapter's name.

## `getCommunicator`

    Communicator getCommunicator();

Get the communicator this object adapter belongs to.

### Return Value

This object adapter's communicator.

### See Also

`Communicator`

## `activate`

    void activate();

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

### See Also

`hold`, `deactivate`

## `hold`

    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.

### See Also

`activate`, `deactivate`, `waitForHold`

## `waitForHold`

    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.

### See Also

`hold`, `waitForDeactivate`, `Communicator::waitForShutdown`

## `deactivate`

    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.

### See Also

`activate`, `hold`, `waitForDeactivate`, `Communicator::shutdown`

## `waitForDeactivate`

    void waitForDeactivate();

Wait until the object adapter has deactivated. Calling `deactivate` initiates object adapter deactivation, and `waitForDeactivate` only returns when deactivation has been completed. Once waitForDeactivate has returned it is possible to recreate an object adapter with the same name.

### See Also

`deactivate`, `waitForHold`, `Communicator::waitForShutdown`

## `add`

    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.

### See Also

`Identity`, `addFacet`, `addWithUUID`, `remove`, `find`

## `addFacet`

    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.

### See Also

`Identity`, `add`, `addFacetWithUUID`, `removeFacet`, `findFacet`

## `addWithUUID`

    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.

### See Also

`Identity`, `add`, `addFacetWithUUID`, `remove`, `find`

## `addFacetWithUUID`

    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.

### See Also

`Identity`, `addFacet`, `addWithUUID`, `removeFacet`, `findFacet`

## `remove`

    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.

### See Also

`Identity`, `add`, `addWithUUID`

## `removeFacet`

    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.

### See Also

`Identity`, `addFacet`, `addFacetWithUUID`

## `removeAllFacets`

    FacetMap removeAllFacets(Identity id);

Remove all facets with the given identity from the Active Servant Map (that is, completely remove 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.

### See Also

`remove`, `removeFacet`

## `find`

    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.

### See Also

`Identity`, `findFacet`, `findByProxy`

## `findFacet`

    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.

### See Also

`Identity`, `find`, `findByProxy`

## `findAllFacets`

    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 which have been found, or an empty map if there is no facet for the given identity.

### See Also

`find`, `findFacet`

## `findByProxy`

    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 `ServantLocator`s.

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

### See Also

`find`, `findFacet`

## `addServantLocator`

    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:

1. The object adapter tries to find a servant for the identity and facet in the Active Servant Map.

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

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

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

### See Also

`Identity`, `findServantLocator`, `ServantLocator`

## `findServantLocator`

    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.

### See Also

`Identity`, `addServantLocator`, `ServantLocator`

## `createProxy`

    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.

### See Also

`Identity`

## `createDirectProxy`

    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.

### See Also

`Identity`

## `createIndirectProxy`

    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.

### See Also

`Identity`

## `createReverseProxy`

    Object* createReverseProxy(Identity id);

Create a "reverse proxy" for the object with the given identity. A reverse proxy uses the incoming connections that have been established from a client to this object adapter.

| This operation is intended to be used by special services, such as `Router` implementations. Regular user code should not attempt to use this operation.

### Parameters

`id`

  The identity for which a proxy is to be created.

### Return Value

A "reverse proxy" that matches the given identity and uses the incoming connections of this object adapter.

### See Also

`Identity`

## `setLocator`

    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.

### See Also

`createDirectProxy`, `Locator`, `LocatorRegistry`

<<< Previous | Home | Next >>>
`Ice::NotRegisteredException` | Up | `Ice::ObjectAdapterDeactivatedException`