IceGrid

Interface _AdminOperationsNC

All Known Subinterfaces:

Admin

All Known Implementing Classes:

_AdminDisp, _AdminTie

public interface _AdminOperationsNC

The IceGrid administrative interface.

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

Method Summary

Modifier and Type	Method and Description
void	addApplication(ApplicationDescriptor descriptor) Add an application to IceGrid.
void	addObject(Ice.ObjectPrx obj) Add an object to the object registry.
void	addObjectWithType(Ice.ObjectPrx obj, java.lang.String type) Add an object to the object registry and explicitly specify its type.
void	enableServer(java.lang.String id, boolean enabled) Enable or disable a server.
AdapterInfo[]	getAdapterInfo(java.lang.String id) Get the adapter information for the replica group or adapter with the given id.
java.lang.String[]	getAllAdapterIds() Get all the adapter ids registered with IceGrid.
java.lang.String[]	getAllApplicationNames() Get all the IceGrid applications currently registered.
java.lang.String[]	getAllNodeNames() Get all the IceGrid nodes currently registered.
ObjectInfo[]	getAllObjectInfos(java.lang.String expr) Get the object info of all the registered objects whose stringified identities match the given expression.
java.lang.String[]	getAllRegistryNames() Get all the IceGrid registries currently registered.
java.lang.String[]	getAllServerIds() Get all the server ids registered with IceGrid.
ApplicationInfo	getApplicationInfo(java.lang.String name) Get an application descriptor.
ApplicationDescriptor	getDefaultApplicationDescriptor() Get the default application descriptor.
Ice.ObjectPrx	getNodeAdmin(java.lang.String name) Get a proxy to the IceGrid node's admin object.
java.lang.String	getNodeHostname(java.lang.String name) Get the hostname of this node.
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.
int	getNodeProcessorSocketCount(java.lang.String name) Get the number of physical processor sockets for the machine running the node with the given name.
ObjectInfo	getObjectInfo(Ice.Identity id) Get the object info for the object with the given identity.
ObjectInfo[]	getObjectInfosByType(java.lang.String type) Get the object info of all the registered objects with the given type.
Ice.ObjectPrx	getRegistryAdmin(java.lang.String name) Get a proxy to the IceGrid registry's admin object.
RegistryInfo	getRegistryInfo(java.lang.String name) Get the registry information for the registry with the given name.
Ice.ObjectPrx	getServerAdmin(java.lang.String id) Get a proxy to the server's admin object.
java.lang.String	getServerAdminCategory() Get the category for server admin objects.
ServerInfo	getServerInfo(java.lang.String id) Get the server information for the server with the given id.
int	getServerPid(java.lang.String id) Get a server's system process id.
ServerState	getServerState(java.lang.String id) Get a server's state.
java.util.Map<java.lang.String,java.lang.String>	getSliceChecksums() Returns the checksums for the IceGrid Slice definitions.
void	instantiateServer(java.lang.String application, java.lang.String node, ServerInstanceDescriptor desc) Instantiate a server template from an application on the given node.
boolean	isServerEnabled(java.lang.String id) Check if the server is enabled or disabled.
void	patchApplication_async(AMD_Admin_patchApplication __cb, java.lang.String name, boolean shutdown) Patch the given application data.
void	patchServer_async(AMD_Admin_patchServer __cb, java.lang.String id, boolean shutdown) Patch a server.
boolean	pingNode(java.lang.String name) Ping an IceGrid node to see if it is active.
boolean	pingRegistry(java.lang.String name) Ping an IceGrid registry to see if it is active.
void	removeAdapter(java.lang.String id) Remove the adapter with the given id.
void	removeApplication(java.lang.String name) Remove an application from IceGrid.
void	removeObject(Ice.Identity id) Remove an object from the object registry.
void	sendSignal(java.lang.String id, java.lang.String signal) Send signal to a server.
void	shutdown() Shut down the IceGrid registry.
void	shutdownNode(java.lang.String name) Shutdown an IceGrid node.
void	shutdownRegistry(java.lang.String name) Shutdown an IceGrid registry.
void	startServer_async(AMD_Admin_startServer __cb, java.lang.String id) Start a server and wait for its activation.
void	stopServer_async(AMD_Admin_stopServer __cb, java.lang.String id) Stop a server.
void	syncApplication(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor.
void	syncApplicationWithoutRestart(ApplicationDescriptor descriptor) Synchronize a deployed application with the given application descriptor.
void	updateApplication(ApplicationUpdateDescriptor descriptor) Update a deployed application with the given update application descriptor.
void	updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor) Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application.
void	updateObject(Ice.ObjectPrx obj) Update an object in the object registry.

Method Detail

addApplication

void addApplication(ApplicationDescriptor descriptor)
             throws AccessDeniedException,
                    DeploymentException

Add an application to IceGrid.

Parameters:

descriptor - The application descriptor.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

syncApplication

void syncApplication(ApplicationDescriptor descriptor)
              throws AccessDeniedException,
                     ApplicationNotExistException,
                     DeploymentException

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.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

ApplicationNotExistException - Raised if the application doesn't exist.

updateApplication

void updateApplication(ApplicationUpdateDescriptor descriptor)
                throws AccessDeniedException,
                       ApplicationNotExistException,
                       DeploymentException

Update a deployed application with the given update application descriptor.

Parameters:

descriptor - The update descriptor.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

ApplicationNotExistException - Raised if the application doesn't exist.

syncApplicationWithoutRestart

void syncApplicationWithoutRestart(ApplicationDescriptor descriptor)
                            throws AccessDeniedException,
                                   ApplicationNotExistException,
                                   DeploymentException

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.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

ApplicationNotExistException - Raised if the application doesn't exist.

updateApplicationWithoutRestart

void updateApplicationWithoutRestart(ApplicationUpdateDescriptor descriptor)
                              throws AccessDeniedException,
                                     ApplicationNotExistException,
                                     DeploymentException

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.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

ApplicationNotExistException - Raised if the application doesn't exist.

removeApplication

void removeApplication(java.lang.String name)
                throws AccessDeniedException,
                       ApplicationNotExistException,
                       DeploymentException

Remove an application from IceGrid.

Parameters:

name - The application name.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if application deployment failed.

ApplicationNotExistException - Raised if the application doesn't exist.

instantiateServer

void instantiateServer(java.lang.String application,
                       java.lang.String node,
                       ServerInstanceDescriptor desc)
                throws AccessDeniedException,
                       ApplicationNotExistException,
                       DeploymentException

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.

Throws:

AccessDeniedException - Raised if the session doesn't hold the exclusive lock or if another session is holding the lock.

DeploymentException - Raised if server instantiation failed.

ApplicationNotExistException - Raised if the application doesn't exist.

patchApplication_async

void patchApplication_async(AMD_Admin_patchApplication __cb,
                            java.lang.String name,
                            boolean shutdown)
                     throws ApplicationNotExistException,
                            PatchException

Patch the given application data.

Parameters:

__cb - The callback object for the operation.

name - The application name.

shutdown - If true, the servers depending on the data to patch will be shut down if necessary.

Throws:

ApplicationNotExistException - Raised if the application doesn't exist.

PatchException - Raised if the patch failed.

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.

getDefaultApplicationDescriptor

ApplicationDescriptor getDefaultApplicationDescriptor()
                                               throws DeploymentException

Get the default application descriptor.

Returns:

The default application descriptor.

Throws:

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

getAllApplicationNames

java.lang.String[] getAllApplicationNames()

Get all the IceGrid applications currently registered.

Returns:

The application names.

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.

getServerState

ServerState getServerState(java.lang.String id)
                    throws DeploymentException,
                           NodeUnreachableException,
                           ServerNotExistException

Get a server's state.

Parameters:

id - The server id.

Returns:

The server state.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

getServerPid

int getServerPid(java.lang.String id)
          throws DeploymentException,
                 NodeUnreachableException,
                 ServerNotExistException

Get a server's system process id. The process id is operating system dependent.

Parameters:

id - The server id.

Returns:

The server's process id.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

getServerAdminCategory

java.lang.String getServerAdminCategory()

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.

Returns:

The category for server admin objects.

getServerAdmin

Ice.ObjectPrx getServerAdmin(java.lang.String id)
                      throws DeploymentException,
                             NodeUnreachableException,
                             ServerNotExistException

Get a proxy to the server's admin object.

Parameters:

id - The server id.

Returns:

A proxy to the server's admin object

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

enableServer

void enableServer(java.lang.String id,
                  boolean enabled)
           throws DeploymentException,
                  NodeUnreachableException,
                  ServerNotExistException

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.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

isServerEnabled

boolean isServerEnabled(java.lang.String id)
                 throws DeploymentException,
                        NodeUnreachableException,
                        ServerNotExistException

Check if the server is enabled or disabled.

Parameters:

id - The server id.

Returns:

True if the server is enabled.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

startServer_async

void startServer_async(AMD_Admin_startServer __cb,
                       java.lang.String id)
                throws DeploymentException,
                       NodeUnreachableException,
                       ServerNotExistException,
                       ServerStartException

Start a server and wait for its activation.

Parameters:

__cb - The callback object for the operation.

id - The server id.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

ServerStartException - Raised if the server couldn't be started.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

stopServer_async

void stopServer_async(AMD_Admin_stopServer __cb,
                      java.lang.String id)
               throws DeploymentException,
                      NodeUnreachableException,
                      ServerNotExistException,
                      ServerStopException

Stop a server.

Parameters:

__cb - The callback object for the operation.

id - The server id.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

ServerStopException - Raised if the server couldn't be stopped.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

patchServer_async

void patchServer_async(AMD_Admin_patchServer __cb,
                       java.lang.String id,
                       boolean shutdown)
                throws DeploymentException,
                       NodeUnreachableException,
                       PatchException,
                       ServerNotExistException

Patch a server.

Parameters:

__cb - The callback object for the operation.

id - The server id.

shutdown - If true, servers depending on the data to patch will be shut down if necessary.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

PatchException - Raised if the patch failed.

sendSignal

void sendSignal(java.lang.String id,
                java.lang.String signal)
         throws BadSignalException,
                DeploymentException,
                NodeUnreachableException,
                ServerNotExistException

Send signal to a server.

Parameters:

id - The server id.

signal - The signal, for example SIGTERM or 15.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

DeploymentException - Raised if the server couldn't be deployed on the node.

BadSignalException - Raised if the signal is not recognized by the target server.

getAllServerIds

java.lang.String[] getAllServerIds()

Get all the server ids registered with IceGrid.

Returns:

The server ids.

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.

removeAdapter

void removeAdapter(java.lang.String id)
            throws AdapterNotExistException,
                   DeploymentException

Remove the adapter with the given id.

Parameters:

id - The adapter id.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

DeploymentException - Raised if application deployment failed.

getAllAdapterIds

java.lang.String[] getAllAdapterIds()

Get all the adapter ids registered with IceGrid.

Returns:

The adapter ids.

addObject

void addObject(Ice.ObjectPrx obj)
        throws DeploymentException,
               ObjectExistsException

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.

Throws:

ObjectExistsException - Raised if the object is already registered.

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.

updateObject

void updateObject(Ice.ObjectPrx obj)
           throws DeploymentException,
                  ObjectNotRegisteredException

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.

Throws:

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

DeploymentException - Raised if the object can't be updated. This might happen if the object was added with a deployment descriptor.

addObjectWithType

void addObjectWithType(Ice.ObjectPrx obj,
                       java.lang.String type)
                throws DeploymentException,
                       ObjectExistsException

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.

Throws:

ObjectExistsException - Raised if the object is already registered.

DeploymentException - Raised if application deployment failed.

removeObject

void removeObject(Ice.Identity id)
           throws DeploymentException,
                  ObjectNotRegisteredException

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.

Throws:

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

DeploymentException - Raised if the object can't be removed. This might happen if the object was added with a deployment descriptor.

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.

getObjectInfosByType

ObjectInfo[] getObjectInfosByType(java.lang.String type)

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

Parameters:

type - The type of the object.

Returns:

The object infos.

getAllObjectInfos

ObjectInfo[] getAllObjectInfos(java.lang.String expr)

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.

Returns:

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

pingNode

boolean pingNode(java.lang.String name)
          throws NodeNotExistException

Ping an IceGrid node to see if it is active.

Parameters:

name - The node name.

Returns:

true if the node ping succeeded, false otherwise.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

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.

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.

getNodeAdmin

Ice.ObjectPrx getNodeAdmin(java.lang.String name)
                    throws NodeNotExistException,
                           NodeUnreachableException

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

Parameters:

name - The IceGrid node name

Returns:

A proxy to the IceGrid node's admin object

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

getNodeProcessorSocketCount

int getNodeProcessorSocketCount(java.lang.String name)
                         throws NodeNotExistException,
                                NodeUnreachableException

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.

Returns:

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

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

shutdownNode

void shutdownNode(java.lang.String name)
           throws NodeNotExistException,
                  NodeUnreachableException

Shutdown an IceGrid node.

Parameters:

name - The node name.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

getNodeHostname

java.lang.String getNodeHostname(java.lang.String name)
                          throws NodeNotExistException,
                                 NodeUnreachableException

Get the hostname of this node.

Parameters:

name - The node name.

Returns:

The node hostname.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

getAllNodeNames

java.lang.String[] getAllNodeNames()

Get all the IceGrid nodes currently registered.

Returns:

The node names.

pingRegistry

boolean pingRegistry(java.lang.String name)
              throws RegistryNotExistException

Ping an IceGrid registry to see if it is active.

Parameters:

name - The registry name.

Returns:

true if the registry ping succeeded, false otherwise.

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

getRegistryInfo

RegistryInfo getRegistryInfo(java.lang.String name)
                      throws RegistryNotExistException,
                             RegistryUnreachableException

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

Parameters:

name - The registry name.

Returns:

The registry information.

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

RegistryUnreachableException - Raised if the registry could not be reached.

getRegistryAdmin

Ice.ObjectPrx getRegistryAdmin(java.lang.String name)
                        throws RegistryNotExistException

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

Parameters:

name - The registry name

Returns:

A proxy to the IceGrid registry's admin object

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

shutdownRegistry

void shutdownRegistry(java.lang.String name)
               throws RegistryNotExistException,
                      RegistryUnreachableException

Shutdown an IceGrid registry.

Parameters:

name - The registry name.

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

RegistryUnreachableException - Raised if the registry could not be reached.

getAllRegistryNames

java.lang.String[] getAllRegistryNames()

Get all the IceGrid registries currently registered.

Returns:

The registry names.

shutdown

void shutdown()

Shut down the IceGrid registry.

getSliceChecksums

java.util.Map<java.lang.String,java.lang.String> getSliceChecksums()

Returns the checksums for the IceGrid Slice definitions.

Returns:

A dictionary mapping Slice type ids to their checksums.