001/* IOR.java --
002   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.IOP;
040
041import org.omg.CORBA.portable.IDLEntity;
042
043import java.io.Serializable;
044
045/**
046 * <p>
047 * The object IOR contains sufficient information for finding local or
048 * remote CORBA object. It also contains additional data like the object
049 * native and supported char sets, URLs to download the required additional
050 * java classes and so on. IOR can define multiple alternative addresses
051 * for the same object or indicate that the object is equal to null.
052 * </p><p>
053 * The IOR is a standard structure, transferred when sending an object with
054 * {@link org.omg.CORBA.portable.OutputStream#write_Object(org.omg.CORBA.Object)}
055 * and receiving with {@link org.omg.CORBA.portable.InputStream#read_Object()}.
056 * The stringified object references, managed by 
057 * {@link org.omg.CORBA.ORB#string_to_object}
058 * and {@link org.omg.CORBA.ORB#object_to_string} are also IORs, where the
059 * initially binary data are encoded as strings using hexadecimal notation.
060 * </p><p>
061 * The IOR is represented as the object repository id, followed
062 * by the sequence of the abstract profiles, each having the integer type
063 * identifier and the followed array of binary data. The empty sequence of
064 * profiles represents a null object, written, for instance, in response
065 * to the call of write_Object(null).
066 *
067 * @specnote GNU Classpath has its own implementation of IOR machinery at
068 * gnu.CORBA.IOR. The reason is that IORs are required from 1.2, but only
069 * in 1.4 the associated classes appear in the public API.
070 */
071public final class IOR
072  implements IDLEntity, Serializable
073{
074  /**
075   * Use serialVersionUID (v1.4) for interoperability.
076   */
077  private static final long serialVersionUID = 1901439890645554948L;
078
079  /**
080   * The profiles, associated with this IOR reference. The possible
081   * profiles are listed in {@link TaggedProfile} description.
082   */
083  public TaggedProfile[] profiles;
084
085  /**
086   * The object repository Id.
087   */
088  public String type_id;
089
090  /**
091   * Create an unitialised instance of IOR profile.
092   *
093   * @specnote The profile will be intialised to the IOR, representing
094   * a null object.
095   */
096  public IOR()
097  {
098    type_id = "";
099    profiles = new TaggedProfile[ 0 ];
100  }
101
102  /**
103   * Create the IOR, initialised with the passed data.
104   *
105   * @param _type_id the repository id for this IOR object.
106   * @param _profiles the array of profiles for this IOR.
107   */
108  public IOR(String _type_id, TaggedProfile[] _profiles)
109  {
110    type_id = _type_id;
111    profiles = _profiles;
112  }
113}