Ice 3.7 Slice API Reference
Operations | List of all members
IceGrid::Admin Interface Reference

The IceGrid administrative interface. More...

defined in <IceGrid/Admin.ice>

interface Admin { ... }

Operations

void addApplication (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException
 Add an application to IceGrid. More...
 
void addObject (Object *obj) throws ObjectExistsException, DeploymentException
 Add an object to the object registry. More...
 
void addObjectWithType (Object *obj, string type) throws ObjectExistsException, DeploymentException
 Add an object to the object registry and explicitly specify its type. More...
 
idempotent void enableServer (string id, bool enabled) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Enable or disable a server. More...
 
idempotent AdapterInfoSeq getAdapterInfo (string id) throws AdapterNotExistException
 Get the adapter information for the replica group or adapter with the given id. More...
 
idempotent Ice::StringSeq getAllAdapterIds ()
 Get all the adapter ids registered with IceGrid. More...
 
idempotent Ice::StringSeq getAllApplicationNames ()
 Get all the IceGrid applications currently registered. More...
 
idempotent Ice::StringSeq getAllNodeNames ()
 Get all the IceGrid nodes currently registered. More...
 
idempotent ObjectInfoSeq getAllObjectInfos (string expr)
 Get the object info of all the registered objects whose stringified identities match the given expression. More...
 
idempotent Ice::StringSeq getAllRegistryNames ()
 Get all the IceGrid registries currently registered. More...
 
idempotent Ice::StringSeq getAllServerIds ()
 Get all the server ids registered with IceGrid. More...
 
idempotent ApplicationInfo getApplicationInfo (string name) throws ApplicationNotExistException
 Get an application descriptor. More...
 
idempotent ApplicationDescriptor getDefaultApplicationDescriptor () throws DeploymentException
 Get the default application descriptor. More...
 
idempotent Object * getNodeAdmin (string name) throws NodeNotExistException, NodeUnreachableException
 Get a proxy to the IceGrid node's admin object. More...
 
idempotent string getNodeHostname (string name) throws NodeNotExistException, NodeUnreachableException
 Get the hostname of this node. 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 int getNodeProcessorSocketCount (string name) throws NodeNotExistException, NodeUnreachableException
 Get the number of physical processor sockets for the machine running the node with the given name. More...
 
idempotent ObjectInfo getObjectInfo (Ice::Identity id) throws ObjectNotRegisteredException
 Get the object info for the object with the given identity. More...
 
idempotent ObjectInfoSeq getObjectInfosByType (string type)
 Get the object info of all the registered objects with the given type. More...
 
idempotent Object * getRegistryAdmin (string name) throws RegistryNotExistException
 Get a proxy to the IceGrid registry's admin object. More...
 
idempotent RegistryInfo getRegistryInfo (string name) throws RegistryNotExistException, RegistryUnreachableException
 Get the registry information for the registry with the given name. More...
 
idempotent Object * getServerAdmin (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Get a proxy to the server's admin object. More...
 
idempotent string getServerAdminCategory ()
 Get the category for server admin objects. More...
 
idempotent ServerInfo getServerInfo (string id) throws ServerNotExistException
 Get the server information for the server with the given id. More...
 
idempotent int getServerPid (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Get a server's system process id. More...
 
idempotent ServerState getServerState (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Get a server's state. More...
 
idempotent Ice::SliceChecksumDict getSliceChecksums ()
 Returns the checksums for the IceGrid Slice definitions. More...
 
void instantiateServer (string application, string node, ServerInstanceDescriptor desc) throws AccessDeniedException, ApplicationNotExistException, DeploymentException
 Instantiate a server template from an application on the given node. More...
 
idempotent bool isServerEnabled (string id) throws ServerNotExistException, NodeUnreachableException, DeploymentException
 Check if the server is enabled or disabled. More...
 
void patchApplication (string name, bool shutdown) throws ApplicationNotExistException, PatchException
 Patch the given application data. More...
 
void patchServer (string id, bool shutdown) throws ServerNotExistException, NodeUnreachableException, DeploymentException, PatchException
 Patch a server. More...
 
idempotent bool pingNode (string name) throws NodeNotExistException
 Ping an IceGrid node to see if it is active. More...
 
idempotent bool pingRegistry (string name) throws RegistryNotExistException
 Ping an IceGrid registry to see if it is active. More...
 
void removeAdapter (string id) throws AdapterNotExistException, DeploymentException
 Remove the adapter with the given id. More...
 
void removeApplication (string name) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Remove an application from IceGrid. More...
 
void removeObject (Ice::Identity id) throws ObjectNotRegisteredException, DeploymentException
 Remove an object from the object registry. More...
 
void sendSignal (string id, string signal) throws ServerNotExistException, NodeUnreachableException, DeploymentException, BadSignalException
 Send signal to a server. More...
 
void shutdown ()
 Shut down the IceGrid registry. More...
 
void shutdownNode (string name) throws NodeNotExistException, NodeUnreachableException
 Shutdown an IceGrid node. More...
 
idempotent void shutdownRegistry (string name) throws RegistryNotExistException, RegistryUnreachableException
 Shutdown an IceGrid registry. More...
 
void startServer (string id) throws ServerNotExistException, ServerStartException, NodeUnreachableException, DeploymentException
 Start a server and wait for its activation. More...
 
void stopServer (string id) throws ServerNotExistException, ServerStopException, NodeUnreachableException, DeploymentException
 Stop a server. More...
 
void syncApplication (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Synchronize a deployed application with the given application descriptor. More...
 
void syncApplicationWithoutRestart (ApplicationDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Synchronize a deployed application with the given application descriptor. More...
 
void updateApplication (ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Update a deployed application with the given update application descriptor. More...
 
void updateApplicationWithoutRestart (ApplicationUpdateDescriptor descriptor) throws AccessDeniedException, DeploymentException, ApplicationNotExistException
 Update a deployed application with the given update application descriptor only if no server restarts are necessary for the update of the application. More...
 
void updateObject (Object *obj) throws ObjectNotRegisteredException, DeploymentException
 Update an object in the object registry. More...
 

Detailed Description

The IceGrid administrative interface.

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

Operation Documentation

◆ addApplication()

void addApplication ( ApplicationDescriptor  descriptor) throws AccessDeniedException, DeploymentException

Add an application to IceGrid.

Parameters
descriptorThe application descriptor.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.

◆ addObject()

void addObject ( Object *  obj) throws ObjectExistsException, DeploymentException

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
objThe object to be added to the registry.
Exceptions
ObjectExistsExceptionRaised if the object is already registered.
DeploymentExceptionRaised if the object can't be added. This might be raised if the invocation on the proxy to get the object type failed.

◆ addObjectWithType()

void addObjectWithType ( Object *  obj,
string  type 
) throws ObjectExistsException, DeploymentException

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

Parameters
objThe object to be added to the registry.
typeThe object type.
Exceptions
ObjectExistsExceptionRaised if the object is already registered.
DeploymentExceptionRaised if application deployment failed.

◆ enableServer()

idempotent void enableServer ( string  id,
bool  enabled 
) throws ServerNotExistException, NodeUnreachableException, DeploymentException

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
idThe server id.
enabledTrue to enable the server, false to disable it.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ 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
idThe 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
AdapterNotExistExceptionRaised if the adapter or replica group doesn't exist.

◆ getAllAdapterIds()

["nonmutating","cpp:const"]
idempotent Ice::StringSeq getAllAdapterIds ( )

Get all the adapter ids registered with IceGrid.

Returns
The adapter ids.

◆ getAllApplicationNames()

["nonmutating","cpp:const"]
idempotent Ice::StringSeq getAllApplicationNames ( )

Get all the IceGrid applications currently registered.

Returns
The application names.

◆ getAllNodeNames()

["nonmutating","cpp:const"]
idempotent Ice::StringSeq getAllNodeNames ( )

Get all the IceGrid nodes currently registered.

Returns
The node names.

◆ getAllObjectInfos()

["nonmutating","cpp:const"]
idempotent ObjectInfoSeq getAllObjectInfos ( string  expr)

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

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

◆ getAllRegistryNames()

["cpp:const"]
idempotent Ice::StringSeq getAllRegistryNames ( )

Get all the IceGrid registries currently registered.

Returns
The registry names.

◆ getAllServerIds()

["nonmutating","cpp:const"]
idempotent Ice::StringSeq getAllServerIds ( )

Get all the server ids registered with IceGrid.

Returns
The server ids.

◆ getApplicationInfo()

["nonmutating","cpp:const"]
idempotent ApplicationInfo getApplicationInfo ( string  name) throws ApplicationNotExistException

Get an application descriptor.

Parameters
nameThe application name.
Returns
The application descriptor.
Exceptions
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ getDefaultApplicationDescriptor()

["nonmutating","cpp:const"]
idempotent ApplicationDescriptor getDefaultApplicationDescriptor ( ) throws DeploymentException

Get the default application descriptor.

Returns
The default application descriptor.
Exceptions
DeploymentExceptionRaised if the default application descriptor can't be accessed or is invalid.

◆ getNodeAdmin()

["cpp:const"]
idempotent Object* getNodeAdmin ( string  name) throws NodeNotExistException, NodeUnreachableException

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

Parameters
nameThe IceGrid node name
Returns
A proxy to the IceGrid node's admin object
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeHostname()

["nonmutating","cpp:const"]
idempotent string getNodeHostname ( string  name) throws NodeNotExistException, NodeUnreachableException

Get the hostname of this node.

Parameters
nameThe node name.
Returns
The node hostname.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeInfo()

["nonmutating","cpp:const"]
idempotent NodeInfo getNodeInfo ( string  name) throws NodeNotExistException, NodeUnreachableException

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

Parameters
nameThe node name.
Returns
The node information.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised 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
nameThe node name.
Returns
The node load information.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.

◆ getNodeProcessorSocketCount()

["nonmutating","cpp:const"]
idempotent int getNodeProcessorSocketCount ( 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
nameThe node name.
Returns
The number of processor sockets or 1 if the number of sockets can't determined.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised 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
idThe identity of the object.
Returns
The object info.
Exceptions
ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.

◆ getObjectInfosByType()

["nonmutating","cpp:const"]
idempotent ObjectInfoSeq getObjectInfosByType ( string  type)

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

Parameters
typeThe type of the object.
Returns
The object infos.

◆ getRegistryAdmin()

["cpp:const"]
idempotent Object* getRegistryAdmin ( string  name) throws RegistryNotExistException

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

Parameters
nameThe registry name
Returns
A proxy to the IceGrid registry's admin object
Exceptions
RegistryNotExistExceptionRaised if the registry doesn't exist.

◆ getRegistryInfo()

["cpp:const"]
idempotent RegistryInfo getRegistryInfo ( string  name) throws RegistryNotExistException, RegistryUnreachableException

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

Parameters
nameThe registry name.
Returns
The registry information.
Exceptions
RegistryNotExistExceptionRaised if the registry doesn't exist.
RegistryUnreachableExceptionRaised if the registry could not be reached.

◆ getServerAdmin()

["cpp:const"]
idempotent Object* getServerAdmin ( string  id) throws ServerNotExistException, NodeUnreachableException, DeploymentException

Get a proxy to the server's admin object.

Parameters
idThe server id.
Returns
A proxy to the server's admin object
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ getServerAdminCategory()

["cpp:const"]
idempotent 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.

◆ getServerInfo()

["nonmutating","cpp:const"]
idempotent ServerInfo getServerInfo ( string  id) throws ServerNotExistException

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

Parameters
idThe server id.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
Returns
The server information.

◆ getServerPid()

["nonmutating","cpp:const"]
idempotent int getServerPid ( string  id) throws ServerNotExistException, NodeUnreachableException, DeploymentException

Get a server's system process id.

The process id is operating system dependent.

Parameters
idThe server id.
Returns
The server's process id.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ getServerState()

["nonmutating","cpp:const"]
idempotent ServerState getServerState ( string  id) throws ServerNotExistException, NodeUnreachableException, DeploymentException

Get a server's state.

Parameters
idThe server id.
Returns
The server state.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ getSliceChecksums()

["nonmutating","cpp:const"]
idempotent Ice::SliceChecksumDict getSliceChecksums ( )

Returns the checksums for the IceGrid Slice definitions.

Returns
A dictionary mapping Slice type ids to their checksums.

◆ instantiateServer()

void instantiateServer ( string  application,
string  node,
ServerInstanceDescriptor  desc 
) throws AccessDeniedException, ApplicationNotExistException, DeploymentException

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

Parameters
applicationThe application name.
nodeThe name of the node where the server will be deployed.
descThe descriptor of the server instance to deploy.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if server instantiation failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ isServerEnabled()

["nonmutating","cpp:const"]
idempotent bool isServerEnabled ( string  id) throws ServerNotExistException, NodeUnreachableException, DeploymentException

Check if the server is enabled or disabled.

Parameters
idThe server id.
Returns
True if the server is enabled.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ patchApplication()

["amd"]
void patchApplication ( string  name,
bool  shutdown 
) throws ApplicationNotExistException, PatchException

Patch the given application data.

Parameters
nameThe application name.
shutdownIf true, the servers depending on the data to patch will be shut down if necessary.
Exceptions
ApplicationNotExistExceptionRaised if the application doesn't exist.
PatchExceptionRaised if the patch failed.

◆ patchServer()

["amd"]
void patchServer ( string  id,
bool  shutdown 
) throws ServerNotExistException, NodeUnreachableException, DeploymentException, PatchException

Patch a server.

Parameters
idThe server id.
shutdownIf true, servers depending on the data to patch will be shut down if necessary.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.
PatchExceptionRaised if the patch failed.

◆ pingNode()

["nonmutating","cpp:const"]
idempotent bool pingNode ( string  name) throws NodeNotExistException

Ping an IceGrid node to see if it is active.

Parameters
nameThe node name.
Returns
true if the node ping succeeded, false otherwise.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.

◆ pingRegistry()

["cpp:const"]
idempotent bool pingRegistry ( string  name) throws RegistryNotExistException

Ping an IceGrid registry to see if it is active.

Parameters
nameThe registry name.
Returns
true if the registry ping succeeded, false otherwise.
Exceptions
RegistryNotExistExceptionRaised if the registry doesn't exist.

◆ removeAdapter()

void removeAdapter ( string  id) throws AdapterNotExistException, DeploymentException

Remove the adapter with the given id.

Parameters
idThe adapter id.
Exceptions
AdapterNotExistExceptionRaised if the adapter doesn't exist.
DeploymentExceptionRaised if application deployment failed.

◆ removeApplication()

void removeApplication ( string  name) throws AccessDeniedException, DeploymentException, ApplicationNotExistException

Remove an application from IceGrid.

Parameters
nameThe application name.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ removeObject()

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
idThe identity of the object to be removed from the registry.
Exceptions
ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.
DeploymentExceptionRaised if the object can't be removed. This might happen if the object was added with a deployment descriptor.

◆ sendSignal()

void sendSignal ( string  id,
string  signal 
) throws ServerNotExistException, NodeUnreachableException, DeploymentException, BadSignalException

Send signal to a server.

Parameters
idThe server id.
signalThe signal, for example SIGTERM or 15.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.
BadSignalExceptionRaised if the signal is not recognized by the target server.

◆ shutdown()

void shutdown ( )

Shut down the IceGrid registry.

◆ shutdownNode()

void shutdownNode ( string  name) throws NodeNotExistException, NodeUnreachableException

Shutdown an IceGrid node.

Parameters
nameThe node name.
Exceptions
NodeNotExistExceptionRaised if the node doesn't exist.
NodeUnreachableExceptionRaised if the node could not be reached.

◆ shutdownRegistry()

idempotent void shutdownRegistry ( string  name) throws RegistryNotExistException, RegistryUnreachableException

Shutdown an IceGrid registry.

Parameters
nameThe registry name.
Exceptions
RegistryNotExistExceptionRaised if the registry doesn't exist.
RegistryUnreachableExceptionRaised if the registry could not be reached.

◆ startServer()

Start a server and wait for its activation.

Parameters
idThe server id.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
ServerStartExceptionRaised if the server couldn't be started.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ stopServer()

Stop a server.

Parameters
idThe server id.
Exceptions
ServerNotExistExceptionRaised if the server doesn't exist.
ServerStopExceptionRaised if the server couldn't be stopped.
NodeUnreachableExceptionRaised if the node could not be reached.
DeploymentExceptionRaised if the server couldn't be deployed on the node.

◆ syncApplication()

Synchronize a deployed application with the given application descriptor.

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

Parameters
descriptorThe application descriptor.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ syncApplicationWithoutRestart()

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

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
descriptorThe application descriptor.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ updateApplication()

Update a deployed application with the given update application descriptor.

Parameters
descriptorThe update descriptor.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ updateApplicationWithoutRestart()

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

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
descriptorThe update descriptor.
Exceptions
AccessDeniedExceptionRaised if the session doesn't hold the exclusive lock or if another session is holding the lock.
DeploymentExceptionRaised if application deployment failed.
ApplicationNotExistExceptionRaised if the application doesn't exist.

◆ updateObject()

void updateObject ( Object *  obj) throws ObjectNotRegisteredException, DeploymentException

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
objThe object to be updated to the registry.
Exceptions
ObjectNotRegisteredExceptionRaised if the object isn't registered with the registry.
DeploymentExceptionRaised if the object can't be updated. This might happen if the object was added with a deployment descriptor.

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