epan/dissectors/corba-idl/parlay/cm.idl

   1 //Source file: cm.idl
   2 //Date:  11 October 2004
   3 //Connectivity Manager Interfaces and Data Types for ETSI ES 203 915-10 V1.1.1, DES/TISPAN-01005-10-OSA, Parlay 5.0
   4
   5 #ifndef __CM_DEFINED
   6 #define __CM_DEFINED
   7
   8
   9 #include "osa.idl"
  10
  11 module org {
  12
  13         module csapi {
  14
  15                 module cm {
  16                         interface IpVPrN ;
  17                         interface IpEnterpriseNetwork ;
  18                         interface IpConnectivityManager ;
  19                         interface IpQoSTemplate ;
  20                         interface IpEnterpriseNetworkSite ;
  21
  22
  23                         enum TpTrafficDirection {
  24
  25                                 UNIDIRECTIONAL,
  26                                 BIDIRECTIONAL
  27                         };
  28
  29
  30                         enum TpTagValue {
  31
  32                                 PROVIDER_SPECIFIED,
  33                                 OPERATOR_SPECIFIED,
  34                                 UNSPECIFIED
  35                         };
  36
  37                         enum TpSiteOrSap {
  38
  39                                 SITE,
  40                                 SAP
  41                         };
  42
  43
  44                         struct TpNameDescrpTagTimePeriod {
  45                                 TpInt32 duration;
  46                         };
  47
  48
  49                         struct TpNameDescrpTagTimeOfDay {
  50                                 TpString name;
  51                                 TpString description;
  52                                 TpTagValue tag;
  53                                 TpString value;
  54                         };
  55
  56                         struct TpNameDescrpTagString {
  57                                 TpString name;
  58                                 TpString description;
  59                                 TpTagValue tag;
  60                                 TpString value;
  61                         };
  62
  63
  64                         struct TpNameDescrpTagMonth {
  65                                 TpString name;
  66                                 TpString description;
  67                                 TpTagValue tag;
  68                                 TpInt32 value;
  69                         };
  70
  71                         struct TpNameDescrpTagInt {
  72                                 TpString name;
  73                                 TpString description;
  74                                 TpTagValue tag;
  75                                 TpInt32 value;
  76                         };
  77
  78                         struct TpNameDescrpTagDir {
  79                                 TpString name;
  80                                 TpString description;
  81                                 TpTagValue tag;
  82                                 TpTrafficDirection value;
  83                         };
  84
  85
  86                         struct TpNameDescrpTagDayOfWeek {
  87                                 TpString name;
  88                                 TpString description;
  89                                 TpTagValue tag;
  90                                 TpInt32 value;
  91                         };
  92
  93
  94                         struct TpNameDescrpTagDateTime {
  95                                 TpString name;
  96                                 TpString description;
  97                                 TpTagValue tag;
  98                                 TpDateAndTime value;
  99                         };
 100
 101
 102                         struct TpLossDescriptor {
 103                                 TpNameDescrpTagInt meanLoss;
 104                                 TpNameDescrpTagInt measurementPeriod;
 105                                 TpNameDescrpTagInt maxLoss;
 106                                 TpNameDescrpTagInt minLoss;
 107                                 TpNameDescrpTagInt lossPriority;
 108                                 TpNameDescrpTagString description;
 109                         };
 110
 111
 112                         struct TpLoadDescriptor {
 113                                 TpNameDescrpTagInt meanBandwidth;
 114                                 TpNameDescrpTagInt measurementInterval;
 115                                 TpNameDescrpTagInt maxBandwidth;
 116                                 TpNameDescrpTagInt minBandwidth;
 117                                 TpNameDescrpTagInt bandwidthShare;
 118                                 TpNameDescrpTagInt bandwidthWeight;
 119                                 TpNameDescrpTagInt burstSize;
 120                                 TpNameDescrpTagString description;
 121                         };
 122
 123
 124                         struct TpJitterDescriptor {
 125                                 TpNameDescrpTagInt meanJitter;
 126                                 TpNameDescrpTagInt measurementPeriod;
 127                                 TpNameDescrpTagInt maxJitter;
 128                                 TpNameDescrpTagInt minJitter;
 129                                 TpNameDescrpTagInt jitterPriority;
 130                                 TpNameDescrpTagString description;
 131                         };
 132
 133                         enum TpIPVersion {
 134
 135                                 VERSION_UNKNOWN,
 136                                 VERSION_IPV4,
 137                                 VERSION_IPV6
 138                         };
 139
 140                         enum TpIPv4AddType {
 141
 142                                 IPV4_ADD_CLASS_A,
 143                                 IPV4_ADD_CLASS_B,
 144                                 IPV4_ADD_CLASS_C,
 145                                 IPV4_ADD_CLASS_D,
 146                                 IPV4_ADD_CLASS_E
 147                         };
 148
 149                         struct TpEndpoint {
 150                                 TpSiteOrSap type;
 151                                 TpString id;
 152                         };
 153
 154
 155                         struct TpDelayDescriptor {
 156                                 TpNameDescrpTagInt meanDelay;
 157                                 TpNameDescrpTagInt measurementPeriod;
 158                                 TpNameDescrpTagInt maxDelay;
 159                                 TpNameDescrpTagInt minDelay;
 160                                 TpNameDescrpTagInt delayPriority;
 161                                 TpNameDescrpTagString description;
 162                         };
 163
 164
 165                         enum TpAction {
 166
 167                                 DROP,
 168                                 TRANSMIT,
 169                                 RESHAPE,
 170                                 REMARK
 171                         };
 172
 173
 174                         struct TpNameDescrpTagExcessLoadAction {
 175                                 TpString name;
 176                                 TpString description;
 177                                 TpTagValue tag;
 178                                 TpAction value;
 179                         };
 180
 181
 182                         exception P_UNKNOWN_VPRP_ID {
 183                                 TpString ExtraInformation;
 184                         };
 185
 186
 187                         exception P_UNKNOWN_SLA_ID {
 188                                 TpString ExtraInformation;
 189                         };
 190
 191
 192                         exception P_UNKNOWN_STATUS {
 193                                 TpString ExtraInformation;
 194                         };
 195
 196
 197                         exception P_UNKNOWN_QOS_INFO {
 198                                 TpString ExtraInformation;
 199                         };
 200
 201
 202                         exception P_UNKNOWN_VALIDITY_INFO {
 203                                 TpString ExtraInformation;
 204                         };
 205
 206
 207                         exception P_UNKNOWN_PIPEQOSINFO {
 208                                 TpString ExtraInformation;
 209                         };
 210
 211
 212                         exception P_UNKNOWN_DSCODEPOINT {
 213                                 TpString ExtraInformation;
 214                         };
 215
 216
 217                         exception P_ILLEGAL_VPRPID {
 218                                 TpString ExtraInformation;
 219                         };
 220
 221
 222                         exception P_ILLEGAL_REF_VALUE {
 223                                 TpString ExtraInformation;
 224                         };
 225
 226
 227                         exception P_UNKNOWN_INTERFACE {
 228                                 TpString ExtraInformation;
 229                         };
 230
 231
 232                         exception P_CANT_DELETE_VPRP {
 233                                 TpString ExtraInformation;
 234                         };
 235
 236
 237                         exception P_UNKNOWN_TEMPLATES {
 238                                 TpString ExtraInformation;
 239                         };
 240
 241
 242                         exception P_UNKNOWN_MENU {
 243                                 TpString ExtraInformation;
 244                         };
 245
 246
 247                         exception P_UNKNOWN_ENTERPRISE_NETWORK {
 248                                 TpString ExtraInformation;
 249                         };
 250
 251
 252                         exception P_UNKNOWN_TEMPLATE_TYPE {
 253                                 TpString ExtraInformation;
 254                         };
 255
 256
 257                         exception P_UNKNOWN_DESCRIPTION {
 258                                 TpString ExtraInformation;
 259                         };
 260
 261
 262                         exception P_ILLEGAL_SLA_ID {
 263                                 TpString ExtraInformation;
 264                         };
 265
 266
 267                         exception P_ILLEGAL_TAG {
 268                                 TpString ExtraInformation;
 269                         };
 270
 271
 272                         exception P_ILLEGAL_VALUE {
 273                                 TpString ExtraInformation;
 274                         };
 275
 276
 277                         exception P_ILLEGAL_COMBINATION {
 278                                 TpString ExtraInformation;
 279                         };
 280
 281
 282                         exception P_UNKNOWN_SITES {
 283                                 TpString ExtraInformation;
 284                         };
 285
 286
 287                         exception P_UNKNOWN_VPRN {
 288                                 TpString ExtraInformation;
 289                         };
 290
 291
 292                         exception P_ILLEGAL_SITE_ID {
 293                                 TpString ExtraInformation;
 294                         };
 295
 296
 297                         exception P_UNKNOWN_SITE_ID {
 298                                 TpString ExtraInformation;
 299                         };
 300
 301
 302                         exception P_UNKNOWN_SAPS {
 303                                 TpString ExtraInformation;
 304                         };
 305
 306
 307                         exception P_UNKNOWN_SITE_LOCATION {
 308                                 TpString ExtraInformation;
 309                         };
 310
 311
 312                         exception P_UNKNOWN_SITE_DESCRIPTION {
 313                                 TpString ExtraInformation;
 314                         };
 315
 316
 317                         exception P_UNKNOWN_IPSUBNET {
 318                                 TpString ExtraInformation;
 319                         };
 320
 321
 322                         exception P_UNKNOWN_SAP {
 323                                 TpString ExtraInformation;
 324                         };
 325
 326
 327                         exception P_UNKNOWN_VPRP {
 328                                 TpString ExtraInformation;
 329                         };
 330
 331
 332                         enum TpVprpStatus {
 333
 334                                 ACTIVE,
 335                                 PENDING,
 336                                 DISALLOWED
 337                         };
 338
 339
 340                         struct TpValidityInfo {
 341                                 TpNameDescrpTagDateTime validFrom;
 342                                 TpNameDescrpTagTimePeriod validPeriod;
 343                                 TpNameDescrpTagTimeOfDay validDailyFrom;
 344                                 TpNameDescrpTagTimePeriod validDailyPeriod;
 345                                 TpNameDescrpTagDayOfWeek validDayOfWeek;
 346                                 TpNameDescrpTagMonth validMonth;
 347                                 TpNameDescrpTagString description;
 348                         };
 349
 350                         struct TpProvisionedQoSInfo {
 351                                 TpDelayDescriptor delayDescriptor;
 352                                 TpLossDescriptor lossDescriptor;
 353                                 TpJitterDescriptor jitterDescriptor;
 354                                 TpNameDescrpTagExcessLoadAction excessLoadAction;
 355                                 TpNameDescrpTagString description;
 356                         };
 357
 358                         struct TpPipeQoSInfo {
 359                                 TpNameDescrpTagDir directionality;
 360                                 TpEndpoint serviceOrigin;
 361                                 TpEndpoint serviceDestination;
 362                                 TpLoadDescriptor forwardLoad;
 363                                 TpLoadDescriptor reverseLoad;
 364                                 TpNameDescrpTagString description;
 365                         };
 366
 367
 368                         struct TpDsCodepoint {
 369                                 TpString match;
 370                                 TpString mask;
 371                         };
 372
 373
 374                         struct TpIPSubnet {
 375                                 TpString subnetNumber;
 376                                 TpString subnetMask;
 377                                 TpIPv4AddType addressType;
 378                                 TpIPVersion IPVersionSupport;
 379                         };
 380
 381
 382                         interface IpVPrP : IpService {
 383
 384                                 TpString getVPrPID ()
 385                                         raises (TpCommonExceptions,P_UNKNOWN_VPRP_ID);
 386
 387                                 TpString getSlaID ()
 388                                         raises (TpCommonExceptions,P_UNKNOWN_SLA_ID);
 389
 390                                 TpVprpStatus getStatus ()
 391                                         raises (TpCommonExceptions,P_UNKNOWN_STATUS);
 392
 393                                 TpProvisionedQoSInfo getProvisionedQoSInfo ()
 394                                         raises (TpCommonExceptions,P_UNKNOWN_QOS_INFO);
 395
 396                                 TpValidityInfo getValidityInfo ()
 397                                         raises (TpCommonExceptions,P_UNKNOWN_VALIDITY_INFO);
 398
 399                                 TpPipeQoSInfo getPipeQoSInfo ()
 400                                         raises (TpCommonExceptions,P_UNKNOWN_PIPEQOSINFO);
 401
 402                                 TpDsCodepoint getDsCodepoint ()
 403                                         raises (TpCommonExceptions,P_UNKNOWN_DSCODEPOINT);
 404
 405                         };
 406
 407
 408                         interface IpVPrN : IpService {
 409
 410                                 TpStringList getVPrPList ()
 411                                         raises (TpCommonExceptions,P_UNKNOWN_VPRP);
 412
 413                                 IpInterface getVPrP (
 414                                         in TpString vPrPID
 415                                         )
 416                                         raises (TpCommonExceptions,P_ILLEGAL_VPRPID,P_UNKNOWN_VPRP_ID);
 417
 418                                 IpInterface createVPrP (
 419                                         in IpInterface templateRef
 420                                         )
 421                                         raises (TpCommonExceptions,P_ILLEGAL_REF_VALUE,P_UNKNOWN_INTERFACE);
 422
 423                                 void deleteVPrP (
 424                                         in TpString vPrPID
 425                                         )
 426                                         raises (TpCommonExceptions,P_CANT_DELETE_VPRP,P_UNKNOWN_VPRP_ID);
 427
 428                         };
 429
 430
 431                         interface IpQoSMenu : IpService {
 432
 433                                 IpInterface getTemplate (
 434                                         in TpString templateType
 435                                         )
 436                                         raises (TpCommonExceptions);
 437
 438                                 TpStringList getTemplateList ()
 439                                         raises (TpCommonExceptions,P_UNKNOWN_TEMPLATES);
 440
 441                         };
 442
 443
 444                         interface IpConnectivityManager : IpService {
 445
 446                                 IpInterface getQoSMenu ()
 447                                         raises (TpCommonExceptions,P_UNKNOWN_MENU);
 448
 449                                 IpInterface getEnterpriseNetwork ()
 450                                         raises (TpCommonExceptions,P_UNKNOWN_ENTERPRISE_NETWORK);
 451
 452                         };
 453
 454
 455                         interface IpQoSTemplate : IpService {
 456
 457                                 TpString getTemplateType ()
 458                                         raises (TpCommonExceptions,P_UNKNOWN_TEMPLATE_TYPE);
 459
 460                                 TpString getDescription ()
 461                                         raises (TpCommonExceptions,P_UNKNOWN_DESCRIPTION);
 462
 463                                 void setSlaID (
 464                                         in TpString slaID
 465                                         )
 466                                         raises (TpCommonExceptions,P_ILLEGAL_SLA_ID);
 467
 468                                 TpPipeQoSInfo getPipeQoSInfo ()
 469                                         raises (TpCommonExceptions,P_UNKNOWN_PIPEQOSINFO);
 470
 471                                 void setPipeQoSInfo (
 472                                         in TpPipeQoSInfo pipeQoSInfo
 473                                         )
 474                                         raises (TpCommonExceptions,P_ILLEGAL_TAG,P_ILLEGAL_VALUE,P_ILLEGAL_COMBINATION);
 475
 476                                 TpValidityInfo getValidityInfo ()
 477                                         raises (TpCommonExceptions,P_UNKNOWN_VALIDITY_INFO);
 478
 479                                 void setValidityInfo (
 480                                         in TpValidityInfo validityInfo
 481                                         )
 482                                         raises (TpCommonExceptions,P_ILLEGAL_TAG,P_ILLEGAL_VALUE,P_ILLEGAL_COMBINATION);
 483
 484                                 void setProvisionedQoSInfo (
 485                                         in TpProvisionedQoSInfo provisionedQoSInfo
 486                                         )
 487                                         raises (TpCommonExceptions,P_ILLEGAL_TAG,P_ILLEGAL_VALUE,P_ILLEGAL_COMBINATION);
 488
 489                                 TpProvisionedQoSInfo getProvisionedQoSInfo ()
 490                                         raises (TpCommonExceptions,P_UNKNOWN_QOS_INFO);
 491
 492                                 TpDsCodepoint getDsCodepoint ()
 493                                         raises (TpCommonExceptions,P_UNKNOWN_DSCODEPOINT);
 494
 495                         };
 496
 497
 498                         interface IpEnterpriseNetwork : IpService {
 499
 500                                 TpStringList getSiteList ()
 501                                         raises (TpCommonExceptions,P_UNKNOWN_SITES);
 502
 503                                 IpInterface getVPrN ()
 504                                         raises (TpCommonExceptions,P_UNKNOWN_VPRN);
 505
 506                                 IpInterface getSite (
 507                                         in TpString siteID
 508                                         )
 509                                         raises (TpCommonExceptions,P_ILLEGAL_SITE_ID,P_UNKNOWN_SITE_ID);
 510
 511                         };
 512
 513
 514                         interface IpEnterpriseNetworkSite : IpEnterpriseNetwork {
 515
 516                                 TpStringList getSAPList ()
 517                                         raises (TpCommonExceptions,P_UNKNOWN_SAPS);
 518
 519                                 TpString getSiteID ()
 520                                         raises (TpCommonExceptions,P_UNKNOWN_SITE_ID);
 521
 522                                 TpString getSiteLocation ()
 523                                         raises (TpCommonExceptions,P_UNKNOWN_SITE_LOCATION);
 524
 525                                 TpString getSiteDescription ()
 526                                         raises (TpCommonExceptions,P_UNKNOWN_SITE_DESCRIPTION);
 527
 528                                 TpIPSubnet getIPSubnet ()
 529                                         raises (TpCommonExceptions,P_UNKNOWN_IPSUBNET);
 530
 531                                 TpIPSubnet getSAPIPSubnet (
 532                                         in TpString sapID
 533                                         )
 534                                         raises (TpCommonExceptions,P_ILLEGAL_SITE_ID,P_UNKNOWN_SAP,P_UNKNOWN_IPSUBNET);
 535
 536                         };
 537
 538                 };
 539
 540         };
 541
 542 };
 543
 544 #endif