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

#include <IceGrid/IceGrid.h>

Public Member Functions
virtual void	addReplicaGroupFilter (const ::std::string &id, const ::std::shared_ptr< ReplicaGroupFilter > &filter) noexcept=0
	Add a replica group filter. More...

virtual void	addTypeFilter (const ::std::string &type, const ::std::shared_ptr< TypeFilter > &filter) noexcept=0
	Add a type filter. More...

virtual ::std::string	getAdapterApplication (const ::std::string &adapterId) const =0
	Get the name of the application to which the given adapter belongs. More...

virtual ::IceGrid::AdapterInfoSeq	getAdapterInfo (const ::std::string &id) const =0
	Get the adapter information for the replica group or adapter with the given id. More...

virtual ::std::string	getAdapterNode (const ::std::string &adapterId) const =0
	Get the name of the node to which the given adapter belongs. More...

virtual ::std::string	getAdapterServer (const ::std::string &adapterId) const =0
	Get the ID of the server to which the given adapter belongs. More...

virtual ::IceGrid::ApplicationInfo	getApplicationInfo (const ::std::string &name) const =0
	Get an application descriptor. More...

virtual ::IceGrid::NodeInfo	getNodeInfo (const ::std::string &name) const =0
	Get the node information for the node with the given name. More...

virtual ::IceGrid::LoadInfo	getNodeLoad (const ::std::string &name) const =0
	Get the load averages of the node. More...

virtual ::IceGrid::ObjectInfo	getObjectInfo (const ::Ice::Identity &id) const =0
	Get the object info for the object with the given identity. More...

virtual ::std::string	getPropertyForAdapter (const ::std::string &adapterId, const ::std::string &name) const =0
	Get the property value for the given property and adapter. More...

virtual ::IceGrid::ServerInfo	getServerInfo (const ::std::string &id) const =0
	Get the server information for the server with the given id. More...

virtual bool	removeReplicaGroupFilter (const ::std::string &id, const ::std::shared_ptr< ReplicaGroupFilter > &filter) noexcept=0
	Remove a replica group filter. More...

virtual bool	removeTypeFilter (const ::std::string &type, const ::std::shared_ptr< TypeFilter > &filter) noexcept=0
	Remove a type filter. More...

virtual	~RegistryPluginFacade ()

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.

Constructor & Destructor Documentation

◆ ~RegistryPluginFacade()

virtual IceGrid::RegistryPluginFacade::~RegistryPluginFacade ( )

virtual

Member Function Documentation

◆ addReplicaGroupFilter()

virtual void IceGrid::RegistryPluginFacade::addReplicaGroupFilter	(	const ::std::string &	id,
		const ::std::shared_ptr< ReplicaGroupFilter > &	filter
	)

pure virtualnoexcept

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()

virtual void IceGrid::RegistryPluginFacade::addTypeFilter	(	const ::std::string &	type,
		const ::std::shared_ptr< TypeFilter > &	filter
	)

pure virtualnoexcept

Add a type filter.

Parameters

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

◆ getAdapterApplication()

virtual ::std::string IceGrid::RegistryPluginFacade::getAdapterApplication ( const ::std::string & adapterId ) const

pure virtual

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

IceGrid::AdapterNotExistException Raised if the adapter doesn't exist.

◆ getAdapterInfo()

virtual ::IceGrid::AdapterInfoSeq IceGrid::RegistryPluginFacade::getAdapterInfo ( const ::std::string & id ) const

pure virtual

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

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

◆ getAdapterNode()

virtual ::std::string IceGrid::RegistryPluginFacade::getAdapterNode ( const ::std::string & adapterId ) const

pure virtual

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

IceGrid::AdapterNotExistException Raised if the adapter doesn't exist.

◆ getAdapterServer()

virtual ::std::string IceGrid::RegistryPluginFacade::getAdapterServer ( const ::std::string & adapterId ) const

pure virtual

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

IceGrid::AdapterNotExistException Raised if the adapter doesn't exist.

◆ getApplicationInfo()

virtual ::IceGrid::ApplicationInfo IceGrid::RegistryPluginFacade::getApplicationInfo ( const ::std::string & name ) const

pure virtual

Get an application descriptor.

Parameters

name	The application name.

Returns: The application descriptor.

Exceptions

IceGrid::ApplicationNotExistException Raised if the application doesn't exist.

◆ getNodeInfo()

virtual ::IceGrid::NodeInfo IceGrid::RegistryPluginFacade::getNodeInfo ( const ::std::string & name ) const

pure virtual

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

Parameters

name	The node name.

Returns: The node information.

Exceptions

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

◆ getNodeLoad()

virtual ::IceGrid::LoadInfo IceGrid::RegistryPluginFacade::getNodeLoad ( const ::std::string & name ) const

pure virtual

Get the load averages of the node.

Parameters

name	The node name.

Returns: The node load information.

Exceptions

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

◆ getObjectInfo()

virtual ::IceGrid::ObjectInfo IceGrid::RegistryPluginFacade::getObjectInfo ( const ::Ice::Identity & id ) const

pure virtual

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

Parameters

id	The identity of the object.

Returns: The object info.

Exceptions

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

◆ getPropertyForAdapter()

virtual ::std::string IceGrid::RegistryPluginFacade::getPropertyForAdapter	(	const ::std::string &	adapterId,
		const ::std::string &	name
	)		const

pure virtual

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

IceGrid::AdapterNotExistException Raised if the adapter doesn't exist.

◆ getServerInfo()

virtual ::IceGrid::ServerInfo IceGrid::RegistryPluginFacade::getServerInfo ( const ::std::string & id ) const

pure virtual

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

Parameters

id	The server id.

Returns: The server information.

Exceptions

IceGrid::ServerNotExistException Raised if the server doesn't exist.

◆ removeReplicaGroupFilter()

virtual bool IceGrid::RegistryPluginFacade::removeReplicaGroupFilter	(	const ::std::string &	id,
		const ::std::shared_ptr< ReplicaGroupFilter > &	filter
	)

pure virtualnoexcept

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()

virtual bool IceGrid::RegistryPluginFacade::removeTypeFilter	(	const ::std::string &	type,
		const ::std::shared_ptr< TypeFilter > &	filter
	)

pure virtualnoexcept

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 class was generated from the following file:

generated/cpp11/x64/Release/IceGrid/PluginFacade.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~RegistryPluginFacade()

Member Function Documentation

◆ addReplicaGroupFilter()

◆ addTypeFilter()

◆ getAdapterApplication()

◆ getAdapterInfo()

◆ getAdapterNode()

◆ getAdapterServer()

◆ getApplicationInfo()

◆ getNodeInfo()

◆ getNodeLoad()

◆ getObjectInfo()

◆ getPropertyForAdapter()

◆ getServerInfo()

◆ removeReplicaGroupFilter()

◆ removeTypeFilter()