Source code: org/omg/IOP/IOR.java
1 /* IOR.java --
2 Copyright (C) 2005 Free Software Foundation, Inc.
3
4 This file is part of GNU Classpath.
5
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
20
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
25
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
37
38
39 package org.omg.IOP;
40
41 import org.omg.CORBA.portable.IDLEntity;
42
43 import java.io.Serializable;
44
45 /**
46 * <p>
47 * The object IOR contains sufficient information for finding local or
48 * remote CORBA object. It also contains additional data like the object
49 * native and supported char sets, URLs to download the required additional
50 * java classes and so on. IOR can define multiple alternative addresses
51 * for the same object or indicate that the object is equal to null.
52 * </p><p>
53 * The IOR is a standard structure, transferred when sending an object with
54 * {@link org.omg.CORBA.portable.OutputStream#write_Object} and receiving with
55 * {@link org.omg.CORBA.portable.InputStream#read_Object}. The stringified
56 * object references, managed by {@link org.omg.CORBA.ORB#string_to_object}
57 * and {@link org.omg.CORBA.ORB#object_to_string} are also IORs, where the
58 * initially binary data are encoded as strings using hexadecimal notation.
59 * </p><p>
60 * The IOR is represented as the object repository id, followed
61 * by the sequence of the abstract profiles, each having the integer type
62 * identifier and the followed array of binary data. The empty sequence of
63 * profiles represents a null object, written, for instance, in response
64 * to the call of write_Object(null).
65 *
66 * @specnote GNU Classpath has its own implementation of IOR machinery at
67 * gnu.CORBA.IOR. The reason is that IORs are required from 1.2, but only
68 * in 1.4 the associated classes appear in the public API.
69 */
70 public class IOR
71 implements IDLEntity, Serializable
72 {
73 /**
74 * Use serialVersionUID (v1.4) for interoperability.
75 */
76 private static final long serialVersionUID = 1901439890645554948L;
77
78 /**
79 * The profiles, associated with this IOR reference. The possible
80 * profiles are listed in {@link TaggedProfile} description.
81 */
82 public TaggedProfile[] profiles;
83
84 /**
85 * The object repository Id.
86 */
87 public String type_id;
88
89 /**
90 * Create an unitialised instance of IOR profile.
91 *
92 * @specnote The profile will be intialised to the IOR, representing
93 * a null object.
94 */
95 public IOR()
96 {
97 type_id = "";
98 profiles = new TaggedProfile[ 0 ];
99 }
100
101 /**
102 * Create the IOR, initialised with the passed data.
103 *
104 * @param _type_id the repository id for this IOR object.
105 * @param _profiles the array of profiles for this IOR.
106 */
107 public IOR(String _type_id, TaggedProfile[] _profiles)
108 {
109 type_id = _type_id;
110 profiles = _profiles;
111 }
112 }