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. More...

defined in <IceGrid/PluginFacade.ice>

local interface RegistryPluginFacade { ... }

Operations
void	addReplicaGroupFilter (string id, ReplicaGroupFilter filter)
	Add a replica group filter. More...

void	addTypeFilter (string type, TypeFilter filter)
	Add a type filter. More...

idempotent string	getAdapterApplication (string adapterId) throws AdapterNotExistException
	Get the name of the application to which the given adapter belongs. More...

idempotent AdapterInfoSeq	getAdapterInfo (string id) throws AdapterNotExistException
	Get the adapter information for the replica group or adapter with the given id. More...

idempotent string	getAdapterNode (string adapterId) throws AdapterNotExistException
	Get the name of the node to which the given adapter belongs. More...

idempotent string	getAdapterServer (string adapterId) throws AdapterNotExistException
	Get the ID of the server to which the given adapter belongs. More...

idempotent ApplicationInfo	getApplicationInfo (string name) throws ApplicationNotExistException
	Get an application descriptor. More...

idempotent NodeInfo	getNodeInfo (string name) throws NodeNotExistException, NodeUnreachableException
	Get the node information for the node with the given name. More...

idempotent LoadInfo	getNodeLoad (string name) throws NodeNotExistException, NodeUnreachableException
	Get the load averages of the node. More...

idempotent ObjectInfo	getObjectInfo (Ice::Identity id) throws ObjectNotRegisteredException
	Get the object info for the object with the given identity. More...

idempotent string	getPropertyForAdapter (string adapterId, string name) throws AdapterNotExistException
	Get the property value for the given property and adapter. More...

idempotent ServerInfo	getServerInfo (string id) throws ServerNotExistException
	Get the server information for the server with the given id. More...

bool	removeReplicaGroupFilter (string id, ReplicaGroupFilter filter)
	Remove a replica group filter. More...

bool	removeTypeFilter (string type, TypeFilter filter)
	Remove a type filter. More...

Detailed Description

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.

Operation Documentation

◆ addReplicaGroupFilter()

["cpp:noexcept","swift:noexcept"]

void addReplicaGroupFilter	(	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.

◆ addTypeFilter()

["cpp:noexcept","swift:noexcept"]

void addTypeFilter	(	string	type,
		TypeFilter	filter
	)

Add a type filter.

Parameters

type	The type to register this filter with.
filter	The filter implementation.

◆ getAdapterApplication()

["nonmutating","cpp:const"]

idempotent string getAdapterApplication ( 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.

Exceptions

AdapterNotExistException Raised if the adapter doesn't exist.

◆ getAdapterInfo()

["nonmutating","cpp:const"]

idempotent AdapterInfoSeq getAdapterInfo ( 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.

Exceptions

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

◆ getAdapterNode()

["nonmutating","cpp:const"]

idempotent string getAdapterNode ( 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.

Exceptions

AdapterNotExistException Raised if the adapter doesn't exist.

◆ getAdapterServer()

["nonmutating","cpp:const"]

idempotent string getAdapterServer ( 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.

Exceptions

AdapterNotExistException Raised if the adapter doesn't exist.

◆ getApplicationInfo()

["nonmutating","cpp:const"]

idempotent ApplicationInfo getApplicationInfo ( string name ) throws ApplicationNotExistException

Get an application descriptor.

Parameters

name	The application name.

Returns: The application descriptor.

Exceptions

ApplicationNotExistException Raised if the application doesn't exist.

◆ getNodeInfo()

["nonmutating","cpp:const"]

idempotent NodeInfo getNodeInfo ( 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.

Exceptions

NodeNotExistException	Raised if the node doesn't exist.
NodeUnreachableException	Raised if the node could not be reached.

◆ getNodeLoad()

["nonmutating","cpp:const"]

idempotent LoadInfo getNodeLoad ( string name ) throws NodeNotExistException, NodeUnreachableException

Get the load averages of the node.

Parameters

name	The node name.

Returns: The node load information.

Exceptions

NodeNotExistException	Raised if the node doesn't exist.
NodeUnreachableException	Raised if the node could not be reached.

◆ getObjectInfo()

["nonmutating","cpp:const"]

idempotent 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.

Exceptions

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

◆ getPropertyForAdapter()

["nonmutating","cpp:const"]

idempotent string getPropertyForAdapter	(	string	adapterId,
		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.

Exceptions

AdapterNotExistException Raised if the adapter doesn't exist.

◆ getServerInfo()

["nonmutating","cpp:const"]

idempotent ServerInfo getServerInfo ( string id ) throws ServerNotExistException

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

Parameters

id	The server id.

Exceptions

ServerNotExistException Raised if the server doesn't exist.

Returns: The server information.

◆ removeReplicaGroupFilter()

["cpp:noexcept","swift:noexcept"]

bool removeReplicaGroupFilter	(	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.

◆ removeTypeFilter()

["cpp:noexcept","swift:noexcept"]

bool removeTypeFilter	(	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.

The documentation for this interface was generated from the following file:

IceGrid/PluginFacade.ice

Operations

Detailed Description

Operation Documentation

◆ addReplicaGroupFilter()

◆ addTypeFilter()

◆ getAdapterApplication()

◆ getAdapterInfo()

◆ getAdapterNode()

◆ getAdapterServer()

◆ getApplicationInfo()

◆ getNodeInfo()

◆ getNodeLoad()

◆ getObjectInfo()

◆ getPropertyForAdapter()

◆ getServerInfo()

◆ removeReplicaGroupFilter()

◆ removeTypeFilter()