Ice

Class CommunicatorI

java.lang.Object

Ice.CommunicatorI

All Implemented Interfaces:

Communicator

public final class CommunicatorI
extends java.lang.Object
implements Communicator

Field Summary

Fields inherited from interface Ice.Communicator

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 router) Create a new object adapter with a router.
void	destroy() Destroy the communicator.
void	end_flushBatchRequests(AsyncResult r) 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.
Instance	getInstance()
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 s) Convert a set of proxy properties into a proxy.
java.util.Map<java.lang.String,java.lang.String>	proxyToProperty(ObjectPrx proxy, java.lang.String prefix) Convert a proxy to a set of proxy properties.
java.lang.String	proxyToString(ObjectPrx proxy) Convert a proxy into a string.
Object	removeAdminFacet(java.lang.String facet) Remove the following facet to the Admin object.
void	setDefaultLocator(LocatorPrx locator) Set a default Ice locator for this communicator.
void	setDefaultRouter(RouterPrx router) 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 s) Convert a string into an identity.
ObjectPrx	stringToProxy(java.lang.String s) Convert a stringified proxy into a proxy.
void	waitForShutdown() Wait until the application has called Communicator.shutdown() (or Communicator.destroy()).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

destroy

public void destroy()

Description copied from interface: Communicator

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

Specified by:

destroy in interface Communicator

See Also:

Communicator.shutdown(), ObjectAdapter.destroy()

shutdown

public void shutdown()

Description copied from interface: Communicator

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 Communicator.waitForShutdown() to wait for the completion of all requests.

Specified by:

shutdown in interface Communicator

See Also:

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

waitForShutdown

public void waitForShutdown()

Description copied from interface: Communicator

Wait until the application has called Communicator.shutdown() (or Communicator.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 Communicator.shutdown() or Communicator.destroy(). A typical use of this operation is to call it from the main thread, which then waits until some other thread calls Communicator.shutdown(). After shut-down is complete, the main thread returns and can do some cleanup work before it finally calls Communicator.destroy() to shut down the client functionality, and then exits the application.

Specified by:

waitForShutdown in interface Communicator

See Also:

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

isShutdown

public boolean isShutdown()

Description copied from interface: Communicator

Check whether communicator has been shut down.

Specified by:

isShutdown in interface Communicator

Returns:

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

See Also:

Communicator.shutdown()

stringToProxy

public ObjectPrx stringToProxy(java.lang.String s)

Description copied from interface: Communicator

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.

Specified by:

stringToProxy in interface Communicator

Parameters:

s - The stringified proxy to convert into a proxy.

Returns:

The proxy, or nil if str is an empty string.

See Also:

Communicator.proxyToString(Ice.ObjectPrx)

proxyToString

public java.lang.String proxyToString(ObjectPrx proxy)

Description copied from interface: Communicator

Convert a proxy into a string.

Specified by:

proxyToString in interface Communicator

Parameters:

proxy - The proxy to convert into a stringified proxy.

Returns:

The stringified proxy, or an empty string if obj is nil.

See Also:

Communicator.stringToProxy(java.lang.String)

propertyToProxy

public ObjectPrx propertyToProxy(java.lang.String s)

Description copied from interface: Communicator

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.

Specified by:

propertyToProxy in interface Communicator

Parameters:

s - The base property name.

Returns:

The proxy.

proxyToProperty

public java.util.Map<java.lang.String,java.lang.String> proxyToProperty(ObjectPrx proxy,
                                                                        java.lang.String prefix)

Description copied from interface: Communicator

Convert a proxy to a set of proxy properties.

Specified by:

proxyToProperty in interface Communicator

Parameters:

proxy - The proxy.

prefix - The base property name.

Returns:

The property set.

stringToIdentity

public Identity stringToIdentity(java.lang.String s)

Description copied from interface: Communicator

Convert a string into an identity. If the string does not parse correctly, the operation throws IdentityParseException.

Specified by:

stringToIdentity in interface Communicator

Parameters:

s - The string to convert into an identity.

Returns:

The identity.

See Also:

Communicator.identityToString(Ice.Identity)

identityToString

public java.lang.String identityToString(Identity ident)

Description copied from interface: Communicator

Convert an identity into a string.

Specified by:

identityToString in interface Communicator

Parameters:

ident - The identity to convert into a string.

Returns:

The "stringified" identity.

See Also:

Communicator.stringToIdentity(java.lang.String)

createObjectAdapter

public ObjectAdapter createObjectAdapter(java.lang.String name)

Description copied from interface: Communicator

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.

Specified by:

createObjectAdapter in interface Communicator

Parameters:

name - The object adapter name.

Returns:

The new object adapter.

See Also:

Communicator.createObjectAdapterWithEndpoints(java.lang.String, java.lang.String), ObjectAdapter, Properties

createObjectAdapterWithEndpoints

public ObjectAdapter createObjectAdapterWithEndpoints(java.lang.String name,
                                                      java.lang.String endpoints)

Description copied from interface: Communicator

Create a new object adapter with endpoints. This operation sets the property name.Endpoints, and then calls Communicator.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.

Specified by:

createObjectAdapterWithEndpoints in interface Communicator

Parameters:

name - The object adapter name.

endpoints - The endpoints for the object adapter.

Returns:

The new object adapter.

See Also:

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

createObjectAdapterWithRouter

public ObjectAdapter createObjectAdapterWithRouter(java.lang.String name,
                                                   RouterPrx router)

Description copied from interface: Communicator

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.

Specified by:

createObjectAdapterWithRouter in interface Communicator

Parameters:

name - The object adapter name.

router - The router.

Returns:

The new object adapter.

See Also:

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

addObjectFactory

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

Description copied from interface: Communicator

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.

Specified by:

addObjectFactory in interface Communicator

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:

Communicator.findObjectFactory(java.lang.String), ObjectFactory

findObjectFactory

public ObjectFactory findObjectFactory(java.lang.String id)

Description copied from interface: Communicator

Find an object factory registered with this communicator.

Specified by:

findObjectFactory in interface 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:

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

getProperties

public Properties getProperties()

Description copied from interface: Communicator

Get the properties for this communicator.

Specified by:

getProperties in interface Communicator

Returns:

This communicator's properties.

See Also:

Properties

getLogger

public Logger getLogger()

Description copied from interface: Communicator

Get the logger for this communicator.

Specified by:

getLogger in interface Communicator

Returns:

This communicator's logger.

See Also:

Logger

getObserver

public CommunicatorObserver getObserver()

Description copied from interface: Communicator

Get the observer resolver object for this communicator.

Specified by:

getObserver in interface Communicator

Returns:

This communicator's observer resolver object.

getDefaultRouter

public RouterPrx getDefaultRouter()

Description copied from interface: Communicator

Get the default router this communicator.

Specified by:

getDefaultRouter in interface Communicator

Returns:

The default router for this communicator.

See Also:

Communicator.setDefaultRouter(Ice.RouterPrx), Router

setDefaultRouter

public void setDefaultRouter(RouterPrx router)

Description copied from interface: Communicator

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.

Specified by:

setDefaultRouter in interface Communicator

Parameters:

router - The default router to use for this communicator.

See Also:

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

getDefaultLocator

public LocatorPrx getDefaultLocator()

Description copied from interface: Communicator

Get the default locator this communicator.

Specified by:

getDefaultLocator in interface Communicator

Returns:

The default locator for this communicator.

See Also:

Communicator.setDefaultLocator(Ice.LocatorPrx), Locator

setDefaultLocator

public void setDefaultLocator(LocatorPrx locator)

Description copied from interface: Communicator

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.

Specified by:

setDefaultLocator in interface Communicator

Parameters:

locator - The default locator to use for this communicator.

See Also:

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

getImplicitContext

public ImplicitContext getImplicitContext()

Description copied from interface: Communicator

Get the implicit context associated with this communicator.

Specified by:

getImplicitContext in interface Communicator

Returns:

The implicit context associated with this communicator; returns null when the property Ice.ImplicitContext is not set or is set to None.

getPluginManager

public PluginManager getPluginManager()

Description copied from interface: Communicator

Get the plug-in manager for this communicator.

Specified by:

getPluginManager in interface Communicator

Returns:

This communicator's plug-in manager.

See Also:

PluginManager

flushBatchRequests

public void flushBatchRequests()

Description copied from interface: Communicator

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.

Specified by:

flushBatchRequests in interface Communicator

begin_flushBatchRequests

public AsyncResult begin_flushBatchRequests()

Description copied from interface: Communicator

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.

Specified by:

begin_flushBatchRequests in interface Communicator

Returns:

The asynchronous result object.

begin_flushBatchRequests

public AsyncResult begin_flushBatchRequests(Callback cb)

Description copied from interface: Communicator

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.

Specified by:

begin_flushBatchRequests in interface Communicator

Parameters:

cb - A generic callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

public AsyncResult begin_flushBatchRequests(Callback_Communicator_flushBatchRequests cb)

Description copied from interface: Communicator

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.

Specified by:

begin_flushBatchRequests in interface Communicator

Parameters:

cb - A typed callback.

Returns:

The asynchronous result object.

begin_flushBatchRequests

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

Description copied from interface: Communicator

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.

Specified by:

begin_flushBatchRequests in interface Communicator

Parameters:

__responseCb - The response callback.

__exceptionCb - The exception callback.

__sentCb - The sent callback.

Returns:

The asynchronous result object.

end_flushBatchRequests

public void end_flushBatchRequests(AsyncResult r)

Description copied from interface: Communicator

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.

Specified by:

end_flushBatchRequests in interface Communicator

Parameters:

r - The asynchronous result object.

createAdmin

public ObjectPrx createAdmin(ObjectAdapter adminAdapter,
                             Identity adminId)

Description copied from interface: Communicator

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.

Specified by:

createAdmin in interface Communicator

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:

Communicator.getAdmin(), LocatorRegistry

getAdmin

public ObjectPrx getAdmin()

Description copied from interface: Communicator

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.

Specified by:

getAdmin in interface Communicator

Returns:

A proxy to the main ("") facet of the Admin object, or a null proxy if no Admin object is configured.

See Also:

Communicator.createAdmin(Ice.ObjectAdapter, Ice.Identity)

addAdminFacet

public void addAdminFacet(Object servant,
                          java.lang.String facet)

Description copied from interface: Communicator

Add a new facet to the Admin object. Adding a servant with a facet that is already registered throws AlreadyRegisteredException.

Specified by:

addAdminFacet in interface Communicator

Parameters:

servant - The servant that implements the new Admin facet.

facet - The name of the new Admin facet.

removeAdminFacet

public Object removeAdminFacet(java.lang.String facet)

Description copied from interface: Communicator

Remove the following facet to the Admin object. Removing a facet that was not previously registered throws NotRegisteredException.

Specified by:

removeAdminFacet in interface Communicator

Parameters:

facet - The name of the Admin facet.

Returns:

The servant associated with this Admin facet.

findAdminFacet

public Object findAdminFacet(java.lang.String facet)

Description copied from interface: Communicator

Returns a facet of the Admin object.

Specified by:

findAdminFacet in interface Communicator

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

public java.util.Map<java.lang.String,Object> findAllAdminFacets()

Description copied from interface: Communicator

Returns a map of all facets of the Admin object.

Specified by:

findAllAdminFacets in interface Communicator

Returns:

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

See Also:

Communicator.findAdminFacet(java.lang.String)

getInstance

public Instance getInstance()