_AdminDisp (icegrid 3.6.5 API)

java.lang.Object
- Ice.ObjectImpl
- - IceGrid._AdminDisp

All Implemented Interfaces:

Ice.Object, _AdminOperations, _AdminOperationsNC, Admin, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

_AdminTie
```
public abstract class _AdminDisp
extends Ice.ObjectImpl
implements Admin
```
The IceGrid administrative interface.
Allowing access to this interface is a security risk! Please see the IceGrid documentation for further information.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String[] __ids

static long serialVersionUID
- Fields inherited from interface IceGrid.Admin
  ice_staticId

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`__ids`
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

_AdminDisp()

Constructors
Constructor and Description
`_AdminDisp()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Ice.DispatchStatus`	`___addApplication(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___addObject(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___addObjectWithType(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___enableServer(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAdapterInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllAdapterIds(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllApplicationNames(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllNodeNames(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllObjectInfos(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllRegistryNames(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getAllServerIds(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getApplicationInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getDefaultApplicationDescriptor(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getNodeAdmin(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getNodeHostname(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getNodeInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getNodeLoad(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getNodeProcessorSocketCount(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getObjectInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getObjectInfosByType(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getRegistryAdmin(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getRegistryInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getServerAdmin(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getServerAdminCategory(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getServerInfo(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getServerPid(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getServerState(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___getSliceChecksums(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___instantiateServer(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___isServerEnabled(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___patchApplication(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___patchServer(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___pingNode(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___pingRegistry(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___removeAdapter(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___removeApplication(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___removeObject(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___sendSignal(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___shutdown(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___shutdownNode(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___shutdownRegistry(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___startServer(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___stopServer(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___syncApplication(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___syncApplicationWithoutRestart(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___updateApplication(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___updateApplicationWithoutRestart(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`static Ice.DispatchStatus`	`___updateObject(Admin __obj, IceInternal.Incoming __inS, Ice.Current __current)`
`Ice.DispatchStatus`	`__dispatch(IceInternal.Incoming in, Ice.Current __current)`
`protected void`	`__readImpl(IceInternal.BasicStream __is)`
`protected void`	`__writeImpl(IceInternal.BasicStream __os)`
`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.
`protected void`	`ice_copyStateFrom(Ice.Object __obj)`
`java.lang.String`	`ice_id()`
`java.lang.String`	`ice_id(Ice.Current __current)`
`java.lang.String[]`	`ice_ids()`
`java.lang.String[]`	`ice_ids(Ice.Current __current)`
`boolean`	`ice_isA(java.lang.String s)`
`boolean`	`ice_isA(java.lang.String s, Ice.Current __current)`
`static java.lang.String`	`ice_staticId()`
`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.

Methods inherited from class Ice.ObjectImpl
___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object
__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from interface IceGrid._AdminOperations
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, instantiateServer, isServerEnabled, patchApplication_async, patchServer_async, pingNode, pingRegistry, removeAdapter, removeApplication, removeObject, sendSignal, shutdown, shutdownNode, shutdownRegistry, startServer_async, stopServer_async, syncApplication, syncApplicationWithoutRestart, updateApplication, updateApplicationWithoutRestart, updateObject

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID
```
public static final long serialVersionUID
```
See Also:

Constant Field Values

Constructor Detail
- _AdminDisp
```
public _AdminDisp()
```

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:: java.lang.CloneNotSupportedException

ice_isA
```
public boolean ice_isA(java.lang.String s)
```
Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:: ice_isA in interface Ice.Object
Overrides:: ice_isA in class Ice.ObjectImpl

ice_ids
```
public java.lang.String[] ice_ids()
```
Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids
```
public java.lang.String[] ice_ids(Ice.Current __current)
```
Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id
```
public java.lang.String ice_id()
```
Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id
```
public java.lang.String ice_id(Ice.Current __current)
```
Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

addApplication
```
public final void addApplication(ApplicationDescriptor descriptor)
                          throws AccessDeniedException,
                                 DeploymentException
```
Add an application to IceGrid.

Specified by:

addApplication in interface _AdminOperationsNC

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.

addObject
```
public final 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.

Specified by:

addObject in interface _AdminOperationsNC

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.

addObjectWithType
```
public final void addObjectWithType(Ice.ObjectPrx obj,
                                    java.lang.String type)
                             throws DeploymentException,
                                    ObjectExistsException
```
Add an object to the object registry and explicitly specify its type.

Specified by:

addObjectWithType in interface _AdminOperationsNC

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.

enableServer
```
public final 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.

Specified by:

enableServer in interface _AdminOperationsNC

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.

getAdapterInfo
```
public final AdapterInfo[] getAdapterInfo(java.lang.String id)
                                   throws AdapterNotExistException
```
Get the adapter information for the replica group or adapter with the given id.

Specified by:

getAdapterInfo in interface _AdminOperationsNC

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.

getAllAdapterIds
```
public final java.lang.String[] getAllAdapterIds()
```
Get all the adapter ids registered with IceGrid.

Specified by:

getAllAdapterIds in interface _AdminOperationsNC

Returns:

The adapter ids.

getAllApplicationNames
```
public final java.lang.String[] getAllApplicationNames()
```
Get all the IceGrid applications currently registered.

Specified by:

getAllApplicationNames in interface _AdminOperationsNC

Returns:

The application names.

getAllNodeNames
```
public final java.lang.String[] getAllNodeNames()
```
Get all the IceGrid nodes currently registered.

Specified by:

getAllNodeNames in interface _AdminOperationsNC

Returns:

The node names.

getAllObjectInfos
```
public final ObjectInfo[] getAllObjectInfos(java.lang.String expr)
```
Get the object info of all the registered objects whose stringified identities match the given expression.

Specified by:

getAllObjectInfos in interface _AdminOperationsNC

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.

getAllRegistryNames
```
public final java.lang.String[] getAllRegistryNames()
```
Get all the IceGrid registries currently registered.

Specified by:

getAllRegistryNames in interface _AdminOperationsNC

Returns:

The registry names.

getAllServerIds
```
public final java.lang.String[] getAllServerIds()
```
Get all the server ids registered with IceGrid.

Specified by:

getAllServerIds in interface _AdminOperationsNC

Returns:

The server ids.

getApplicationInfo
```
public final ApplicationInfo getApplicationInfo(java.lang.String name)
                                         throws ApplicationNotExistException
```
Get an application descriptor.

Specified by:

getApplicationInfo in interface _AdminOperationsNC

Parameters:

name - The application name.

Returns:

The application descriptor.

Throws:

ApplicationNotExistException - Raised if the application doesn't exist.

getDefaultApplicationDescriptor
```
public final ApplicationDescriptor getDefaultApplicationDescriptor()
                                                            throws DeploymentException
```
Get the default application descriptor.

Specified by:

getDefaultApplicationDescriptor in interface _AdminOperationsNC

Returns:

The default application descriptor.

Throws:

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

getNodeAdmin
```
public final Ice.ObjectPrx getNodeAdmin(java.lang.String name)
                                 throws NodeNotExistException,
                                        NodeUnreachableException
```
Get a proxy to the IceGrid node's admin object.

Specified by:

getNodeAdmin in interface _AdminOperationsNC

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.

getNodeHostname
```
public final java.lang.String getNodeHostname(java.lang.String name)
                                       throws NodeNotExistException,
                                              NodeUnreachableException
```
Get the hostname of this node.

Specified by:

getNodeHostname in interface _AdminOperationsNC

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.

getNodeInfo
```
public final NodeInfo getNodeInfo(java.lang.String name)
                           throws NodeNotExistException,
                                  NodeUnreachableException
```
Get the node information for the node with the given name.

Specified by:

getNodeInfo in interface _AdminOperationsNC

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.

getNodeLoad
```
public final LoadInfo getNodeLoad(java.lang.String name)
                           throws NodeNotExistException,
                                  NodeUnreachableException
```
Get the load averages of the node.

Specified by:

getNodeLoad in interface _AdminOperationsNC

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.

getNodeProcessorSocketCount
```
public final 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.

Specified by:

getNodeProcessorSocketCount in interface _AdminOperationsNC

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.

getObjectInfo
```
public final ObjectInfo getObjectInfo(Ice.Identity id)
                               throws ObjectNotRegisteredException
```
Get the object info for the object with the given identity.

Specified by:

getObjectInfo in interface _AdminOperationsNC

Parameters:

id - The identity of the object.

Returns:

The object info.

Throws:

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

getObjectInfosByType
```
public final ObjectInfo[] getObjectInfosByType(java.lang.String type)
```
Get the object info of all the registered objects with the given type.

Specified by:

getObjectInfosByType in interface _AdminOperationsNC

Parameters:

type - The type of the object.

Returns:

The object infos.

getRegistryAdmin
```
public final Ice.ObjectPrx getRegistryAdmin(java.lang.String name)
                                     throws RegistryNotExistException
```
Get a proxy to the IceGrid registry's admin object.

Specified by:

getRegistryAdmin in interface _AdminOperationsNC

Parameters:

name - The registry name

Returns:

A proxy to the IceGrid registry's admin object

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

getRegistryInfo
```
public final RegistryInfo getRegistryInfo(java.lang.String name)
                                   throws RegistryNotExistException,
                                          RegistryUnreachableException
```
Get the registry information for the registry with the given name.

Specified by:

getRegistryInfo in interface _AdminOperationsNC

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.

getServerAdmin
```
public final Ice.ObjectPrx getServerAdmin(java.lang.String id)
                                   throws DeploymentException,
                                          NodeUnreachableException,
                                          ServerNotExistException
```
Get a proxy to the server's admin object.

Specified by:

getServerAdmin in interface _AdminOperationsNC

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.

getServerAdminCategory
```
public final 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.

Specified by:

getServerAdminCategory in interface _AdminOperationsNC

Returns:

The category for server admin objects.

getServerInfo
```
public final ServerInfo getServerInfo(java.lang.String id)
                               throws ServerNotExistException
```
Get the server information for the server with the given id.

Specified by:

getServerInfo in interface _AdminOperationsNC

Parameters:

id - The server id.

Returns:

The server information.

Throws:

ServerNotExistException - Raised if the server doesn't exist.

getServerPid
```
public final int getServerPid(java.lang.String id)
                       throws DeploymentException,
                              NodeUnreachableException,
                              ServerNotExistException
```
Get a server's system process id. The process id is operating system dependent.

Specified by:

getServerPid in interface _AdminOperationsNC

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.

getServerState
```
public final ServerState getServerState(java.lang.String id)
                                 throws DeploymentException,
                                        NodeUnreachableException,
                                        ServerNotExistException
```
Get a server's state.

Specified by:

getServerState in interface _AdminOperationsNC

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.

getSliceChecksums
```
public final java.util.Map<java.lang.String,java.lang.String> getSliceChecksums()
```
Returns the checksums for the IceGrid Slice definitions.

Specified by:

getSliceChecksums in interface _AdminOperationsNC

Returns:

A dictionary mapping Slice type ids to their checksums.

instantiateServer
```
public final 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.

Specified by:

instantiateServer in interface _AdminOperationsNC

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.

isServerEnabled
```
public final boolean isServerEnabled(java.lang.String id)
                              throws DeploymentException,
                                     NodeUnreachableException,
                                     ServerNotExistException
```
Check if the server is enabled or disabled.

Specified by:

isServerEnabled in interface _AdminOperationsNC

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.

patchApplication_async
```
public final void patchApplication_async(AMD_Admin_patchApplication __cb,
                                         java.lang.String name,
                                         boolean shutdown)
                                  throws ApplicationNotExistException,
                                         PatchException
```
Patch the given application data.

Specified by:

patchApplication_async in interface _AdminOperationsNC

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.

patchServer_async

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

Patch a server.

Specified by:: patchServer_async in interface _AdminOperationsNC
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.

pingNode
```
public final boolean pingNode(java.lang.String name)
                       throws NodeNotExistException
```
Ping an IceGrid node to see if it is active.

Specified by:

pingNode in interface _AdminOperationsNC

Parameters:

name - The node name.

Returns:

true if the node ping succeeded, false otherwise.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

pingRegistry
```
public final boolean pingRegistry(java.lang.String name)
                           throws RegistryNotExistException
```
Ping an IceGrid registry to see if it is active.

Specified by:

pingRegistry in interface _AdminOperationsNC

Parameters:

name - The registry name.

Returns:

true if the registry ping succeeded, false otherwise.

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

removeAdapter
```
public final void removeAdapter(java.lang.String id)
                         throws AdapterNotExistException,
                                DeploymentException
```
Remove the adapter with the given id.

Specified by:

removeAdapter in interface _AdminOperationsNC

Parameters:

id - The adapter id.

Throws:

AdapterNotExistException - Raised if the adapter doesn't exist.

DeploymentException - Raised if application deployment failed.

removeApplication
```
public final void removeApplication(java.lang.String name)
                             throws AccessDeniedException,
                                    ApplicationNotExistException,
                                    DeploymentException
```
Remove an application from IceGrid.

Specified by:

removeApplication in interface _AdminOperationsNC

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.

removeObject
```
public final 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.

Specified by:

removeObject in interface _AdminOperationsNC

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.

sendSignal
```
public final void sendSignal(java.lang.String id,
                             java.lang.String signal)
                      throws BadSignalException,
                             DeploymentException,
                             NodeUnreachableException,
                             ServerNotExistException
```
Send signal to a server.

Specified by:

sendSignal in interface _AdminOperationsNC

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.

shutdown
```
public final void shutdown()
```
Shut down the IceGrid registry.

Specified by:

shutdown in interface _AdminOperationsNC

shutdownNode
```
public final void shutdownNode(java.lang.String name)
                        throws NodeNotExistException,
                               NodeUnreachableException
```
Shutdown an IceGrid node.

Specified by:

shutdownNode in interface _AdminOperationsNC

Parameters:

name - The node name.

Throws:

NodeNotExistException - Raised if the node doesn't exist.

NodeUnreachableException - Raised if the node could not be reached.

shutdownRegistry
```
public final void shutdownRegistry(java.lang.String name)
                            throws RegistryNotExistException,
                                   RegistryUnreachableException
```
Shutdown an IceGrid registry.

Specified by:

shutdownRegistry in interface _AdminOperationsNC

Parameters:

name - The registry name.

Throws:

RegistryNotExistException - Raised if the registry doesn't exist.

RegistryUnreachableException - Raised if the registry could not be reached.

startServer_async

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

Start a server and wait for its activation.

Specified by:: startServer_async in interface _AdminOperationsNC
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

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

Stop a server.

Specified by:: stopServer_async in interface _AdminOperationsNC
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.

syncApplication
```
public final 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.

Specified by:

syncApplication in interface _AdminOperationsNC

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.

syncApplicationWithoutRestart
```
public final 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.

Specified by:

syncApplicationWithoutRestart in interface _AdminOperationsNC

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
```
public final void updateApplication(ApplicationUpdateDescriptor descriptor)
                             throws AccessDeniedException,
                                    ApplicationNotExistException,
                                    DeploymentException
```
Update a deployed application with the given update application descriptor.

Specified by:

updateApplication in interface _AdminOperationsNC

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.

updateApplicationWithoutRestart
```
public final 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.

Specified by:

updateApplicationWithoutRestart in interface _AdminOperationsNC

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.

updateObject
```
public final 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.

Specified by:

updateObject in interface _AdminOperationsNC

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.

___addApplication

public static Ice.DispatchStatus ___addApplication(Admin __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___syncApplication

public static Ice.DispatchStatus ___syncApplication(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___updateApplication

public static Ice.DispatchStatus ___updateApplication(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___syncApplicationWithoutRestart

public static Ice.DispatchStatus ___syncApplicationWithoutRestart(Admin __obj,
                                                                  IceInternal.Incoming __inS,
                                                                  Ice.Current __current)

___updateApplicationWithoutRestart

public static Ice.DispatchStatus ___updateApplicationWithoutRestart(Admin __obj,
                                                                    IceInternal.Incoming __inS,
                                                                    Ice.Current __current)

___removeApplication

public static Ice.DispatchStatus ___removeApplication(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___instantiateServer

public static Ice.DispatchStatus ___instantiateServer(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___patchApplication

public static Ice.DispatchStatus ___patchApplication(Admin __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___getApplicationInfo

public static Ice.DispatchStatus ___getApplicationInfo(Admin __obj,
                                                       IceInternal.Incoming __inS,
                                                       Ice.Current __current)

___getDefaultApplicationDescriptor

public static Ice.DispatchStatus ___getDefaultApplicationDescriptor(Admin __obj,
                                                                    IceInternal.Incoming __inS,
                                                                    Ice.Current __current)

___getAllApplicationNames

public static Ice.DispatchStatus ___getAllApplicationNames(Admin __obj,
                                                           IceInternal.Incoming __inS,
                                                           Ice.Current __current)

___getServerInfo

public static Ice.DispatchStatus ___getServerInfo(Admin __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___getServerState

public static Ice.DispatchStatus ___getServerState(Admin __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___getServerPid

public static Ice.DispatchStatus ___getServerPid(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getServerAdminCategory

public static Ice.DispatchStatus ___getServerAdminCategory(Admin __obj,
                                                           IceInternal.Incoming __inS,
                                                           Ice.Current __current)

___getServerAdmin

public static Ice.DispatchStatus ___getServerAdmin(Admin __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___enableServer

public static Ice.DispatchStatus ___enableServer(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___isServerEnabled

public static Ice.DispatchStatus ___isServerEnabled(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___startServer

public static Ice.DispatchStatus ___startServer(Admin __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___stopServer

public static Ice.DispatchStatus ___stopServer(Admin __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___patchServer

public static Ice.DispatchStatus ___patchServer(Admin __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___sendSignal

public static Ice.DispatchStatus ___sendSignal(Admin __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___getAllServerIds

public static Ice.DispatchStatus ___getAllServerIds(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___getAdapterInfo

public static Ice.DispatchStatus ___getAdapterInfo(Admin __obj,
                                                   IceInternal.Incoming __inS,
                                                   Ice.Current __current)

___removeAdapter

public static Ice.DispatchStatus ___removeAdapter(Admin __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___getAllAdapterIds

public static Ice.DispatchStatus ___getAllAdapterIds(Admin __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___addObject

public static Ice.DispatchStatus ___addObject(Admin __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___updateObject

public static Ice.DispatchStatus ___updateObject(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___addObjectWithType

public static Ice.DispatchStatus ___addObjectWithType(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___removeObject

public static Ice.DispatchStatus ___removeObject(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getObjectInfo

public static Ice.DispatchStatus ___getObjectInfo(Admin __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___getObjectInfosByType

public static Ice.DispatchStatus ___getObjectInfosByType(Admin __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

___getAllObjectInfos

public static Ice.DispatchStatus ___getAllObjectInfos(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___pingNode

public static Ice.DispatchStatus ___pingNode(Admin __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___getNodeLoad

public static Ice.DispatchStatus ___getNodeLoad(Admin __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___getNodeInfo

public static Ice.DispatchStatus ___getNodeInfo(Admin __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___getNodeAdmin

public static Ice.DispatchStatus ___getNodeAdmin(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getNodeProcessorSocketCount

public static Ice.DispatchStatus ___getNodeProcessorSocketCount(Admin __obj,
                                                                IceInternal.Incoming __inS,
                                                                Ice.Current __current)

___shutdownNode

public static Ice.DispatchStatus ___shutdownNode(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getNodeHostname

public static Ice.DispatchStatus ___getNodeHostname(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___getAllNodeNames

public static Ice.DispatchStatus ___getAllNodeNames(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___pingRegistry

public static Ice.DispatchStatus ___pingRegistry(Admin __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getRegistryInfo

public static Ice.DispatchStatus ___getRegistryInfo(Admin __obj,
                                                    IceInternal.Incoming __inS,
                                                    Ice.Current __current)

___getRegistryAdmin

public static Ice.DispatchStatus ___getRegistryAdmin(Admin __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___shutdownRegistry

public static Ice.DispatchStatus ___shutdownRegistry(Admin __obj,
                                                     IceInternal.Incoming __inS,
                                                     Ice.Current __current)

___getAllRegistryNames

public static Ice.DispatchStatus ___getAllRegistryNames(Admin __obj,
                                                        IceInternal.Incoming __inS,
                                                        Ice.Current __current)

___shutdown

public static Ice.DispatchStatus ___shutdown(Admin __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___getSliceChecksums

public static Ice.DispatchStatus ___getSliceChecksums(Admin __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:: __dispatch in interface Ice.Object
Overrides:: __dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:: __writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:: __readImpl in class Ice.ObjectImpl

Class _AdminDisp

Field Summary

Fields inherited from interface IceGrid.Admin

Constructor Summary

Method Summary

Methods inherited from class Ice.ObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface Ice.Object

Methods inherited from interface IceGrid._AdminOperations

Field Detail

__ids

serialVersionUID

Constructor Detail

_AdminDisp

Method Detail

ice_copyStateFrom

ice_isA

ice_isA

ice_ids

ice_ids

ice_id

ice_id

ice_staticId

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

instantiateServer

isServerEnabled

patchApplication_async

patchServer_async

pingNode

pingRegistry

removeAdapter

removeApplication

removeObject

sendSignal

shutdown

shutdownNode

shutdownRegistry

startServer_async

stopServer_async

syncApplication

syncApplicationWithoutRestart

updateApplication

updateApplicationWithoutRestart

updateObject

___addApplication

___syncApplication

___updateApplication

___syncApplicationWithoutRestart

___updateApplicationWithoutRestart

___removeApplication

___instantiateServer

___patchApplication

___getApplicationInfo