Class Admin`Abstract`

Provides administrative access to an IceGrid deployment.

Remarks

The Slice compiler generated this skeleton class from Slice interface ::IceGrid::Admin.

Hierarchy (View Summary)

Object
- Admin

Constructors

constructor

new Admin(): Admin
Returns Admin
Inherited from Object.constructor

Methods

`Abstract`addApplication

addApplication(
descriptor: ApplicationDescriptor,
current: Current,
): void | PromiseLike<void>
Adds an application to IceGrid.
Parameters
- descriptor: ApplicationDescriptor
  The application descriptor.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`addObject

addObject(obj: ObjectPrx, current: Current): void | PromiseLike<void>
Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
Parameters
- obj: ObjectPrx
  A proxy to the object. This proxy is never null.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the object can't be added.

Throws
IceGrid.ObjectExistsException Thrown when the object is already registered.

`Abstract`addObjectWithType

addObjectWithType(
    obj: ObjectPrx,
    type: string,
    current: Current,
): void | PromiseLike<void>
Adds an object to the object registry and explicitly specifies its type.
Parameters
- obj: ObjectPrx
  The object to be added to the registry. The proxy is never null.
- type: string
  The type name.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

Throws
IceGrid.ObjectExistsException Thrown when the object is already registered.

dispatch

dispatch(
request: IncomingRequest,
): OutgoingResponse | PromiseLike<OutgoingResponse>
Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.
Parameters
- request: IncomingRequest
  The incoming request.
Returns OutgoingResponse | PromiseLike<OutgoingResponse>
The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

Remarks
Ice marshals any exception thrown by this method into the response.

Overrides Object.dispatch

`Abstract`enableServer

enableServer(
    id: string,
    enabled: boolean,
    current: Current,
): void | PromiseLike<void>
Enables or disables 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: string
  The server ID.
- enabled: boolean
  true to enable the server, false to disable it.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`getAdapterInfo

getAdapterInfo(
id: string,
current: Current,
): AdapterInfo[] | PromiseLike<AdapterInfo[]>
Gets adapter information for the replica group or adapter with the given ID.
Parameters
- id: string
  The adapter or replica group ID.
- current: Current
  The Current object for the dispatch.
Returns AdapterInfo[] | PromiseLike<AdapterInfo[]>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.AdapterInfo[] : A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.
Throws
IceGrid.AdapterNotExistException Thrown when the adapter or replica group doesn't exist.

`Abstract`getAllAdapterIds

getAllAdapterIds(current: Current): string[] | PromiseLike<string[]>
Gets the IDs of all adapters registered with IceGrid.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string[] | PromiseLike<string[]>
A promise like object representing the result of the dispatch, which resolves to:
- string[] : The adapter IDs.

`Abstract`getAllApplicationNames

getAllApplicationNames(current: Current): string[] | PromiseLike<string[]>
Gets all the IceGrid applications currently registered.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string[] | PromiseLike<string[]>
A promise like object representing the result of the dispatch, which resolves to:
- string[] : The application names.

`Abstract`getAllNodeNames

getAllNodeNames(current: Current): string[] | PromiseLike<string[]>
Gets the names of all IceGrid nodes currently registered.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string[] | PromiseLike<string[]>
A promise like object representing the result of the dispatch, which resolves to:
- string[] : The node names.

`Abstract`getAllObjectInfos

getAllObjectInfos(
expr: string,
current: Current,
): ObjectInfo[] | PromiseLike<ObjectInfo[]>
Gets the object info of all the registered objects whose stringified identities match the given expression.
Parameters
- expr: string
  The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
- current: Current
  The Current object for the dispatch.
Returns ObjectInfo[] | PromiseLike<ObjectInfo[]>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ObjectInfo[] : All the object infos with a stringified identity matching the given expression.

`Abstract`getAllRegistryNames

getAllRegistryNames(current: Current): string[] | PromiseLike<string[]>
Gets the names of all the IceGrid registries currently registered.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string[] | PromiseLike<string[]>
A promise like object representing the result of the dispatch, which resolves to:
- string[] : The registry names.

`Abstract`getAllServerIds

getAllServerIds(current: Current): string[] | PromiseLike<string[]>
Gets the IDs of all the servers registered with IceGrid.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string[] | PromiseLike<string[]>
A promise like object representing the result of the dispatch, which resolves to:
- string[] : The server IDs.

`Abstract`getApplicationInfo

getApplicationInfo(
name: string,
current: Current,
): ApplicationInfo | PromiseLike<ApplicationInfo>
Gets an application descriptor.
Parameters
- name: string
  The application name.
- current: Current
  The Current object for the dispatch.
Returns ApplicationInfo | PromiseLike<ApplicationInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ApplicationInfo : The application descriptor.
Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

`Abstract`getDefaultApplicationDescriptor

getDefaultApplicationDescriptor(
current: Current,
): ApplicationDescriptor | PromiseLike<ApplicationDescriptor>
Gets the default application descriptor.
Parameters
- current: Current
  The Current object for the dispatch.
Returns ApplicationDescriptor | PromiseLike<ApplicationDescriptor>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ApplicationDescriptor : The default application descriptor.
Throws
IceGrid.DeploymentException Thrown when the default application descriptor is invalid or unreachable.

`Abstract`getNodeAdmin

getNodeAdmin(name: string, current: Current): ObjectPrx | PromiseLike<ObjectPrx>
Gets a proxy to the admin object of an IceGrid node.
Parameters
- name: string
  The IceGrid node name.
- current: Current
  The Current object for the dispatch.
Returns ObjectPrx | PromiseLike<ObjectPrx>
A promise like object representing the result of the dispatch, which resolves to:
- Ice.ObjectPrx | null : A proxy to the IceGrid node's admin object. This proxy is never null.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`getNodeHostname

getNodeHostname(name: string, current: Current): string | PromiseLike<string>
Get the hostname of a node.
Parameters
- name: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns string | PromiseLike<string>
A promise like object representing the result of the dispatch, which resolves to:
- string : The node hostname.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`getNodeInfo

getNodeInfo(name: string, current: Current): NodeInfo | PromiseLike<NodeInfo>
Gets the node information of a node.
Parameters
- name: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns NodeInfo | PromiseLike<NodeInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.NodeInfo : The node information.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`getNodeLoad

getNodeLoad(name: string, current: Current): LoadInfo | PromiseLike<LoadInfo>
Gets the load averages of a node.
Parameters
- name: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns LoadInfo | PromiseLike<LoadInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.LoadInfo : The node load information.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`getNodeProcessorSocketCount

getNodeProcessorSocketCount(
name: string,
current: Current,
): number | PromiseLike<number>
Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 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: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns number | PromiseLike<number>
A promise like object representing the result of the dispatch, which resolves to:
- number : The number of processor sockets or 1 if the number of sockets can't be determined.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`getObjectInfo

getObjectInfo(
id: Identity,
current: Current,
): ObjectInfo | PromiseLike<ObjectInfo>
Gets the object info for the object.
Parameters
- id: Identity
  The identity of the object.
- current: Current
  The Current object for the dispatch.
Returns ObjectInfo | PromiseLike<ObjectInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ObjectInfo : The object info.
Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

`Abstract`getObjectInfosByType

getObjectInfosByType(
type: string,
current: Current,
): ObjectInfo[] | PromiseLike<ObjectInfo[]>
Gets the object info of all the registered objects with a given type.
Parameters
- type: string
  The type name.
- current: Current
  The Current object for the dispatch.
Returns ObjectInfo[] | PromiseLike<ObjectInfo[]>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ObjectInfo[] : The object infos.

`Abstract`getRegistryAdmin

getRegistryAdmin(
name: string,
current: Current,
): ObjectPrx | PromiseLike<ObjectPrx>
Gets a proxy to the admin object of an IceGrid registry.
Parameters
- name: string
  The registry name.
- current: Current
  The Current object for the dispatch.
Returns ObjectPrx | PromiseLike<ObjectPrx>
A promise like object representing the result of the dispatch, which resolves to:
- Ice.ObjectPrx | null : A proxy to the admin object of an IceGrid registry. This proxy is never null.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

`Abstract`getRegistryInfo

getRegistryInfo(
name: string,
current: Current,
): RegistryInfo | PromiseLike<RegistryInfo>
Gets the registry information of an IceGrid registry.
Parameters
- name: string
  The registry name.
- current: Current
  The Current object for the dispatch.
Returns RegistryInfo | PromiseLike<RegistryInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.RegistryInfo : The registry information.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

Throws
IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

`Abstract`getServerAdmin

getServerAdmin(id: string, current: Current): ObjectPrx | PromiseLike<ObjectPrx>
Gets a proxy to the admin object of a server.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns ObjectPrx | PromiseLike<ObjectPrx>
A promise like object representing the result of the dispatch, which resolves to:
- Ice.ObjectPrx | null : A proxy to the admin object of the server. This proxy is never null.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`getServerAdminCategory

getServerAdminCategory(current: Current): string | PromiseLike<string>
Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
Parameters
- current: Current
  The Current object for the dispatch.
Returns string | PromiseLike<string>
A promise like object representing the result of the dispatch, which resolves to:
- string : The category for server admin objects.

`Abstract`getServerInfo

getServerInfo(
id: string,
current: Current,
): ServerInfo | PromiseLike<ServerInfo>
Gets information about a server.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns ServerInfo | PromiseLike<ServerInfo>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ServerInfo : The server information.
Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`getServerPid

getServerPid(id: string, current: Current): number | PromiseLike<number>
Gets the system process ID of a server. The process ID is operating system dependent.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns number | PromiseLike<number>
A promise like object representing the result of the dispatch, which resolves to:
- number : The process ID.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`getServerState

getServerState(
id: string,
current: Current,
): ServerState | PromiseLike<ServerState>
Gets the state of a server.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns ServerState | PromiseLike<ServerState>
A promise like object representing the result of the dispatch, which resolves to:
- IceGrid.ServerState : The server state.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

ice_id

ice_id(current: Current): string | PromiseLike<string>
Returns the Slice type ID of the most-derived interface supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string | PromiseLike<string>
The Slice type ID of the most-derived interface.

Inherited from Object.ice_id

ice_ids

ice_ids(current: Current): string[] | PromiseLike<string[]>
Returns the Slice type IDs of the interfaces supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string[] | PromiseLike<string[]>
The Slice type IDs of the interfaces supported by this object, in alphabetical order.

Inherited from Object.ice_ids

ice_isA

ice_isA(typeID: string, current: Current): boolean | PromiseLike<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeID: string
  The type ID of the Slice interface to test against.
- current: Current
  The Current object for the invocation.
Returns boolean | PromiseLike<boolean>
True if this object has the interface specified by typeID or derives from the interface specified by typeID.

Inherited from Object.ice_isA

ice_ping

ice_ping(current: Current): void | PromiseLike<void>
Tests whether this object can be reached.
Parameters
- current: Current
  The Current object for the invocation.
Returns void | PromiseLike<void>
Inherited from Object.ice_ping

`Abstract`instantiateServer

instantiateServer(
    application: string,
    node: string,
    desc: ServerInstanceDescriptor,
    current: Current,
): void | PromiseLike<void>
Instantiates a server template.
Parameters
- application: string
  The application name.
- node: string
  The name of the node where the server will be deployed.
- desc: ServerInstanceDescriptor
  The descriptor of the server instance to deploy.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`isServerEnabled

isServerEnabled(id: string, current: Current): boolean | PromiseLike<boolean>
Checks if the server is enabled or disabled.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns boolean | PromiseLike<boolean>
A promise like object representing the result of the dispatch, which resolves to:
- boolean : true if the server is enabled, false otherwise.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`pingNode

pingNode(name: string, current: Current): boolean | PromiseLike<boolean>
Pings an IceGrid node to see if it is active.
Parameters
- name: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns boolean | PromiseLike<boolean>
A promise like object representing the result of the dispatch, which resolves to:
- boolean : true if the node ping succeeded, false otherwise.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

`Abstract`pingRegistry

pingRegistry(name: string, current: Current): boolean | PromiseLike<boolean>
Pings an IceGrid registry to see if it is active.
Parameters
- name: string
  The registry name.
- current: Current
  The Current object for the dispatch.
Returns boolean | PromiseLike<boolean>
A promise like object representing the result of the dispatch, which resolves to:
- boolean : true if the registry ping succeeded, false otherwise.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

`Abstract`removeAdapter

removeAdapter(id: string, current: Current): void | PromiseLike<void>
Removes the adapter with the given ID.
Parameters
- id: string
  The adapter ID.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AdapterNotExistException Thrown when the adapter doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`removeApplication

removeApplication(name: string, current: Current): void | PromiseLike<void>
Removes an application from IceGrid.
Parameters
- name: string
  The application name.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`removeObject

removeObject(id: Identity, current: Current): void | PromiseLike<void>
Removes 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: Identity
  The identity of the object to remove.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the object can't be removed.

Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

`Abstract`sendSignal

sendSignal(
    id: string,
    signal: string,
    current: Current,
): void | PromiseLike<void>
Sends a signal to a server.
Parameters
- id: string
  The server ID.
- signal: string
  The signal, for example SIGTERM or 15.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.BadSignalException Thrown when the signal is not recognized by the target server.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

`Abstract`shutdown

shutdown(current: Current): void | PromiseLike<void>
Shuts down the IceGrid registry.
Parameters
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

`Abstract`shutdownNode

shutdownNode(name: string, current: Current): void | PromiseLike<void>
Shuts down an IceGrid node.
Parameters
- name: string
  The node name.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

`Abstract`shutdownRegistry

shutdownRegistry(name: string, current: Current): void | PromiseLike<void>
Shuts down an IceGrid registry.
Parameters
- name: string
  The registry name.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

Throws
IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

`Abstract`startServer

startServer(id: string, current: Current): void | PromiseLike<void>
Starts a server and waits for its activation.
Parameters
- id: string
  The server id.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

Throws
IceGrid.ServerStartException Thrown when the server startup failed.

`Abstract`stopServer

stopServer(id: string, current: Current): void | PromiseLike<void>
Stops a server.
Parameters
- id: string
  The server ID.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

Throws
IceGrid.ServerStopException Thrown when the server stop failed.

`Abstract`syncApplication

syncApplication(
descriptor: ApplicationDescriptor,
current: Current,
): void | PromiseLike<void>
Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
Parameters
- descriptor: ApplicationDescriptor
  The new application descriptor.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`syncApplicationWithoutRestart

syncApplicationWithoutRestart(
descriptor: ApplicationDescriptor,
current: Current,
): void | PromiseLike<void>
Synchronizes a deployed application. This operation replaces the current descriptor with a 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: ApplicationDescriptor
  The application descriptor.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`updateApplication

updateApplication(
descriptor: ApplicationUpdateDescriptor,
current: Current,
): void | PromiseLike<void>
Updates a deployed application.
Parameters
- descriptor: ApplicationUpdateDescriptor
  The update descriptor.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`updateApplicationWithoutRestart

updateApplicationWithoutRestart(
descriptor: ApplicationUpdateDescriptor,
current: Current,
): void | PromiseLike<void>
Updates a deployed application. This operation succeeds only when 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: ApplicationUpdateDescriptor
  The update descriptor.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

`Abstract`updateObject

updateObject(obj: ObjectPrx, current: Current): void | PromiseLike<void>
Updates 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: ObjectPrx
  A proxy to the object. This proxy is never null.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

Throws
IceGrid.DeploymentException Thrown when the object can't be updated.

Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

`Static`ice_staticId

ice_staticId(): string
Obtains the Slice type ID of this type.

Returns string
The return value is always "::IceGrid::Admin".

Overrides Object.ice_staticId

Class AdminAbstract

Remarks

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns Admin

Methods

AbstractaddApplication

Parameters

Returns void | PromiseLike<void>

Throws

Throws

AbstractaddObject

Parameters

Returns void | PromiseLike<void>

Throws

Throws

AbstractaddObjectWithType

Parameters

Returns void | PromiseLike<void>

Throws

Throws

dispatch

Parameters

Returns OutgoingResponse | PromiseLike<OutgoingResponse>

Remarks

AbstractenableServer

Parameters

Returns void | PromiseLike<void>

Throws

Throws

Throws

AbstractgetAdapterInfo

Parameters

Returns AdapterInfo[] | PromiseLike<AdapterInfo[]>

Throws

AbstractgetAllAdapterIds

Parameters

Returns string[] | PromiseLike<string[]>

AbstractgetAllApplicationNames

Parameters

Returns string[] | PromiseLike<string[]>

AbstractgetAllNodeNames

Parameters

Returns string[] | PromiseLike<string[]>

AbstractgetAllObjectInfos

Parameters

Returns ObjectInfo[] | PromiseLike<ObjectInfo[]>

AbstractgetAllRegistryNames

Parameters

Returns string[] | PromiseLike<string[]>

AbstractgetAllServerIds

Parameters

Returns string[] | PromiseLike<string[]>

AbstractgetApplicationInfo

Parameters

Returns ApplicationInfo | PromiseLike<ApplicationInfo>

Throws

AbstractgetDefaultApplicationDescriptor

Parameters

Returns ApplicationDescriptor | PromiseLike<ApplicationDescriptor>

Throws

AbstractgetNodeAdmin

Parameters

Returns ObjectPrx | PromiseLike<ObjectPrx>

Throws

Throws

AbstractgetNodeHostname

Parameters

Returns string | PromiseLike<string>

Throws

Throws

AbstractgetNodeInfo

Parameters

Returns NodeInfo | PromiseLike<NodeInfo>

Throws

Throws

Class Admin`Abstract`

`Abstract`addApplication

`Abstract`addObject

`Abstract`addObjectWithType

`Abstract`enableServer

`Abstract`getAdapterInfo

`Abstract`getAllAdapterIds

`Abstract`getAllApplicationNames

`Abstract`getAllNodeNames

`Abstract`getAllObjectInfos

`Abstract`getAllRegistryNames

`Abstract`getAllServerIds

`Abstract`getApplicationInfo

`Abstract`getDefaultApplicationDescriptor

`Abstract`getNodeAdmin

`Abstract`getNodeHostname

`Abstract`getNodeInfo

`Abstract`getNodeLoad

`Abstract`getNodeProcessorSocketCount

`Abstract`getObjectInfo

`Abstract`getObjectInfosByType

`Abstract`getRegistryAdmin

`Abstract`getRegistryInfo

`Abstract`getServerAdmin

`Abstract`getServerAdminCategory

`Abstract`getServerInfo

`Abstract`getServerPid

`Abstract`getServerState

`Abstract`instantiateServer

`Abstract`isServerEnabled