gnu.CORBA

Class IOR


public class IOR
extends Object

The implementaton of the Interoperable Object Reference (IOR). IOR can be compared with the Internet address for a web page, it provides means to locate the CORBA service on the web. IOR contains the host address, port number, the object identifier (key) inside the server, the communication protocol version, supported charsets and so on. Ths class provides method for encoding and decoding the IOR information from/to the stringified references, usually returned by object_to_string().
See Also:
org.mog.CORBA.Object.object_to_string(Object forObject), string_to_object(String IOR)

Nested Class Summary

static class
IOR.CodeSets_profile
The code sets tagged component, normally part of the Internet profile.
class
IOR.Internet_profile
The internet profile.

Field Summary

boolean
Big_Endian
True if the profile was encoded using the Big Endian or the encoding is not known.
static int
FAILED
The standard minor code, indicating that the string to object converstio has failed due non specific reasons.
String
Id
The object repository Id.
IOR.Internet_profile
Internet
The internet profile of this IOR.
byte[]
key
The object key.

Constructor Summary

IOR()
Create an empty instance, initialising the code sets to default values.

Method Summary

void
_read(AbstractCdrInput c)
Read the IOR from the provided input stream.
void
_read_no_endian(AbstractCdrInput c)
Read the IOR from the provided input stream, not reading the endian data at the beginning of the stream.
void
_write(AbstractCdrOutput out)
Write this IOR record to the provided CDR stream.
void
_write_no_endian(AbstractCdrOutput out)
Write this IOR record to the provided CDR stream.
void
add_ior_component(TaggedComponent tagged_component)
Adds a service-specific component to the IOR profile.
void
add_ior_component_to_profile(TaggedComponent tagged_component, int profile_id)
Adds a service-specific component to the IOR profile.
boolean
equals(Object x)
Checks for equality.
int
hashCode()
Get the hashcode of this IOR.
static IOR
parse(String stringified_reference)
Parse the provided stringifed reference.
String
toString()
Returns a human readable string representation of this IOR object.
String
toStringFormatted()
Returns a multiline formatted human readable string representation of this IOR object.
String
toStringifiedReference()
Returs a stringified reference.
static void
write_null(AbstractCdrOutput out)
Write a null value to the CDR output stream.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

Big_Endian

public boolean Big_Endian
True if the profile was encoded using the Big Endian or the encoding is not known. false if it was encoded using the Little Endian.

FAILED

public static final int FAILED
The standard minor code, indicating that the string to object converstio has failed due non specific reasons.
Field Value:
10

Id

public String Id
The object repository Id.

Internet

public IOR.Internet_profile Internet
The internet profile of this IOR.

key

public byte[] key
The object key.

Constructor Details

IOR

public IOR()
Create an empty instance, initialising the code sets to default values.

Method Details

_read

public void _read(AbstractCdrInput c)
            throws IOException,
                   BAD_PARAM
Read the IOR from the provided input stream.
Parameters:
c - a stream to read from.
Throws:
IOException - if the stream throws it.

_read_no_endian

public void _read_no_endian(AbstractCdrInput c)
            throws IOException,
                   BAD_PARAM
Read the IOR from the provided input stream, not reading the endian data at the beginning of the stream. The IOR is thansferred in this form in write_Object(org.omg.CORBA.Object). If the stream contains a null value, the Id and Internet fields become equal to null. Otherwise Id contains some string (possibly empty). Id is checked for null in AbstractCdrInput that then returns null instead of object.
Parameters:
c - a stream to read from.
Throws:
IOException - if the stream throws it.

_write

public void _write(AbstractCdrOutput out)
Write this IOR record to the provided CDR stream. This procedure writes the zero (Big Endian) marker first.

_write_no_endian

public void _write_no_endian(AbstractCdrOutput out)
Write this IOR record to the provided CDR stream. The procedure writed data in Big Endian, but does NOT add any endian marker to the beginning.

add_ior_component

public void add_ior_component(TaggedComponent tagged_component)
Adds a service-specific component to the IOR profile. The specified component will be included in all profiles, present in the IOR.
Parameters:
tagged_component - a tagged component being added.

add_ior_component_to_profile

public void add_ior_component_to_profile(TaggedComponent tagged_component,
                                         int profile_id)
Adds a service-specific component to the IOR profile.
Parameters:
tagged_component - a tagged component being added.
profile_id - the IOR profile to that the component must be added. The 0 value (TAG_INTERNET_IOP.value) adds to the Internet profile where host and port are stored by default.

equals

public boolean equals(Object x)
Checks for equality.
Overrides:
equals in interface Object

hashCode

public int hashCode()
Get the hashcode of this IOR.
Overrides:
hashCode in interface Object

parse

public static IOR parse(String stringified_reference)
            throws BAD_PARAM
Parse the provided stringifed reference.
Parameters:
stringified_reference - in the form of IOR:nnnnnn.....
Returns:
the parsed IOR

toString

public String toString()
Returns a human readable string representation of this IOR object.
Overrides:
toString in interface Object

toStringFormatted

public String toStringFormatted()
Returns a multiline formatted human readable string representation of this IOR object.

toStringifiedReference

public String toStringifiedReference()
Returs a stringified reference.
Returns:
a newly constructed stringified reference.

write_null

public static void write_null(AbstractCdrOutput out)
Write a null value to the CDR output stream. The null value is written as defined in OMG specification (zero length string, followed by an empty set of profiles).

IOR.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.