# -*- coding: utf-8 -*-
# **********************************************************************
#
# Copyright (c) 2003-2016 ZeroC, Inc. All rights reserved.
#
# This copy of Ice is licensed to you under the terms described in the
# ICE_LICENSE file included in this distribution.
#
# **********************************************************************
#
# Ice version 3.6.3
#
# <auto-generated>
#
# Generated from file `ObjectAdapter.ice'
#
# Warning: do not edit this file.
#
# </auto-generated>
#

from sys import version_info as _version_info_
import Ice, IcePy
import Ice_CommunicatorF_ice
import Ice_ServantLocatorF_ice
import Ice_LocatorF_ice
import Ice_Identity_ice
import Ice_FacetMap_ice
import Ice_Endpoint_ice

# Included module Ice
_M_Ice = Ice.openModule('Ice')

# Start of module Ice
__name__ = 'Ice'

if 'ObjectAdapter' not in _M_Ice.__dict__:
    _M_Ice.ObjectAdapter = Ice.createTempClass()
    class ObjectAdapter(object):
        """
        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.
        """
        def __init__(self):
            if Ice.getType(self) == _M_Ice.ObjectAdapter:
                raise RuntimeError('Ice.ObjectAdapter is an abstract class')

        def getName(self):
            """
            Get the name of this object adapter.
            Returns: This object adapter's name.
            """
            pass

        def getCommunicator(self):
            """
            Get the communicator this object adapter belongs to.
            Returns: This object adapter's communicator.
            """
            pass

        def activate(self):
            """
            Activate all endpoints that belong to this object adapter.
            After activation, the object adapter can dispatch requests
            received through its endpoints.
            """
            pass

        def hold(self):
            """
            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.
            """
            pass

        def waitForHold(self):
            """
            Wait until the object adapter holds requests. Calling hold
            initiates holding of requests, and waitForHold only returns
            when holding of requests has been completed.
            """
            pass

        def deactivate(self):
            """
            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. Once deactivated, it is possible to
            destroy the adapter to clean up resources and then create and
            activate a new adapter with the same name.
             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.
            """
            pass

        def waitForDeactivate(self):
            """
            Wait until the object adapter has deactivated. Calling
            deactivate initiates object adapter deactivation, and
            waitForDeactivate only returns when deactivation has
            been completed.
            """
            pass

        def isDeactivated(self):
            """
            Check whether object adapter has been deactivated.
            Returns: Whether adapter has been deactivated.
            """
            pass

        def destroy(self):
            """
            Destroys the object adapter and cleans up all resources held by
            the object adapter. If the object adapter has not yet been
            deactivated, destroy implicitly initiates the deactivation
            and waits for it to finish. Subsequent calls to destroy are
            ignored. Once destroy has returned, it is possible to create
            another object adapter with the same name.
            """
            pass

        def add(self, servant, 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.
            Arguments:
            servant -- The servant to add.
            id -- The identity of the Ice object that is implemented by the servant.
            Returns: A proxy that matches the given identity and this object adapter.
            """
            pass

        def addFacet(self, servant, id, facet):
            """
            Like add, but with a facet. Calling add(servant, id)
            is equivalent to calling addFacet with an empty facet.
            Arguments:
            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.
            Returns: A proxy that matches the given identity, facet, and this object adapter.
            """
            pass

        def addWithUUID(self, 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.
            Arguments:
            servant -- The servant to add.
            Returns: A proxy that matches the generated UUID identity and this object adapter.
            """
            pass

        def addFacetWithUUID(self, servant, facet):
            """
            Like addWithUUID, but with a facet. Calling
            addWithUUID(servant) is equivalent to calling
            addFacetWithUUID with an empty facet.
            Arguments:
            servant -- The servant to add.
            facet -- The facet. An empty facet means the default facet.
            Returns: A proxy that matches the generated UUID identity, facet, and this object adapter.
            """
            pass

        def addDefaultServant(self, servant, category):
            """
            Add a default servant to handle requests for a specific
            category. Adding a default servant for a category for
            which a default servant 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 default servant for the category
            component of the identity.
            If no servant has been found by any of the preceding steps,
            the object adapter tries to find a default servant for an empty
            category, regardless of the category contained in the identity.
            If no servant has been found by any of the preceding steps,
            the object adapter gives up and the caller receives
            ObjectNotExistException or FacetNotExistException.
            Arguments:
            servant -- The default servant.
            category -- The category for which the default servant is registered. An empty category means it will handle all categories.
            """
            pass

        def remove(self, id):
            """
            Remove a servant (that is, the default facet) from the object
            adapter's Active Servant Map.
            Arguments:
            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.
            Returns: The removed servant.
            """
            pass

        def removeFacet(self, id, facet):
            """
            Like remove, but with a facet. Calling remove(id)
            is equivalent to calling removeFacet with an empty facet.
            Arguments:
            id -- The identity of the Ice object that is implemented by the servant.
            facet -- The facet. An empty facet means the default facet.
            Returns: The removed servant.
            """
            pass

        def removeAllFacets(self, 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.
            Arguments:
            id -- The identity of the Ice object to be removed.
            Returns: A collection containing all the facet names and servants of the removed Ice object.
            """
            pass

        def removeDefaultServant(self, category):
            """
            Remove the default servant for a specific category. Attempting
            to remove a default servant for a category that is not
            registered throws NotRegisteredException.
            Arguments:
            category -- The category of the default servant to remove.
            Returns: The default servant.
            """
            pass

        def find(self, 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 look up a servant in
            the Active Servant Map. It does not attempt to find a servant
            by using any installed ServantLocator.
            Arguments:
            id -- The identity of the Ice object for which the servant should be returned.
            Returns: The servant that implements the Ice object with the given identity, or null if no such servant has been found.
            """
            pass

        def findFacet(self, id, facet):
            """
            Like find, but with a facet. Calling find(id)
            is equivalent to calling findFacet with an empty
            facet.
            Arguments:
            id -- The identity of the Ice object for which the servant should be returned.
            facet -- The facet. An empty facet means the default facet.
            Returns: The servant that implements the Ice object with the given identity and facet, or null if no such servant has been found.
            """
            pass

        def findAllFacets(self, id):
            """
            Find all facets with the given identity in the Active Servant
            Map.
            Arguments:
            id -- The identity of the Ice object for which the facets should be returned.
            Returns: 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.
            """
            pass

        def findByProxy(self, 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
            by using any installed ServantLocator.
            Arguments:
            proxy -- The proxy for which the servant should be returned.
            Returns: The servant that matches the proxy, or null if no such servant has been found.
            """
            pass

        def addServantLocator(self, locator, 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 servant 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 by 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.
            Arguments:
            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.
            """
            pass

        def removeServantLocator(self, category):
            """
            Remove a Servant Locator from this object adapter.
            Arguments:
            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.
            Returns: The Servant Locator, or throws NotRegisteredException if no Servant Locator was found for the given category.
            """
            pass

        def findServantLocator(self, category):
            """
            Find a Servant Locator installed with this object adapter.
            Arguments:
            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.
            Returns: The Servant Locator, or null if no Servant Locator was found for the given category.
            """
            pass

        def findDefaultServant(self, category):
            """
            Find the default servant for a specific category.
            Arguments:
            category -- The category of the default servant to find.
            Returns: The default servant or null if no default servant was registered for the category.
            """
            pass

        def createProxy(self, 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.
            Arguments:
            id -- The object's identity.
            Returns: A proxy for the object with the given identity.
            """
            pass

        def createDirectProxy(self, id):
            """
            Create a direct proxy for the object with the given identity.
            The returned proxy contains this object adapter's published
            endpoints.
            Arguments:
            id -- The object's identity.
            Returns: A proxy for the object with the given identity.
            """
            pass

        def createIndirectProxy(self, 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.
            Arguments:
            id -- The object's identity.
            Returns: A proxy for the object with the given identity.
            """
            pass

        def setLocator(self, 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 identifier
            instead of its endpoints. The adapter identifier must be configured
            using the AdapterId property.
            Arguments:
            loc -- The locator used by this object adapter.
            """
            pass

        def getLocator(self):
            """
            Get the Ice locator used by this object adapter.
            Returns: The locator used by this object adapter, or null if no locator is used by this object adapter.
            """
            pass

        def refreshPublishedEndpoints(self):
            """
            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.
            """
            pass

        def getEndpoints(self):
            """
            Get the set of endpoints configured with this object adapter.
            Returns: The set of endpoints.
            """
            pass

        def getPublishedEndpoints(self):
            """
            Get the set of endpoints that proxies created by this object
            adapter will contain.
            Returns: The set of published endpoints.
            """
            pass

        def __str__(self):
            return IcePy.stringify(self, _M_Ice._t_ObjectAdapter)

        __repr__ = __str__

    _M_Ice._t_ObjectAdapter = IcePy.defineClass('::Ice::ObjectAdapter', ObjectAdapter, -1, (), True, False, None, (), ())
    ObjectAdapter._ice_type = _M_Ice._t_ObjectAdapter

    _M_Ice.ObjectAdapter = ObjectAdapter
    del ObjectAdapter

# End of module Ice
