Package com.zeroc.Ice

Interface Communicator

All Superinterfaces:
AutoCloseable
public interface Communicator extends AutoCloseable
The central object in Ice. One or more communicators can be instantiated for an Ice application. Communicator instantiation is language-specific, and not specified in Slice code.
See Also:

  • Method Details

    • close

      void close()
      Destroy the communicator. This Java-only method overrides close in java.lang.AutoCloseable and does not throw any exception.
      Specified by:
      close in interface AutoCloseable
      See Also:

    • destroy

      void destroy()
      Destroy the communicator. This operation calls shutdown() implicitly. Calling destroy() cleans up memory, and shuts down this communicator's client functionality and destroys all object adapters. Subsequent calls to destroy() are ignored.
      See Also:

    • shutdown

      void shutdown()
      Shuts down this communicator's server functionality, which includes the deactivation of all object adapters. Attempts to use a deactivated object adapter raise ObjectAdapterDeactivatedException. Subsequent calls to shutdown are ignored. After shutdown returns, no new requests are processed. However, requests that have been started before shutdown was called might still be active. You can use waitForShutdown() to wait for the completion of all requests.
      See Also:

    • waitForShutdown

      void waitForShutdown()
      Wait until the application has called shutdown() (or destroy()). On the server side, this operation blocks the calling thread until all currently-executing operations have completed. On the client side, the operation simply blocks until another thread has called shutdown() or destroy(). A typical use of this operation is to call it from the main thread, which then waits until some other thread calls shutdown(). After shut-down is complete, the main thread returns and can do some cleanup work before it finally calls destroy() to shut down the client functionality, and then exits the application.
      See Also:

    • isShutdown

      boolean isShutdown()
      Check whether communicator has been shut down.
      Returns:
      True if the communicator has been shut down; false otherwise.
      See Also:

    • stringToProxy

      ObjectPrx stringToProxy(String str)
      Convert a stringified proxy into a proxy. For example, MyCategory/MyObject:tcp -h some_host -p 10000 creates a proxy that refers to the Ice object having an identity with a name "MyObject" and a category "MyCategory", with the server running on host "some_host", port 10000. If the stringified proxy does not parse correctly, the operation throws one of ProxyParseException, EndpointParseException, or IdentityParseException. Refer to the Ice manual for a detailed description of the syntax supported by stringified proxies.
      Parameters:
      str - The stringified proxy to convert into a proxy.
      Returns:
      The proxy, or nil if str is an empty string.
      See Also:

    • proxyToString

      String proxyToString(ObjectPrx obj)
      Convert a proxy into a string.
      Parameters:
      obj - The proxy to convert into a stringified proxy.
      Returns:
      The stringified proxy, or an empty string if obj is nil.
      See Also:

    • propertyToProxy

      ObjectPrx propertyToProxy(String property)
      Convert a set of proxy properties into a proxy. The "base" name supplied in the property argument refers to a property containing a stringified proxy, such as MyProxy=id:tcp -h localhost -p 10000. Additional properties configure local settings for the proxy, such as MyProxy.PreferSecure=1. The "Properties" appendix in the Ice manual describes each of the supported proxy properties.
      Parameters:
      property - The base property name.
      Returns:
      The proxy.

    • proxyToProperty

      Map<String,String> proxyToProperty(ObjectPrx proxy, String property)
      Convert a proxy to a set of proxy properties.
      Parameters:
      proxy - The proxy.
      property - The base property name.
      Returns:
      The property set.

    • stringToIdentity

      @Deprecated Identity stringToIdentity(String str)
      Deprecated.
      stringToIdentity() is deprecated, use the static stringToIdentity() method instead.
      Convert a string into an identity. If the string does not parse correctly, the operation throws IdentityParseException.
      Parameters:
      str - The string to convert into an identity.
      Returns:
      The identity.
      See Also:

    • identityToString

      String identityToString(Identity ident)
      Convert an identity into a string.
      Parameters:
      ident - The identity to convert into a string.
      Returns:
      The "stringified" identity.
      See Also:

    • createObjectAdapter

      ObjectAdapter createObjectAdapter(String name)
      Create a new object adapter. The endpoints for the object adapter are taken from the property name.Endpoints. It is legal to create an object adapter with the empty string as its name. Such an object adapter is accessible via bidirectional connections or by collocated invocations that originate from the same communicator as is used by the adapter. Attempts to create a named object adapter for which no configuration can be found raise InitializationException.
      Parameters:
      name - The object adapter name.
      Returns:
      The new object adapter.
      See Also:

    • createObjectAdapterWithEndpoints

      ObjectAdapter createObjectAdapterWithEndpoints(String name, String endpoints)
      Create a new object adapter with endpoints. This operation sets the property name.Endpoints, and then calls createObjectAdapter(java.lang.String). It is provided as a convenience function. Calling this operation with an empty name will result in a UUID being generated for the name.
      Parameters:
      name - The object adapter name.
      endpoints - The endpoints for the object adapter.
      Returns:
      The new object adapter.
      See Also:

    • createObjectAdapterWithRouter

      ObjectAdapter createObjectAdapterWithRouter(String name, RouterPrx rtr)
      Create a new object adapter with a router. This operation creates a routed object adapter. Calling this operation with an empty name will result in a UUID being generated for the name.
      Parameters:
      name - The object adapter name.
      rtr - The router.
      Returns:
      The new object adapter.
      See Also:

    • addObjectFactory

      @Deprecated void addObjectFactory(ObjectFactory factory, String id)
      Deprecated.
      addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.
      Add an object factory to this communicator. Installing a factory with an id for which a factory is already registered throws AlreadyRegisteredException. When unmarshaling an Ice object, the Ice run time reads the most-derived type id off the wire and attempts to create an instance of the type using a factory. If no instance is created, either because no factory was found, or because all factories returned nil, the behavior of the Ice run time depends on the format with which the object was marshaled: If the object uses the "sliced" format, Ice ascends the class hierarchy until it finds a type that is recognized by a factory, or it reaches the least-derived type. If no factory is found that can create an instance, the run time throws NoValueFactoryException. If the object uses the "compact" format, Ice immediately raises NoValueFactoryException. The following order is used to locate a factory for a type:
      1. The Ice run-time looks for a factory registered specifically for the type.
      2. If no instance has been created, the Ice run-time looks for the default factory, which is registered with an empty type id.
      3. If no instance has been created by any of the preceding steps, the Ice run-time looks for a factory that may have been statically generated by the language mapping for non-abstract classes.
      Parameters:
      factory - The factory to add.
      id - The type id for which the factory can create instances, or an empty string for the default factory.
      See Also:

    • findObjectFactory

      @Deprecated ObjectFactory findObjectFactory(String id)
      Deprecated.
      findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.
      Find an object factory registered with this communicator.
      Parameters:
      id - The type id for which the factory can create instances, or an empty string for the default factory.
      Returns:
      The object factory, or null if no object factory was found for the given id.
      See Also:

    • getImplicitContext

      ImplicitContext getImplicitContext()
      Get the implicit context associated with this communicator.
      Returns:
      The implicit context associated with this communicator; returns null when the property Ice.ImplicitContext is not set or is set to None.

    • getProperties

      Properties getProperties()
      Get the properties for this communicator.
      Returns:
      This communicator's properties.
      See Also:

    • getLogger

      Logger getLogger()
      Get the logger for this communicator.
      Returns:
      This communicator's logger.
      See Also:

    • getObserver

      CommunicatorObserver getObserver()
      Get the observer resolver object for this communicator.
      Returns:
      This communicator's observer resolver object.

    • getDefaultRouter

      RouterPrx getDefaultRouter()
      Get the default router this communicator.
      Returns:
      The default router for this communicator.
      See Also:

    • setDefaultRouter

      void setDefaultRouter(RouterPrx rtr)
      Set a default router for this communicator. All newly created proxies will use this default router. To disable the default router, null can be used. Note that this operation has no effect on existing proxies. You can also set a router for an individual proxy by calling the operation ice_router on the proxy.
      Parameters:
      rtr - The default router to use for this communicator.
      See Also:

    • getDefaultLocator

      LocatorPrx getDefaultLocator()
      Get the default locator this communicator.
      Returns:
      The default locator for this communicator.
      See Also:

    • setDefaultLocator

      void setDefaultLocator(LocatorPrx loc)
      Set a default Ice locator for this communicator. All newly created proxy and object adapters will use this default locator. To disable the default locator, null can be used. Note that this operation has no effect on existing proxies or object adapters. You can also set a locator for an individual proxy by calling the operation ice_locator on the proxy, or for an object adapter by calling ObjectAdapter.setLocator(com.zeroc.Ice.LocatorPrx) on the object adapter.
      Parameters:
      loc - The default locator to use for this communicator.
      See Also:

    • getPluginManager

      PluginManager getPluginManager()
      Get the plug-in manager for this communicator.
      Returns:
      This communicator's plug-in manager.
      See Also:

    • getValueFactoryManager

      ValueFactoryManager getValueFactoryManager()
      Get the value factory manager for this communicator.
      Returns:
      This communicator's value factory manager.
      See Also:

    • flushBatchRequests

      void flushBatchRequests(CompressBatch compress)
      Flush any pending batch requests for this communicator. This means all batch requests invoked on fixed proxies for all connections associated with the communicator. Any errors that occur while flushing a connection are ignored.
      Parameters:
      compress - Specifies whether or not the queued batch requests should be compressed before being sent over the wire.

    • flushBatchRequestsAsync

      CompletableFuture<Void> flushBatchRequestsAsync(CompressBatch compress)
      Flush any pending batch requests for this communicator. This means all batch requests invoked on fixed proxies for all connections associated with the communicator. Any errors that occur while flushing a connection are ignored.
      Parameters:
      compress - Specifies whether or not the queued batch requests should be compressed before being sent over the wire.
      Returns:
      A future that will be completed when the invocation completes.

    • createAdmin

      ObjectPrx createAdmin(ObjectAdapter adminAdapter, Identity adminId)
      Add the Admin object with all its facets to the provided object adapter. If Ice.Admin.ServerId is set and the provided object adapter has a Locator, createAdmin registers the Admin's Process facet with the Locator's LocatorRegistry. createAdmin must only be called once; subsequent calls raise InitializationException.
      Parameters:
      adminAdapter - The object adapter used to host the Admin object; if null and Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
      adminId - The identity of the Admin object.
      Returns:
      A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
      See Also:

    • getAdmin

      ObjectPrx getAdmin()
      Get a proxy to the main facet of the Admin object. getAdmin also creates the Admin object and creates and activates the Ice.Admin object adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin object created by getAdmin is {value of Ice.Admin.InstanceName}/admin, or {UUID}/admin when Ice.Admin.InstanceName is not set. If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator initialization, after initialization of all plugins.
      Returns:
      A proxy to the main ("") facet of the Admin object, or a null proxy if no Admin object is configured.
      See Also:

    • addAdminFacet

      void addAdminFacet(Object servant, String facet)
      Add a new facet to the Admin object. Adding a servant with a facet that is already registered throws AlreadyRegisteredException.
      Parameters:
      servant - The servant that implements the new Admin facet.
      facet - The name of the new Admin facet.

    • removeAdminFacet

      Object removeAdminFacet(String facet)
      Remove the following facet to the Admin object. Removing a facet that was not previously registered throws NotRegisteredException.
      Parameters:
      facet - The name of the Admin facet.
      Returns:
      The servant associated with this Admin facet.

    • findAdminFacet

      Object findAdminFacet(String facet)
      Returns a facet of the Admin object.
      Parameters:
      facet - The name of the Admin facet.
      Returns:
      The servant associated with this Admin facet, or null if no facet is registered with the given name.

    • findAllAdminFacets

      Map<String,Object> findAllAdminFacets()
      Returns a map of all facets of the Admin object.
      Returns:
      A collection containing all the facet names and servants of the Admin object.
      See Also: