IceGrid

Interface _RegistryPluginFacadeOperationsNC

public interface _RegistryPluginFacadeOperationsNC

The RegistryPluginFacade is implemented by IceGrid and can be used by plugins and filter implementations to retrieve information from IceGrid about the well-known objects or adapters. It's also used to register/unregister replica group and type filters.

Method Summary

Modifier and Type	Method and Description
void	addReplicaGroupFilter(java.lang.String id, ReplicaGroupFilter filter) Add a replica group filter.
void	addTypeFilter(java.lang.String type, TypeFilter filter) Add a type filter.
java.lang.String	getAdapterApplication(java.lang.String adapterId) Get the name of the application to which the given adapter belongs.
AdapterInfo[]	getAdapterInfo(java.lang.String id) Get the adapter information for the replica group or adapter with the given id.
java.lang.String	getAdapterNode(java.lang.String adapterId) Get the name of the node to which the given adapter belongs.
java.lang.String	getAdapterServer(java.lang.String adapterId) Get the ID of the server to which the given adapter belongs.
ApplicationInfo	getApplicationInfo(java.lang.String name) Get an application descriptor.
NodeInfo	getNodeInfo(java.lang.String name) Get the node information for the node with the given name.
LoadInfo	getNodeLoad(java.lang.String name) Get the load averages of the node.
ObjectInfo	getObjectInfo(Ice.Identity id) Get the object info for the object with the given identity.
java.lang.String	getPropertyForAdapter(java.lang.String adapterId, java.lang.String name) Get the property value for the given property and adapter.
ServerInfo	getServerInfo(java.lang.String id) Get the server information for the server with the given id.
boolean	removeReplicaGroupFilter(java.lang.String id, ReplicaGroupFilter filter) Remove a replica group filter.
boolean	removeTypeFilter(java.lang.String type, TypeFilter filter) Remove a type filter.

Method Detail

getApplicationInfo

ApplicationInfo getApplicationInfo(java.lang.String name)
                            throws ApplicationNotExistException

Get an application descriptor.

Parameters:

name - The application name.

Returns:

The application descriptor.

Throws:

ApplicationNotExistException - Raised if the application doesn't exist.

getServerInfo

ServerInfo getServerInfo(java.lang.String id)
                  throws ServerNotExistException

Get the server information for the server with the given id.

Parameters:

id - The server id.

Returns:

The server information.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

getAdapterServer

java.lang.String getAdapterServer(java.lang.String adapterId)
                           throws AdapterNotExistException

Get the ID of the server to which the given adapter belongs.

Parameters:

adapterId - The adapter ID.

Returns:

The server ID or the empty string if the given identifier is not associated to an object adapter defined with an application descriptor.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

getAdapterApplication

java.lang.String getAdapterApplication(java.lang.String adapterId)
                                throws AdapterNotExistException

Get the name of the application to which the given adapter belongs.

Parameters:

adapterId - The adapter ID.

Returns:

The application name or the empty string if the given identifier is not associated to a replica group or object adapter defined with an application descriptor.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

getAdapterNode

java.lang.String getAdapterNode(java.lang.String adapterId)
                         throws AdapterNotExistException

Get the name of the node to which the given adapter belongs.

Parameters:

adapterId - The adapter ID.

Returns:

The node name or the empty string if the given identifier is not associated to an object adapter defined with an application descriptor.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

getAdapterInfo

AdapterInfo[] getAdapterInfo(java.lang.String id)
                      throws AdapterNotExistException

Get the adapter information for the replica group or adapter with the given id.

Parameters:

id - The adapter id.

Returns:

A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.

Throws:

AdapterNotExistException - Raised if the adapter or replica group doesn't exist.

getObjectInfo

ObjectInfo getObjectInfo(Ice.Identity id)
                  throws ObjectNotRegisteredException

Get the object info for the object with the given identity.

Parameters:

id - The identity of the object.

Returns:

The object info.

Throws:

ObjectNotRegisteredException - Raised if the object isn't registered with the registry.

getNodeInfo

NodeInfo getNodeInfo(java.lang.String name)
              throws NodeNotExistException,
                     NodeUnreachableException

Get the node information for the node with the given name.

Parameters:

name - The node name.

Returns:

The node information.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

getNodeLoad

LoadInfo getNodeLoad(java.lang.String name)
              throws NodeNotExistException,
                     NodeUnreachableException

Get the load averages of the node.

Parameters:

name - The node name.

Returns:

The node load information.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

getPropertyForAdapter

java.lang.String getPropertyForAdapter(java.lang.String adapterId,
                                       java.lang.String name)
                                throws AdapterNotExistException

Get the property value for the given property and adapter. The property is looked up in the server or service descriptor where the adapter is defined.

Parameters:

adapterId - The adapter ID

name - The name of the property.

Returns:

The property value.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

addReplicaGroupFilter

void addReplicaGroupFilter(java.lang.String id,
                           ReplicaGroupFilter filter)

Add a replica group filter.

Parameters:

id - The identifier of the filter. This identifier must match the value of the "filter" attribute specified in the replica group descriptor. To filter dynamically registered replica groups, you should use the empty filter id.

filter - The filter implementation.

removeReplicaGroupFilter

boolean removeReplicaGroupFilter(java.lang.String id,
                                 ReplicaGroupFilter filter)

Remove a replica group filter.

Parameters:

id - The identifier of the filter.

filter - The filter implementation.

Returns:

True of the filter was removed, false otherwise.

addTypeFilter

void addTypeFilter(java.lang.String type,
                   TypeFilter filter)

Add a type filter.

Parameters:

type - The type to register this filter with.

filter - The filter implementation.

removeTypeFilter

boolean removeTypeFilter(java.lang.String type,
                         TypeFilter filter)

Remove a type filter.

Parameters:

type - The type to register this filter with.

filter - The filter implementation.

Returns:

True of the filter was removed, false otherwise.