Ice Reference Documentation
<<< Previous | Slice Documentation | Next >>>

# `IceGrid`

## Overview

    module IceGrid

IceGrid is a server activation and deployment tool. IceGrid, simplifies the complex task of deploying applications in a heterogeneous computer network.

### Class Index

AdaptiveLoadBalancingPolicy

  Adaptive load balancing policy.

BoxedDistributionDescriptor

  A "boxed" distribution descriptor.

BoxedString

  A "boxed" string.

CommunicatorDescriptor

  A communicator descriptor.

IceBoxDescriptor

  An IceBox server descriptor.

LoadBalancingPolicy

  A base class for load balancing policies.

RandomLoadBalancingPolicy

  Random load balancing policy.

RoundRobinLoadBalancingPolicy

  Round robin load balancing policy.

ServerDescriptor

  An Ice server descriptor.

ServiceDescriptor

  An IceBox service descriptor.

### Interface Index

Admin

  The IceGrid administrative interface.

AdminSession

  An admin session object used by administrative clients to view, update and receive observer updates from the IceGrid registry.

FileParser

  The icegridadmin command line tool provides a `FileParser` object to transform XML files into `ApplicationDescriptor` objects (structs).

NodeObserver

  The node observer interface.

Query

  The IceGrid query interface.

Registry

  The IceGrid registry provides a registry object to allow clients or administrative clients to create sessions directly with the registry.

RegistryObserver

  The registry observer interface.

Session

  A session object is used by IceGrid clients to allocate and release objects.

UserAccountMapper

  A user account mapper object is used by IceGrid nodes to map session identifiers to user accounts.

### Exception Index

`AccessDeniedException`

  This exception is raised if an operation can't be performed because the registry lock wasn't acquired or is already acquired by a session.

`AdapterNotExistException`

  This exception is raised if an adapter does not exist.

`AllocationException`

  This exception is raised if the allocation of an object failed.

`AllocationTimeoutException`

  This exception is raised if the request to allocate an object times out.

`ApplicationNotExistException`

  This exception is raised if an application does not exist.

`BadSignalException`

  This exception is raised if an unknown signal was sent to to a server.

`DeploymentException`

  An exception for deployment failure errors.

`NodeNotExistException`

  This exception is raised if a node does not exist.

`NodeUnreachableException`

  This exception is raised if a node could not be reached.

`ObjectExistsException`

  This exception is raised if an object already exists.

`ObjectNotRegisteredException`

  This exception is raised if an object is not registered.

`ParseException`

  This exception is raised if an error occurs during parsing.

`PatchException`

  This exception is raised if a patch failed.

`PermissionDeniedException`

  This exception is raised if a client is denied the ability to create a session with IceGrid.

`ServerNotExistException`

  This exception is raised if a server does not exist.

`ServerStartException`

  This exception is raised if a server failed to start.

`ServerStopException`

  This exception is raised if a server failed to stop.

`UserAccountNotFoundException`

  This exception is raised if a user account for a given session identifier can't be found.

### Struct Index

`AdapterDescriptor`

  An Ice object adapter descriptor.

`AdapterDynamicInfo`

  Dynamic information about the state of an adapter.

`AdapterInfo`

  Information about an adapter registered with the IceGrid registry.

`ApplicationDescriptor`

  An application descriptor.

`ApplicationUpdateDescriptor`

  An application update descriptor to describe the updates to apply to a deployed application.

`DbEnvDescriptor`

  A Freeze database environment descriptor.

`DistributionDescriptor`

  A distribution descriptor defines an IcePatch2 server and the directories to retrieve from the patch server.

`LoadInfo`

  Information about the load of a node.

`NodeDescriptor`

  A node descriptor.

`NodeDynamicInfo`

  Dynamic information about the state of a node.

`NodeInfo`

  Information about an IceGrid node.

`NodeUpdateDescriptor`

  A node update descriptor to describe the updates to apply to a node of a deployed application.

`ObjectDescriptor`

  An Ice object descriptor.

`ObjectInfo`

  Information about an Ice object.

`PropertyDescriptor`

  Property descriptor.

`PropertySetDescriptor`

  A property set descriptor.

`ReplicaGroupDescriptor`

  A replica group descriptor.

`ServerDynamicInfo`

  Dynamic information about the state of a server.

`ServerInfo`

  Information about a server managed by an IceGrid node.

`ServerInstanceDescriptor`

  A server template instance descriptor.

`ServiceInstanceDescriptor`

  A service template instance descriptor.

`TemplateDescriptor`

  A template descriptor for server or service templates.

### Sequence Index

AdapterDescriptorSeq

  A sequence of adapter descriptors.

AdapterDynamicInfoSeq

  A sequence of adapter dynamic information structures.

AdapterInfoSeq

  A sequence of adapter information structures.

ApplicationDescriptorSeq

  A sequence of application descriptors.

DbEnvDescriptorSeq

  A sequence of database environment descriptors.

NodeDynamicInfoSeq

  A sequence of node dynamic information structures.

NodeUpdateDescriptorSeq

  A sequence of node update descriptors.

ObjectDescriptorSeq

  A sequence of object descriptors.

ObjectInfoSeq

  A sequence of object information structures.

PropertyDescriptorSeq

  A sequence of property descriptors.

ReplicaGroupDescriptorSeq

  A sequence of replica groups.

ServerDescriptorSeq

  A sequence of server descriptors.

ServerDynamicInfoSeq

  A sequence of server dynamic information structures.

ServerInstanceDescriptorSeq

  A sequence of server instance descriptors.

ServiceDescriptorSeq

  A sequence of service descriptors.

ServiceInstanceDescriptorSeq

  A sequence of service instance descriptors.

### Dictionary Index

NodeDescriptorDict

  Mapping of node name to node descriptor.

PropertySetDescriptorDict

  A mapping of property set name to property set descriptor.

StringObjectProxyDict

  A dictionary of proxies.

StringStringDict

  A mapping of string to string.

TemplateDescriptorDict

  A mapping of template identifier to template descriptor.

### Enum Index

LoadSample

  Determines which load sampling interval to use.

ServerState

  An enumeration representing the state of the server.

## `AdapterDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<AdapterDescriptor> AdapterDescriptorSeq;

A sequence of adapter descriptors.

### Used By

CommunicatorDescriptor::adapters

## `AdapterDynamicInfoSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<AdapterDynamicInfo> AdapterDynamicInfoSeq;

A sequence of adapter dynamic information structures.

### Used By

NodeDynamicInfo::adapters

## `AdapterInfoSeq`

    sequence<AdapterInfo> AdapterInfoSeq;

A sequence of adapter information structures.

### Used By

`Admin::getAdapterInfo`, `RegistryObserver::init`

## `ApplicationDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ApplicationDescriptor> ApplicationDescriptorSeq;

A sequence of application descriptors.

### Used By

`RegistryObserver::init`

## `DbEnvDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<DbEnvDescriptor> DbEnvDescriptorSeq;

A sequence of database environment descriptors.

### Used By

CommunicatorDescriptor::dbEnvs

## `NodeDynamicInfoSeq`

    sequence<NodeDynamicInfo> NodeDynamicInfoSeq;

A sequence of node dynamic information structures.

### Used By

`NodeObserver::init`

## `NodeUpdateDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<NodeUpdateDescriptor> NodeUpdateDescriptorSeq;

A sequence of node update descriptors.

### Used By

ApplicationUpdateDescriptor::nodes

## `ObjectDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ObjectDescriptor> ObjectDescriptorSeq;

A sequence of object descriptors.

### Used By

AdapterDescriptor::allocatables, AdapterDescriptor::objects, ReplicaGroupDescriptor::objects

## `ObjectInfoSeq`

    sequence<ObjectInfo> ObjectInfoSeq;

A sequence of object information structures.

### Used By

`Admin::getAllObjectInfos`, `Admin::getObjectInfosByType`, `RegistryObserver::init`

## `PropertyDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<PropertyDescriptor> PropertyDescriptorSeq;

A sequence of property descriptors.

### Used By

DbEnvDescriptor::properties, PropertySetDescriptor::properties

## `ReplicaGroupDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ReplicaGroupDescriptor> ReplicaGroupDescriptorSeq;

A sequence of replica groups.

### Used By

ApplicationDescriptor::replicaGroups, ApplicationUpdateDescriptor::replicaGroups

## `ServerDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ServerDescriptor> ServerDescriptorSeq;

A sequence of server descriptors.

### Used By

NodeDescriptor::servers, NodeUpdateDescriptor::servers

## `ServerDynamicInfoSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ServerDynamicInfo> ServerDynamicInfoSeq;

A sequence of server dynamic information structures.

### Used By

NodeDynamicInfo::servers

## `ServerInstanceDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ServerInstanceDescriptor> ServerInstanceDescriptorSeq;

A sequence of server instance descriptors.

### Used By

NodeDescriptor::serverInstances, NodeUpdateDescriptor::serverInstances

## `ServiceDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ServiceDescriptor> ServiceDescriptorSeq;

A sequence of service descriptors.

## `ServiceInstanceDescriptorSeq`

    [ "java:type:{java.util.LinkedList}" ]
    sequence<ServiceInstanceDescriptor> ServiceInstanceDescriptorSeq;

A sequence of service instance descriptors.

### Used By

IceBoxDescriptor::services

## `NodeDescriptorDict`

    dictionary<string, NodeDescriptor> NodeDescriptorDict;

Mapping of node name to node descriptor.

### Used By

ApplicationDescriptor::nodes

## `PropertySetDescriptorDict`

    dictionary<string, PropertySetDescriptor> PropertySetDescriptorDict;

A mapping of property set name to property set descriptor.

### Used By

ApplicationDescriptor::propertySets, ApplicationUpdateDescriptor::propertySets, NodeDescriptor::propertySets, NodeUpdateDescriptor::propertySets

## `StringObjectProxyDict`

    dictionary<string, Object*> StringObjectProxyDict;

A dictionary of proxies.

## `StringStringDict`

    dictionary<string, string> StringStringDict;

A mapping of string to string.

### Used By

ApplicationDescriptor::variables, ApplicationUpdateDescriptor::variables, NodeDescriptor::variables, NodeUpdateDescriptor::variables, ServerInstanceDescriptor::parameterValues, ServiceInstanceDescriptor::parameterValues, TemplateDescriptor::parameterDefaults

## `TemplateDescriptorDict`

    dictionary<string, TemplateDescriptor> TemplateDescriptorDict;

A mapping of template identifier to template descriptor.

### Used By

ApplicationDescriptor::serverTemplates, ApplicationDescriptor::serviceTemplates, ApplicationUpdateDescriptor::serverTemplates, ApplicationUpdateDescriptor::serviceTemplates

<<< Previous | Home | Next >>>
`Glacier2::StringSet` | Up | `IceGrid::AccessDeniedException`