Ice 3.8
Slice API Reference
Loading...
Searching...
No Matches
IceGrid::Admin Interface Reference

Provides administrative access to an IceGrid deployment. More...

defined in <IceGrid/Admin.ice>

interface Admin { ... }

Operations

void addApplication (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException
 Adds an application to IceGrid.
void addObject (Object *obj) throws ObjectExistsException, DeploymentException
 Adds an object to the object registry.
void addObjectWithType (Object *obj, string type) throws ObjectExistsException, DeploymentException
 Adds an object to the object registry and explicitly specifies its type.
idempotent void enableServer (string id, bool enabled) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Enables or disables a server.
idempotent AdapterInfoSeq getAdapterInfo (string id) throws AdapterNotExistException
 Gets adapter information for the replica group or adapter with the given ID.
idempotent Ice::StringSeq getAllAdapterIds ()
 Gets the IDs of all adapters registered with IceGrid.
idempotent Ice::StringSeq getAllApplicationNames ()
 Gets all the IceGrid applications currently registered.
idempotent Ice::StringSeq getAllNodeNames ()
 Gets the names of all IceGrid nodes currently registered.
idempotent ObjectInfoSeq getAllObjectInfos (string expr)
 Gets the object info of all the registered objects whose stringified identities match the given expression.
idempotent Ice::StringSeq getAllRegistryNames ()
 Gets the names of all the IceGrid registries currently registered.
idempotent Ice::StringSeq getAllServerIds ()
 Gets the IDs of all the servers registered with IceGrid.
idempotent ApplicationInfo getApplicationInfo (string name) throws ApplicationNotExistException
 Gets an application descriptor.
idempotent ApplicationDescriptor getDefaultApplicationDescriptor () throws DeploymentException
 Gets the default application descriptor.
idempotent Object * getNodeAdmin (string name) throws NodeNotExistException, NodeUnreachableException
 Gets a proxy to the admin object of an IceGrid node.
idempotent string getNodeHostname (string name) throws NodeNotExistException, NodeUnreachableException
 Get the hostname of a node.
idempotent NodeInfo getNodeInfo (string name) throws NodeNotExistException, NodeUnreachableException
 Gets the node information of a node.
idempotent LoadInfo getNodeLoad (string name) throws NodeNotExistException, NodeUnreachableException
 Gets the load averages of a node.
idempotent int getNodeProcessorSocketCount (string name) throws NodeNotExistException, NodeUnreachableException
 Gets the number of physical processor sockets in the computer where an IceGrid node is deployed.
idempotent ObjectInfo getObjectInfo (Ice::Identity id) throws ObjectNotRegisteredException
 Gets the object info for the object.
idempotent ObjectInfoSeq getObjectInfosByType (string type)
 Gets the object info of all the registered objects with a given type.
idempotent Object * getRegistryAdmin (string name) throws RegistryNotExistException
 Gets a proxy to the admin object of an IceGrid registry.
idempotent RegistryInfo getRegistryInfo (string name) throws RegistryNotExistException, RegistryUnreachableException
 Gets the registry information of an IceGrid registry.
idempotent Object * getServerAdmin (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Gets a proxy to the admin object of a server.
idempotent string getServerAdminCategory ()
 Gets the category for server admin objects.
idempotent ServerInfo getServerInfo (string id) throws ServerNotExistException
 Gets information about a server.
idempotent int getServerPid (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Gets the system process ID of a server.
idempotent ServerState getServerState (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Gets the state of a server.
void instantiateServer (string application, string node, ServerInstanceDescriptor desc) throws AccessDeniedException, ApplicationNotExistException, DeploymentException
 Instantiates a server template.
idempotent bool isServerEnabled (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Checks if the server is enabled or disabled.
idempotent bool pingNode (string name) throws NodeNotExistException
 Pings an IceGrid node to see if it is active.
idempotent bool pingRegistry (string name) throws RegistryNotExistException
 Pings an IceGrid registry to see if it is active.
void removeAdapter (string id) throws AdapterNotExistException, DeploymentException
 Removes the adapter with the given ID.
void removeApplication (string name) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Removes an application from IceGrid.
void removeObject (Ice::Identity id) throws ObjectNotRegisteredException, DeploymentException
 Removes an object from the object registry.
void sendSignal (string id, string signal) throws ServerNotExistException, NodeUnreachableException, DeploymentException, BadSignalException
 Sends a signal to a server.
void shutdown ()
 Shuts down the IceGrid registry.
void shutdownNode (string name) throws NodeNotExistException, NodeUnreachableException
 Shuts down an IceGrid node.
idempotent void shutdownRegistry (string name) throws RegistryNotExistException, RegistryUnreachableException
 Shuts down an IceGrid registry.
void startServer (string id) throws ServerNotExistException, ServerStartException, NodeUnreachableException, DeploymentException
 Starts a server and waits for its activation.
void stopServer (string id) throws ServerNotExistException, ServerStopException, NodeUnreachableException, DeploymentException
 Stops a server.
void syncApplication (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Synchronizes a deployed application.
void syncApplicationWithoutRestart (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Synchronizes a deployed application.
void updateApplication (ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Updates a deployed application.
void updateApplicationWithoutRestart (ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Updates a deployed application.
void updateObject (Object *obj) throws ObjectNotRegisteredException, DeploymentException
 Updates an object in the object registry.

Detailed Description

Provides administrative access to an IceGrid deployment.

Definition at line 212 of file Admin.ice.


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