udkapi/com/sun/star/corba/giop/giop.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #include <com/sun/star/corba/iop/iop.idl>
  28 module com { module sun { module star { module corba { module giop
  29 {
  30     /**
  31       @deprecated
  32      */
  33 published   struct Version
  34     {
  35         byte major;
  36         byte minor;
  37     };
  38
  39     /**
  40       @deprecated
  41      */
  42 published enum MsgType_1_1
  43     {
  44         Request, Reply, CancelRequest,
  45         LocateRequest, LocateReply,
  46         CloseConnection, MessageError,
  47         Fragment // GIOP 1.1 addition
  48     };
  49
  50
  51     /**
  52       @deprecated
  53      */
  54 published   struct MessageHeader_1_0
  55     {// Renamed from MessageHeader
  56         byte magic_1;
  57         byte magic_2;
  58         byte magic_3;
  59         byte magic_4;
  60         Version GIOP_version;
  61         boolean byte_order;
  62         byte message_type;
  63         unsigned long message_size;
  64     };
  65
  66     /**
  67       @deprecated
  68      */
  69 published   struct MessageHeader_1_1
  70     {
  71         byte magic_1;
  72         byte magic_2;
  73         byte magic_3;
  74         byte magic_4;
  75         Version GIOP_version;
  76         byte flags; // GIOP 1.1 change
  77         byte message_type;
  78         unsigned long message_size;
  79     };
  80
  81     /**
  82       @deprecated
  83      */
  84 published typedef MessageHeader_1_1 MessageHeader_1_2;
  85
  86     /**
  87       @deprecated
  88      */
  89 published   struct RequestHeader_1_0
  90     {
  91         com::sun::star::corba::iop::ServiceContextList service_context;
  92         unsigned long request_id;
  93         boolean response_expected;
  94         sequence < byte > object_key;
  95         CorbaString8 operation;
  96         sequence < byte > requesting_principal;
  97     };
  98
  99     /**
 100       @deprecated
 101      */
 102 published   struct RequestHeader_1_1
 103     {
 104         com::sun::star::corba::iop::ServiceContextList service_context;
 105         unsigned long request_id;
 106         boolean response_expected;
 107         byte reserved_1;
 108         byte reserved_2;
 109         byte reserved_3; // Added in GIOP 1.1
 110         sequence <byte> object_key;
 111         CorbaString8 operation;
 112         sequence <byte> requesting_principal; // binary compatible
 113     };
 114
 115     /**
 116       @deprecated
 117      */
 118 published   struct IORAddressingInfo
 119     {
 120         unsigned long selected_profile_index;
 121         com::sun::star::corba::iop::IOR ior;
 122     };
 123
 124     /**
 125       @deprecated
 126      */
 127 published constants TargetAddressGroup
 128         {
 129             const short KeyAddr = 0;
 130             const short ProfileAddr = 1;
 131             const short ReferenceAddr = 2;
 132         };
 133
 134     /**
 135       @deprecated
 136      */
 137 published struct TargetAddress : CorbaUnion
 138     {
 139         short nDiscriminator;
 140         sequence < byte > object_key;  // KeyAddr
 141         com::sun::star::corba::iop::TaggedProfile profile;    // ProfileAddr
 142         IORAddressingInfo ior;         // ReferenceAddr
 143     };
 144
 145
 146     /**
 147       @deprecated
 148      */
 149 published   struct RequestHeader_1_2
 150     {
 151         unsigned long request_id;
 152         byte response_flags;
 153         byte reserved_1;
 154         byte reserved_2;
 155         byte reserved_3;
 156         TargetAddress target;
 157         CorbaString8 operation;
 158 // Principal not in GIOP 1.2
 159         com::sun::star::corba::iop::ServiceContextList service_context; // 1.2 change
 160     };
 161
 162
 163     /**
 164       @deprecated
 165      */
 166 published enum ReplyStatusType_1_2
 167     {
 168         NO_EXCEPTION,
 169         USER_EXCEPTION,
 170         SYSTEM_EXCEPTION,
 171         LOCATION_FORWARD,
 172         LOCATION_FORWARD_PERM, // new value for 1.2
 173         NEEDS_ADDRESSING_MODE // new value for 1.2
 174     };
 175
 176
 177     /**
 178       @deprecated
 179      */
 180 published   struct ReplyHeader_1_2
 181     {
 182         unsigned long request_id;
 183         ReplyStatusType_1_2 reply_status;
 184         com::sun::star::corba::iop::ServiceContextList service_context; // 1.2 change
 185     };
 186
 187     /**
 188       @deprecated
 189      */
 190 published   struct SystemExceptionReplyBody
 191     {
 192         CorbaString8 exception_id;
 193         unsigned long minor_code_value;
 194         unsigned long completion_status;
 195     };
 196
 197     /**
 198       @deprecated
 199      */
 200 published   struct CancelRequestHeader
 201     {
 202         unsigned long request_id;
 203     };
 204
 205     /**
 206       @deprecated
 207      */
 208 published   struct LocateRequestHeader_1_0
 209     {
 210 // Renamed LocationRequestHeader
 211         unsigned long request_id;
 212         sequence <byte> object_key;
 213     };
 214
 215     /**
 216       @deprecated
 217      */
 218 published typedef LocateRequestHeader_1_0 LocateRequestHeader_1_1;
 219
 220     /**
 221       @deprecated
 222      */
 223 published enum LocateStatusType_1_2 {
 224         UNKNOWN_OBJECT,
 225         OBJECT_HERE,
 226         OBJECT_FORWARD,
 227         OBJECT_FORWARD_PERM, // new value for GIOP 1.2
 228         LOC_SYSTEM_EXCEPTION, // new value for GIOP 1.2
 229         LOC_NEEDS_ADDRESSING_MODE // new value for GIOP 1.2
 230     };
 231
 232     /**
 233       @deprecated
 234      */
 235 published   struct LocateReplyHeader_1_2
 236     {
 237         unsigned long request_id;
 238         LocateStatusType_1_2 locate_status;
 239     };
 240
 241     /**
 242       @deprecated
 243      */
 244 published   struct FragmentHeader_1_2
 245     {
 246         unsigned long request_id;
 247     };
 248
 249
 250 }; }; }; }; };
 251