Descriptor.ice

Go to the documentation of this file.

// **********************************************************************
//
// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************

#pragma once

[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
[["cpp:include:IceGrid/Config.h"]]

#include <Ice/Identity.ice>
#include <Ice/BuiltinSequences.ice>

["objc:prefix:ICEGRID"]
module IceGrid
{

dictionary<string, string> StringStringDict;

struct PropertyDescriptor
{
    string name;

    string value;
};

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

["cpp:comparable"]
struct PropertySetDescriptor
{
    Ice::StringSeq references;

    PropertyDescriptorSeq properties;
};

dictionary<string, PropertySetDescriptor> PropertySetDescriptorDict;

struct ObjectDescriptor
{
    Ice::Identity id;

    string type;

    string proxyOptions;
};

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

["cpp:comparable"]
struct AdapterDescriptor
{
    string name;

    string description;

    string id;

    string replicaGroupId;

    string priority;

    bool registerProcess;

    bool serverLifetime;

    ObjectDescriptorSeq objects;

    ObjectDescriptorSeq allocatables;
};

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

["cpp:comparable"]
struct DbEnvDescriptor
{
    string name;

    string description;

    string dbHome;

    PropertyDescriptorSeq properties;
};

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

class CommunicatorDescriptor
{
    AdapterDescriptorSeq adapters;

    PropertySetDescriptor propertySet;

    DbEnvDescriptorSeq dbEnvs;

    Ice::StringSeq logs;

    string description;
};

["cpp:comparable"]
struct DistributionDescriptor
{
    string icepatch;

    ["java:type:java.util.LinkedList<String>"] Ice::StringSeq directories;
};

class ServerDescriptor extends CommunicatorDescriptor
{
    string id;

    string exe;

    string iceVersion;

    string pwd;

    ["java:type:java.util.LinkedList<String>"] Ice::StringSeq options;

    ["java:type:java.util.LinkedList<String>"] Ice::StringSeq envs;

    string activation;

    string activationTimeout;

    string deactivationTimeout;

    bool applicationDistrib;

    DistributionDescriptor distrib;

    bool allocatable;

    string user;
};

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

class ServiceDescriptor extends CommunicatorDescriptor
{
    string name;

    string entry;
};

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

["cpp:comparable"]
struct ServerInstanceDescriptor
{
    string template;

    StringStringDict parameterValues;

    PropertySetDescriptor propertySet;

    PropertySetDescriptorDict servicePropertySets;
};

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

struct TemplateDescriptor
{
    CommunicatorDescriptor descriptor;

    ["java:type:java.util.LinkedList<String>"] Ice::StringSeq parameters;

    StringStringDict parameterDefaults;
};

dictionary<string, TemplateDescriptor> TemplateDescriptorDict;

struct ServiceInstanceDescriptor
{
    string template;

    StringStringDict parameterValues;

    ServiceDescriptor descriptor;

    PropertySetDescriptor propertySet;
};

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

class IceBoxDescriptor extends ServerDescriptor
{
    ServiceInstanceDescriptorSeq services;
};

struct NodeDescriptor
{
    ["java:type:java.util.TreeMap<String, String>"] StringStringDict variables;

    ServerInstanceDescriptorSeq serverInstances;

    ServerDescriptorSeq servers;

    string loadFactor;

    string description;

    PropertySetDescriptorDict propertySets;
};

dictionary<string, NodeDescriptor> NodeDescriptorDict;

class LoadBalancingPolicy
{
    string nReplicas;
};

class RandomLoadBalancingPolicy extends LoadBalancingPolicy
{
};

class OrderedLoadBalancingPolicy extends LoadBalancingPolicy
{
};

class RoundRobinLoadBalancingPolicy extends LoadBalancingPolicy
{
};

class AdaptiveLoadBalancingPolicy extends LoadBalancingPolicy
{
    string loadSample;
};

struct ReplicaGroupDescriptor
{
    string id;

    LoadBalancingPolicy loadBalancing;

    string proxyOptions;

    ObjectDescriptorSeq objects;

    string description;

    string filter;
};

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

struct ApplicationDescriptor
{
    string name;

    ["java:type:java.util.TreeMap<String, String>"] StringStringDict variables;

    ReplicaGroupDescriptorSeq replicaGroups;

    TemplateDescriptorDict serverTemplates;

    TemplateDescriptorDict serviceTemplates;

    NodeDescriptorDict nodes;

    DistributionDescriptor distrib;

    string description;

    PropertySetDescriptorDict propertySets;
};

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

class BoxedString
{
    string value;
};

struct NodeUpdateDescriptor
{
    string name;

    BoxedString description;

    ["java:type:java.util.TreeMap<String, String>"] StringStringDict variables;

    Ice::StringSeq removeVariables;

    PropertySetDescriptorDict propertySets;

    Ice::StringSeq removePropertySets;

    ServerInstanceDescriptorSeq serverInstances;

    ServerDescriptorSeq servers;

    Ice::StringSeq removeServers;

    BoxedString loadFactor;
};

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

class BoxedDistributionDescriptor
{
    DistributionDescriptor value;
};

struct ApplicationUpdateDescriptor
{
    string name;

    BoxedString description;

    BoxedDistributionDescriptor distrib;

    ["java:type:java.util.TreeMap<String, String>"] StringStringDict variables;

    Ice::StringSeq removeVariables;

    PropertySetDescriptorDict propertySets;

    Ice::StringSeq removePropertySets;

    ReplicaGroupDescriptorSeq replicaGroups;

    Ice::StringSeq removeReplicaGroups;

    TemplateDescriptorDict serverTemplates;

    Ice::StringSeq removeServerTemplates;

    TemplateDescriptorDict serviceTemplates;

    Ice::StringSeq removeServiceTemplates;

    NodeUpdateDescriptorSeq nodes;

    Ice::StringSeq removeNodes;
};

};