The IceGrid administrative interface. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Admin:

Collaboration diagram for IceGrid::Admin:

Public Types
using	ProxyType = AdminPrx

Public Member Functions
virtual void	addApplication (ApplicationDescriptor descriptor, const ::Ice::Current &current)=0
	Add an application to IceGrid. More...

virtual void	addObject (::std::shared_ptr<::Ice::ObjectPrx > obj, const ::Ice::Current &current)=0
	Add an object to the object registry. More...

virtual void	addObjectWithType (::std::shared_ptr<::Ice::ObjectPrx > obj, ::std::string type, const ::Ice::Current &current)=0
	Add an object to the object registry and explicitly specify its type. More...

virtual void	enableServer (::std::string id, bool enabled, const ::Ice::Current &current)=0
	Enable or disable a server. More...

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

virtual ::Ice::StringSeq	getAllAdapterIds (const ::Ice::Current &current) const =0
	Get all the adapter ids registered with IceGrid. More...

virtual ::Ice::StringSeq	getAllApplicationNames (const ::Ice::Current &current) const =0
	Get all the IceGrid applications currently registered. More...

virtual ::Ice::StringSeq	getAllNodeNames (const ::Ice::Current &current) const =0
	Get all the IceGrid nodes currently registered. More...

virtual ObjectInfoSeq	getAllObjectInfos (::std::string expr, const ::Ice::Current &current) const =0
	Get the object info of all the registered objects whose stringified identities match the given expression. More...

virtual ::Ice::StringSeq	getAllRegistryNames (const ::Ice::Current &current) const =0
	Get all the IceGrid registries currently registered. More...

virtual ::Ice::StringSeq	getAllServerIds (const ::Ice::Current &current) const =0
	Get all the server ids registered with IceGrid. More...

virtual ApplicationInfo	getApplicationInfo (::std::string name, const ::Ice::Current &current) const =0
	Get an application descriptor. More...

virtual ApplicationDescriptor	getDefaultApplicationDescriptor (const ::Ice::Current &current) const =0
	Get the default application descriptor. More...

virtual ::std::shared_ptr<::Ice::ObjectPrx >	getNodeAdmin (::std::string name, const ::Ice::Current &current) const =0
	Get a proxy to the IceGrid node's admin object. More...

virtual ::std::string	getNodeHostname (::std::string name, const ::Ice::Current &current) const =0
	Get the hostname of this node. More...

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

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

virtual int	getNodeProcessorSocketCount (::std::string name, const ::Ice::Current &current) const =0
	Get the number of physical processor sockets for the machine running the node with the given name. More...

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

virtual ObjectInfoSeq	getObjectInfosByType (::std::string type, const ::Ice::Current &current) const =0
	Get the object info of all the registered objects with the given type. More...

virtual ::std::shared_ptr<::Ice::ObjectPrx >	getRegistryAdmin (::std::string name, const ::Ice::Current &current) const =0
	Get a proxy to the IceGrid registry's admin object. More...

virtual RegistryInfo	getRegistryInfo (::std::string name, const ::Ice::Current &current) const =0
	Get the registry information for the registry with the given name. More...

virtual ::std::shared_ptr<::Ice::ObjectPrx >	getServerAdmin (::std::string id, const ::Ice::Current &current) const =0
	Get a proxy to the server's admin object. More...

virtual ::std::string	getServerAdminCategory (const ::Ice::Current &current) const =0
	Get the category for server admin objects. More...

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

virtual int	getServerPid (::std::string id, const ::Ice::Current &current) const =0
	Get a server's system process id. More...

virtual ServerState	getServerState (::std::string id, const ::Ice::Current &current) const =0
	Get a server's state. More...

virtual ::Ice::SliceChecksumDict	getSliceChecksums (const ::Ice::Current &current) const =0
	Returns the checksums for the IceGrid Slice definitions. More...

virtual ::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object. More...

virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...

virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID. More...

virtual void	instantiateServer (::std::string application, ::std::string node, ServerInstanceDescriptor desc, const ::Ice::Current &current)=0
	Instantiate a server template from an application on the given node. More...

virtual bool	isServerEnabled (::std::string id, const ::Ice::Current &current) const =0
	Check if the server is enabled or disabled. More...

virtual void	patchApplicationAsync (::std::string name, bool shutdown, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Patch the given application data. More...

virtual void	patchServerAsync (::std::string id, bool shutdown, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Patch a server. More...

virtual bool	pingNode (::std::string name, const ::Ice::Current &current) const =0
	Ping an IceGrid node to see if it is active. More...

virtual bool	pingRegistry (::std::string name, const ::Ice::Current &current) const =0
	Ping an IceGrid registry to see if it is active. More...

virtual void	removeAdapter (::std::string id, const ::Ice::Current &current)=0
	Remove the adapter with the given id. More...

virtual void	removeApplication (::std::string name, const ::Ice::Current &current)=0
	Remove an application from IceGrid. More...

virtual void	removeObject (::Ice::Identity id, const ::Ice::Current &current)=0
	Remove an object from the object registry. More...

virtual void	sendSignal (::std::string id, ::std::string signal, const ::Ice::Current &current)=0
	Send signal to a server. More...

virtual void	shutdown (const ::Ice::Current &current)=0
	Shut down the IceGrid registry. More...

virtual void	shutdownNode (::std::string name, const ::Ice::Current &current)=0
	Shutdown an IceGrid node. More...

virtual void	shutdownRegistry (::std::string name, const ::Ice::Current &current)=0
	Shutdown an IceGrid registry. More...

virtual void	startServerAsync (::std::string id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Start a server and wait for its activation. More...

virtual void	stopServerAsync (::std::string id, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const ::Ice::Current &current)=0
	Stop a server. More...

virtual void	syncApplication (ApplicationDescriptor descriptor, const ::Ice::Current &current)=0
	Synchronize a deployed application with the given application descriptor. More...

virtual void	syncApplicationWithoutRestart (ApplicationDescriptor descriptor, const ::Ice::Current &current)=0
	Synchronize a deployed application with the given application descriptor. More...

virtual void	updateApplication (ApplicationUpdateDescriptor descriptor, const ::Ice::Current &current)=0
	Update a deployed application with the given update application descriptor. More...

virtual void	updateApplicationWithoutRestart (ApplicationUpdateDescriptor descriptor, const ::Ice::Current &current)=0
	Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. More...

virtual void	updateObject (::std::shared_ptr<::Ice::ObjectPrx > obj, const ::Ice::Current &current)=0
	Update an object in the object registry. More...

Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant. More...

virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...

virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object. More...

virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...

virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...

virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...

Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type. More...

Detailed Description

The IceGrid administrative interface.

Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information.

Member Typedef Documentation

◆ ProxyType

using IceGrid::Admin::ProxyType = AdminPrx

Member Function Documentation

◆ addApplication()

virtual void IceGrid::Admin::addApplication	(	ApplicationDescriptor	descriptor,
		const ::Ice::Current &	current
	)

pure virtual

Add an application to IceGrid.

Parameters

descriptor	The application descriptor.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ addObject()

virtual void IceGrid::Admin::addObject	(	::std::shared_ptr<::Ice::ObjectPrx >	obj,
		const ::Ice::Current &	current
	)

pure virtual

Add an object to the object registry.

IceGrid will get the object type by calling ice_id on the given proxy. The object must be reachable.

Parameters

obj	The object to be added to the registry.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.
IceGrid::ObjectExistsException	Raised if the object is already registered.

◆ addObjectWithType()

virtual void IceGrid::Admin::addObjectWithType	(	::std::shared_ptr<::Ice::ObjectPrx >	obj,
		::std::string	type,
		const ::Ice::Current &	current
	)

pure virtual

Add an object to the object registry and explicitly specify its type.

Parameters

obj	The object to be added to the registry.
type	The object type.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if application deployment failed.
IceGrid::ObjectExistsException	Raised if the object is already registered.

◆ enableServer()

virtual void IceGrid::Admin::enableServer	(	::std::string	id,
		bool	enabled,
		const ::Ice::Current &	current
	)

pure virtual

Enable or disable a server.

A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.

Parameters

id	The server id.
enabled	True to enable the server, false to disable it.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ getAdapterInfo()

virtual AdapterInfoSeq IceGrid::Admin::getAdapterInfo	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

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

Parameters

id	The adapter id.
current	The Current object for the invocation.

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.

◆ getAllAdapterIds()

virtual ::Ice::StringSeq IceGrid::Admin::getAllAdapterIds ( const ::Ice::Current & current ) const

pure virtual

Get all the adapter ids registered with IceGrid.

Parameters

current The Current object for the invocation.

Returns: The adapter ids.

◆ getAllApplicationNames()

virtual ::Ice::StringSeq IceGrid::Admin::getAllApplicationNames ( const ::Ice::Current & current ) const

pure virtual

Get all the IceGrid applications currently registered.

Parameters

current The Current object for the invocation.

Returns: The application names.

◆ getAllNodeNames()

virtual ::Ice::StringSeq IceGrid::Admin::getAllNodeNames ( const ::Ice::Current & current ) const

pure virtual

Get all the IceGrid nodes currently registered.

Parameters

current The Current object for the invocation.

Returns: The node names.

◆ getAllObjectInfos()

virtual ObjectInfoSeq IceGrid::Admin::getAllObjectInfos	(	::std::string	expr,
		const ::Ice::Current &	current
	)		const

pure virtual

Get the object info of all the registered objects whose stringified identities match the given expression.

Parameters

expr	The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (`*`) character.
current	The Current object for the invocation.

Returns: All the object infos with a stringified identity matching the given expression.

◆ getAllRegistryNames()

virtual ::Ice::StringSeq IceGrid::Admin::getAllRegistryNames ( const ::Ice::Current & current ) const

pure virtual

Get all the IceGrid registries currently registered.

Parameters

current The Current object for the invocation.

Returns: The registry names.

◆ getAllServerIds()

virtual ::Ice::StringSeq IceGrid::Admin::getAllServerIds ( const ::Ice::Current & current ) const

pure virtual

Get all the server ids registered with IceGrid.

Parameters

current The Current object for the invocation.

Returns: The server ids.

◆ getApplicationInfo()

virtual ApplicationInfo IceGrid::Admin::getApplicationInfo	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get an application descriptor.

Parameters

name	The application name.
current	The Current object for the invocation.

Returns: The application descriptor.

Exceptions

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

◆ getDefaultApplicationDescriptor()

virtual ApplicationDescriptor IceGrid::Admin::getDefaultApplicationDescriptor ( const ::Ice::Current & current ) const

pure virtual

Get the default application descriptor.

Parameters

current The Current object for the invocation.

Returns: The default application descriptor.

Exceptions

IceGrid::DeploymentException Raised if the default application descriptor can't be accessed or is invalid.

◆ getNodeAdmin()

virtual ::std::shared_ptr<::Ice::ObjectPrx> IceGrid::Admin::getNodeAdmin	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get a proxy to the IceGrid node's admin object.

Parameters

name	The IceGrid node name
current	The Current object for the invocation.

Returns: A proxy to the IceGrid node's admin object

Exceptions

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

◆ getNodeHostname()

virtual ::std::string IceGrid::Admin::getNodeHostname	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get the hostname of this node.

Parameters

name	The node name.
current	The Current object for the invocation.

Returns: The node hostname.

Exceptions

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

◆ getNodeInfo()

virtual NodeInfo IceGrid::Admin::getNodeInfo	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

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

Parameters

name	The node name.
current	The Current object for the invocation.

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 LoadInfo IceGrid::Admin::getNodeLoad	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get the load averages of the node.

Parameters

name	The node name.
current	The Current object for the invocation.

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.

◆ getNodeProcessorSocketCount()

virtual int IceGrid::Admin::getNodeProcessorSocketCount	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get the number of physical processor sockets for the machine running the node with the given name.

Note that this method will return 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.

Parameters

name	The node name.
current	The Current object for the invocation.

Returns: The number of processor sockets or 1 if the number of sockets can't determined.

Exceptions

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

◆ getObjectInfo()

virtual ObjectInfo IceGrid::Admin::getObjectInfo	(	::Ice::Identity	id,
		const ::Ice::Current &	current
	)		const

pure virtual

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

Parameters

id	The identity of the object.
current	The Current object for the invocation.

Returns: The object info.

Exceptions

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

◆ getObjectInfosByType()

virtual ObjectInfoSeq IceGrid::Admin::getObjectInfosByType	(	::std::string	type,
		const ::Ice::Current &	current
	)		const

pure virtual

Get the object info of all the registered objects with the given type.

Parameters

type	The type of the object.
current	The Current object for the invocation.

Returns: The object infos.

◆ getRegistryAdmin()

virtual ::std::shared_ptr<::Ice::ObjectPrx> IceGrid::Admin::getRegistryAdmin	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Get a proxy to the IceGrid registry's admin object.

Parameters

name	The registry name
current	The Current object for the invocation.

Returns: A proxy to the IceGrid registry's admin object

Exceptions

IceGrid::RegistryNotExistException Raised if the registry doesn't exist.

◆ getRegistryInfo()

virtual RegistryInfo IceGrid::Admin::getRegistryInfo	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

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

Parameters

name	The registry name.
current	The Current object for the invocation.

Returns: The registry information.

Exceptions

IceGrid::RegistryNotExistException	Raised if the registry doesn't exist.
IceGrid::RegistryUnreachableException	Raised if the registry could not be reached.

◆ getServerAdmin()

virtual ::std::shared_ptr<::Ice::ObjectPrx> IceGrid::Admin::getServerAdmin	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

Get a proxy to the server's admin object.

Parameters

id	The server id.
current	The Current object for the invocation.

Returns: A proxy to the server's admin object

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ getServerAdminCategory()

virtual ::std::string IceGrid::Admin::getServerAdminCategory ( const ::Ice::Current & current ) const

pure virtual

Get the category for server admin objects.

You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.

Parameters

current The Current object for the invocation.

Returns: The category for server admin objects.

◆ getServerInfo()

virtual ServerInfo IceGrid::Admin::getServerInfo	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

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

Parameters

id	The server id.
current	The Current object for the invocation.

Returns: The server information.

Exceptions

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

◆ getServerPid()

virtual int IceGrid::Admin::getServerPid	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

Get a server's system process id.

The process id is operating system dependent.

Parameters

id	The server id.
current	The Current object for the invocation.

Returns: The server's process id.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ getServerState()

virtual ServerState IceGrid::Admin::getServerState	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

Get a server's state.

Parameters

id	The server id.
current	The Current object for the invocation.

Returns: The server state.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ getSliceChecksums()

virtual ::Ice::SliceChecksumDict IceGrid::Admin::getSliceChecksums ( const ::Ice::Current & current ) const

pure virtual

Returns the checksums for the IceGrid Slice definitions.

Parameters

current The Current object for the invocation.

Returns: A dictionary mapping Slice type ids to their checksums.

◆ ice_id()

virtual ::std::string IceGrid::Admin::ice_id ( const ::Ice::Current & current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string> IceGrid::Admin::ice_ids ( const ::Ice::Current & current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::Admin::ice_isA	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

◆ ice_staticId()

static const ::std::string& IceGrid::Admin::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ instantiateServer()

virtual void IceGrid::Admin::instantiateServer	(	::std::string	application,
		::std::string	node,
		ServerInstanceDescriptor	desc,
		const ::Ice::Current &	current
	)

pure virtual

Instantiate a server template from an application on the given node.

Parameters

application	The application name.
node	The name of the node where the server will be deployed.
desc	The descriptor of the server instance to deploy.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if server instantiation failed.

◆ isServerEnabled()

virtual bool IceGrid::Admin::isServerEnabled	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

pure virtual

Check if the server is enabled or disabled.

Parameters

id	The server id.
current	The Current object for the invocation.

Returns: True if the server is enabled.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ patchApplicationAsync()

virtual void IceGrid::Admin::patchApplicationAsync	(	::std::string	name,
		bool	shutdown,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current
	)

pure virtual

Patch the given application data.

Parameters

name	The application name.
shutdown	If true, the servers depending on the data to patch will be shut down if necessary.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

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

◆ patchServerAsync()

virtual void IceGrid::Admin::patchServerAsync	(	::std::string	id,
		bool	shutdown,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current
	)

pure virtual

Patch a server.

Parameters

id	The server id.
shutdown	If true, servers depending on the data to patch will be shut down if necessary.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::PatchException	Raised if the patch failed.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ pingNode()

virtual bool IceGrid::Admin::pingNode	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Ping an IceGrid node to see if it is active.

Parameters

name	The node name.
current	The Current object for the invocation.

Returns: true if the node ping succeeded, false otherwise.

Exceptions

IceGrid::NodeNotExistException Raised if the node doesn't exist.

◆ pingRegistry()

virtual bool IceGrid::Admin::pingRegistry	(	::std::string	name,
		const ::Ice::Current &	current
	)		const

pure virtual

Ping an IceGrid registry to see if it is active.

Parameters

name	The registry name.
current	The Current object for the invocation.

Returns: true if the registry ping succeeded, false otherwise.

Exceptions

IceGrid::RegistryNotExistException Raised if the registry doesn't exist.

◆ removeAdapter()

virtual void IceGrid::Admin::removeAdapter	(	::std::string	id,
		const ::Ice::Current &	current
	)

pure virtual

Remove the adapter with the given id.

Parameters

id	The adapter id.
current	The Current object for the invocation.

Exceptions

IceGrid::AdapterNotExistException	Raised if the adapter doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ removeApplication()

virtual void IceGrid::Admin::removeApplication	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

Remove an application from IceGrid.

Parameters

name	The application name.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ removeObject()

virtual void IceGrid::Admin::removeObject	(	::Ice::Identity	id,
		const ::Ice::Current &	current
	)

pure virtual

Remove an object from the object registry.

Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.

Parameters

id	The identity of the object to be removed from the registry.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the object can't be removed. This might happen if the object was added with a deployment descriptor.
IceGrid::ObjectNotRegisteredException	Raised if the object isn't registered with the registry.

◆ sendSignal()

virtual void IceGrid::Admin::sendSignal	(	::std::string	id,
		::std::string	signal,
		const ::Ice::Current &	current
	)

pure virtual

Send signal to a server.

Parameters

id	The server id.
signal	The signal, for example SIGTERM or 15.
current	The Current object for the invocation.

Exceptions

IceGrid::BadSignalException	Raised if the signal is not recognized by the target server.
IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.

◆ shutdown()

virtual void IceGrid::Admin::shutdown ( const ::Ice::Current & current )

pure virtual

Shut down the IceGrid registry.

Parameters

current The Current object for the invocation.

◆ shutdownNode()

virtual void IceGrid::Admin::shutdownNode	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

Shutdown an IceGrid node.

Parameters

name	The node name.
current	The Current object for the invocation.

Exceptions

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

◆ shutdownRegistry()

virtual void IceGrid::Admin::shutdownRegistry	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

Shutdown an IceGrid registry.

Parameters

name	The registry name.
current	The Current object for the invocation.

Exceptions

IceGrid::RegistryNotExistException	Raised if the registry doesn't exist.
IceGrid::RegistryUnreachableException	Raised if the registry could not be reached.

◆ startServerAsync()

virtual void IceGrid::Admin::startServerAsync	(	::std::string	id,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current
	)

pure virtual

Start a server and wait for its activation.

Parameters

id	The server id.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.
IceGrid::ServerStartException	Raised if the server couldn't be started.

◆ stopServerAsync()

virtual void IceGrid::Admin::stopServerAsync	(	::std::string	id,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const ::Ice::Current &	current
	)

pure virtual

Stop a server.

Parameters

id	The server id.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the server couldn't be deployed on the node.
IceGrid::NodeUnreachableException	Raised if the node could not be reached.
IceGrid::ServerNotExistException	Raised if the server doesn't exist.
IceGrid::ServerStopException	Raised if the server couldn't be stopped.

◆ syncApplication()

virtual void IceGrid::Admin::syncApplication	(	ApplicationDescriptor	descriptor,
		const ::Ice::Current &	current
	)

pure virtual

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor.

Parameters

descriptor	The application descriptor.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ syncApplicationWithoutRestart()

virtual void IceGrid::Admin::syncApplicationWithoutRestart	(	ApplicationDescriptor	descriptor,
		const ::Ice::Current &	current
	)

pure virtual

Synchronize a deployed application with the given application descriptor.

This operation will replace the current descriptor with this new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters

descriptor	The application descriptor.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ updateApplication()

virtual void IceGrid::Admin::updateApplication	(	ApplicationUpdateDescriptor	descriptor,
		const ::Ice::Current &	current
	)

pure virtual

Update a deployed application with the given update application descriptor.

Parameters

descriptor	The update descriptor.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ updateApplicationWithoutRestart()

virtual void IceGrid::Admin::updateApplicationWithoutRestart	(	ApplicationUpdateDescriptor	descriptor,
		const ::Ice::Current &	current
	)

pure virtual

Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.

If some servers need to be restarted, the synchronization is rejected with a DeploymentException.

Parameters

descriptor	The update descriptor.
current	The Current object for the invocation.

Exceptions

IceGrid::AccessDeniedException	Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.
IceGrid::ApplicationNotExistException	Raised if the application doesn't exist.
IceGrid::DeploymentException	Raised if application deployment failed.

◆ updateObject()

virtual void IceGrid::Admin::updateObject	(	::std::shared_ptr<::Ice::ObjectPrx >	obj,
		const ::Ice::Current &	current
	)

pure virtual

Update an object in the object registry.

Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.

Parameters

obj	The object to be updated to the registry.
current	The Current object for the invocation.

Exceptions

IceGrid::DeploymentException	Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.
IceGrid::ObjectNotRegisteredException	Raised if the object isn't registered with the registry.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ addApplication()

◆ addObject()

◆ addObjectWithType()

◆ enableServer()

◆ getAdapterInfo()

◆ getAllAdapterIds()

◆ getAllApplicationNames()

◆ getAllNodeNames()

◆ getAllObjectInfos()

◆ getAllRegistryNames()

◆ getAllServerIds()

◆ getApplicationInfo()

◆ getDefaultApplicationDescriptor()

◆ getNodeAdmin()

◆ getNodeHostname()

◆ getNodeInfo()

◆ getNodeLoad()

◆ getNodeProcessorSocketCount()

◆ getObjectInfo()

◆ getObjectInfosByType()

◆ getRegistryAdmin()

◆ getRegistryInfo()

◆ getServerAdmin()

◆ getServerAdminCategory()

◆ getServerInfo()

◆ getServerPid()

◆ getServerState()

◆ getSliceChecksums()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ instantiateServer()

◆ isServerEnabled()

◆ patchApplicationAsync()

◆ patchServerAsync()

◆ pingNode()

◆ pingRegistry()

◆ removeAdapter()

◆ removeApplication()

◆ removeObject()

◆ sendSignal()

◆ shutdown()

◆ shutdownNode()

◆ shutdownRegistry()

◆ startServerAsync()

◆ stopServerAsync()

◆ syncApplication()

◆ syncApplicationWithoutRestart()

◆ updateApplication()

◆ updateApplicationWithoutRestart()

◆ updateObject()