Ice

Interface Communicator

All Known Implementing Classes:

CommunicatorI

public interface Communicator

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:

Logger, ObjectAdapter, Properties, ObjectFactory

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	addAdminFacet(Object servant, java.lang.String facet) Add a new facet to the Admin object.
void	addObjectFactory(ObjectFactory factory, java.lang.String id) Add an object factory to this communicator.
AsyncResult	begin_flushBatchRequests() Flush any pending batch requests for this communicator.
AsyncResult	begin_flushBatchRequests(Callback_Communicator_flushBatchRequests __cb) Flush any pending batch requests for this communicator.
AsyncResult	begin_flushBatchRequests(Callback __cb) Flush any pending batch requests for this communicator.
AsyncResult	begin_flushBatchRequests(Functional_VoidCallback __responseCb, Functional_GenericCallback1<Exception> __exceptionCb, Functional_BoolCallback __sentCb) Flush any pending batch requests for this communicator.
ObjectPrx	createAdmin(ObjectAdapter adminAdapter, Identity adminId) Add the Admin object with all its facets to the provided object adapter.
ObjectAdapter	createObjectAdapter(java.lang.String name) Create a new object adapter.
ObjectAdapter	createObjectAdapterWithEndpoints(java.lang.String name, java.lang.String endpoints) Create a new object adapter with endpoints.
ObjectAdapter	createObjectAdapterWithRouter(java.lang.String name, RouterPrx rtr) Create a new object adapter with a router.
void	destroy() Destroy the communicator.
void	end_flushBatchRequests(AsyncResult __result) Flush any pending batch requests for this communicator.
Object	findAdminFacet(java.lang.String facet) Returns a facet of the Admin object.
java.util.Map<java.lang.String,Object>	findAllAdminFacets() Returns a map of all facets of the Admin object.
ObjectFactory	findObjectFactory(java.lang.String id) Find an object factory registered with this communicator.
void	flushBatchRequests() Flush any pending batch requests for this communicator.
ObjectPrx	getAdmin() Get a proxy to the main facet of the Admin object.
LocatorPrx	getDefaultLocator() Get the default locator this communicator.
RouterPrx	getDefaultRouter() Get the default router this communicator.
ImplicitContext	getImplicitContext() Get the implicit context associated with this communicator.
Logger	getLogger() Get the logger for this communicator.
CommunicatorObserver	getObserver() Get the observer resolver object for this communicator.
PluginManager	getPluginManager() Get the plug-in manager for this communicator.
Properties	getProperties() Get the properties for this communicator.
java.lang.String	identityToString(Identity ident) Convert an identity into a string.
boolean	isShutdown() Check whether communicator has been shut down.
ObjectPrx	propertyToProxy(java.lang.String property) Convert a set of proxy properties into a proxy.
java.util.Map<java.lang.String,java.lang.String>	proxyToProperty(ObjectPrx proxy, java.lang.String property) Convert a proxy to a set of proxy properties.
java.lang.String	proxyToString(ObjectPrx obj) Convert a proxy into a string.
Object	removeAdminFacet(java.lang.String facet) Remove the following facet to the Admin object.
void	setDefaultLocator(LocatorPrx loc) Set a default Ice locator for this communicator.
void	setDefaultRouter(RouterPrx rtr) Set a default router for this communicator.
void	shutdown() Shuts down this communicator's server functionality, which includes the deactivation of all object adapters.
Identity	stringToIdentity(java.lang.String str) Convert a string into an identity.
ObjectPrx	stringToProxy(java.lang.String str) Convert a stringified proxy into a proxy.
void	waitForShutdown() Wait until the application has called shutdown() (or destroy()).

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

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(), ObjectAdapter.destroy()

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:

destroy(), waitForShutdown(), ObjectAdapter.deactivate()

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 block 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:

shutdown(), destroy(), ObjectAdapter.waitForDeactivate()

isShutdown

boolean isShutdown()

Check whether communicator has been shut down.

Returns:

True if the communicator has been shut down; false otherwise.

See Also:

shutdown()

stringToProxy

ObjectPrx stringToProxy(java.lang.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(Ice.ObjectPrx)

proxyToString

java.lang.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:

stringToProxy(java.lang.String)

propertyToProxy

ObjectPrx propertyToProxy(java.lang.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" section in the Ice manual describes each of the supported proxy properties.

Parameters:

property - The base property name.

Returns:

The proxy.

proxyToProperty

java.util.Map<java.lang.String,java.lang.String> proxyToProperty(ObjectPrx proxy,
                                                                 java.lang.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

Identity stringToIdentity(java.lang.String str)

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(Ice.Identity)

identityToString

java.lang.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:

stringToIdentity(java.lang.String)

createObjectAdapter

ObjectAdapter createObjectAdapter(java.lang.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(java.lang.String, java.lang.String), ObjectAdapter, Properties

createObjectAdapterWithEndpoints

ObjectAdapter createObjectAdapterWithEndpoints(java.lang.String name,
                                               java.lang.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:

createObjectAdapter(java.lang.String), ObjectAdapter, Properties

createObjectAdapterWithRouter

ObjectAdapter createObjectAdapterWithRouter(java.lang.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:

createObjectAdapter(java.lang.String), ObjectAdapter, Properties

addObjectFactory

void addObjectFactory(ObjectFactory factory,
                      java.lang.String id)

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 NoObjectFactoryException. If the object uses the "compact" format, Ice immediately raises NoObjectFactoryException. 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(java.lang.String), ObjectFactory

findObjectFactory

ObjectFactory findObjectFactory(java.lang.String id)

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:

addObjectFactory(Ice.ObjectFactory, java.lang.String), ObjectFactory

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:

Properties

getLogger

Logger getLogger()

Get the logger for this communicator.

Returns:

This communicator's logger.

See Also:

Logger

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(Ice.RouterPrx), Router

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:

getDefaultRouter(), createObjectAdapterWithRouter(java.lang.String, Ice.RouterPrx), Router

getDefaultLocator

LocatorPrx getDefaultLocator()

Get the default locator this communicator.

Returns:

The default locator for this communicator.

See Also:

setDefaultLocator(Ice.LocatorPrx), Locator

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(Ice.LocatorPrx) on the object adapter.

Parameters:

loc - The default locator to use for this communicator.

See Also:

getDefaultLocator(), Locator, ObjectAdapter.setLocator(Ice.LocatorPrx)

getPluginManager

PluginManager getPluginManager()

Get the plug-in manager for this communicator.

Returns:

This communicator's plug-in manager.

See Also:

PluginManager

flushBatchRequests

void flushBatchRequests()

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.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests()

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.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Callback __cb)

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:

__cb - A generic callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Callback_Communicator_flushBatchRequests __cb)

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:

__cb - A typed callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

AsyncResult begin_flushBatchRequests(Functional_VoidCallback __responseCb,
                                     Functional_GenericCallback1<Exception> __exceptionCb,
                                     Functional_BoolCallback __sentCb)

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:

__responseCb - The response callback.

__exceptionCb - The exception callback.

__sentCb - The sent callback.

Returns:

The asynchronous result object.

end_flushBatchRequests

void end_flushBatchRequests(AsyncResult __result)

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:

__result - The asynchronous result object.

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 call 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(), LocatorRegistry

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:

createAdmin(Ice.ObjectAdapter, Ice.Identity)

addAdminFacet

void addAdminFacet(Object servant,
                   java.lang.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(java.lang.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(java.lang.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

java.util.Map<java.lang.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:

findAdminFacet(java.lang.String)