home | O'Reilly's CD bookshelfs | FreeBSD | Linux | Cisco | Cisco Exam  

Book Home Java Enterprise in a Nutshell Search this book
PreviousPart 3: API Quick ReferenceNext

Chapter 30. The org.omg.CORBA Package

The org.omg.CORBA package contains the bulk of the Java classes in the Java IDL API. The classes in this package represent the mapping between Java and the CORBA module defined in IDL in the CORBA standard. That means this package includes the bulk of the interfaces, constants, etc., that make up CORBA. Key classes in this package are the ORB class, which is a Java implementation of an ORB, and the Object interface, which serves as the root class for all CORBA objects. Figure 30-1 shows the hierarchy of interfaces defined in org.omg.CORBA, Figure 30-2 shows the class hierarchy, and Figure 30-1 shows the exceptions.

figure

Figure 30-1. The interfaces in the org.omg.CORBA package

figure

Figure 30-2. The classes in the org.omg.CORBA package

figure

Figure 30-3. The exceptions in the org.omg.CORBA package

AnyJava 1.2
org.omg.CORBAserializable

A wrapper for any IDL type, whether user-defined or a basic type. You can access the TypeCode for the contents of an Any object using the type() methods. Use the extract_XXX() and insert_XXX() methods to get to the data itself.

An Any object is the value in a NamedValue object. Any objects are used often in the Dynamic Invocation Interface, to compose arguments to method requests.

public abstract class Any implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public Any ();
// Public Instance Methods
public abstract org.omg.CORBA.portable.InputStream create_input_stream ();
public abstract org.omg.CORBA.portable.OutputStream create_output_stream ();
public abstract boolean equal (Any a);
public abstract Any extract_any () throws BAD_OPERATION;
public abstract boolean extract_boolean () throws BAD_OPERATION;
public abstract char extract_char () throws BAD_OPERATION;
public abstract double extract_double () throws BAD_OPERATION;
public java.math.BigDecimal extract_fixed ();
public abstract float extract_float () throws BAD_OPERATION;
public abstract int extract_long () throws BAD_OPERATION;
public abstract long extract_longlong () throws BAD_OPERATION;
public abstract org.omg.CORBA.Object extract_Object () throws BAD_OPERATION;
public abstract byte extract_octet () throws BAD_OPERATION;
public abstract short extract_short () throws BAD_OPERATION;
public abstract String extract_string () throws BAD_OPERATION;
public abstract TypeCode extract_TypeCode () throws BAD_OPERATION;
public abstract int extract_ulong () throws BAD_OPERATION;
public abstract long extract_ulonglong () throws BAD_OPERATION;
public abstract short extract_ushort () throws BAD_OPERATION;
public Serializable extract_Value () throws BAD_OPERATION;
public abstract char extract_wchar () throws BAD_OPERATION;
public abstract String extract_wstring () throws BAD_OPERATION;
public abstract void insert_any (Any a);
public abstract void insert_boolean (boolean b);
public abstract void insert_char (char c) throws DATA_CONVERSION;
public abstract void insert_double (double d);
public void insert_fixed (java.math.BigDecimal value);
public void insert_fixed (java.math.BigDecimal value, TypeCode type);
public abstract void insert_float (float f);
public abstract void insert_long (int l);
public abstract void insert_longlong (long l);
public abstract void insert_Object (org.omg.CORBA.Object o);
public abstract void insert_Object (org.omg.CORBA.Object o, TypeCode t) throws BAD_OPERATION;
public abstract void insert_octet (byte b);
public abstract void insert_short (short s);
public abstract void insert_Streamable (org.omg.CORBA.portable.Streamable s);
public abstract void insert_string (String s) throws DATA_CONVERSION, MARSHAL;
public abstract void insert_TypeCode (TypeCode t);
public abstract void insert_ulong (int l);
public abstract void insert_ulonglong (long l);
public abstract void insert_ushort (short s);
public void insert_Value (Serializable v);
public void insert_Value (Serializable v, TypeCode t) throws MARSHAL;
public abstract void insert_wchar (char c);
public abstract void insert_wstring (String s) throws MARSHAL;
public abstract void read_value (org.omg.CORBA.portable.InputStream is, TypeCode t) throws MARSHAL;
public abstract TypeCode type ();
public abstract void type (TypeCode t);
public abstract void write_value (org.omg.CORBA.portable.OutputStream os);
// Deprecated Public Methods
#public abstract org.omg.CORBA.Principal extract_Principal () throws BAD_OPERATION;
#public abstract void insert_Principal (org.omg.CORBA.Principal p);
}

Hierarchy: Object-->Any(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: Too many methods to list.

Returned By: Any.extract_any(), DynAny.{get_any(), to_any()}, DynArray.get_elements(), DynSequence.get_elements(), NamedValue.value(), ORB.create_any(), Request.{add_in_arg(), add_inout_arg(), add_named_in_arg(), add_named_inout_arg(), add_named_out_arg(), add_out_arg(), return_value()}, TypeCode.member_label(), org.omg.CORBA.portable.InputStream.read_any()

Type Of: AnyHolder.value, NameValuePair.value, UnionMember.label, UnknownUserException.except

AnyHolderJava 1.2
org.omg.CORBA

The holder class for Any objects. The AnyHolder class is used primarily to wrap out and inout arguments to methods when composing Dynamic Invocation Interface requests.

public final class AnyHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public AnyHolder ();
public AnyHolder (Any initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public Any value ;
}

Hierarchy: Object-->AnyHolder(org.omg.CORBA.portable.Streamable)

ARG_INJava 1.2
org.omg.CORBA

This interface defines a value constant that is used to specify an input method argument when creating a named value with the ORB.create_named_value() method. The last argument to this method is an integer flag that indicates the argument mode for the named value as it is used in a dynamic method invocation. The integer flag can be either ARG_IN.value, ARG_OUT.value, or ARG_INOUT.value, to indicate what type of method argument the named value represents. Here's an example that assumes you have a reference to an ORB named myOrb and an Any object named myAny that holds the argument value:

org.omg.CORBA.NamedValue inArg = 
   myOrb.create_named_value("MethodArg1", myAny, org.omg.CORBA.ARG_IN.value);

The inArg named value can now be used in a Dynamic Invocation Interface call to a method that has an in argument named MethodArg1. See also ARG_INOUT and ARG_OUT.

public abstract interface ARG_IN {
// Public Constants
public static final int value ; =1
}
ARG_INOUTJava 1.2
org.omg.CORBA

This interface defines a single constant used with the ORB.create_named_value() method. See ARG_IN for details.

public abstract interface ARG_INOUT {
// Public Constants
public static final int value ; =3
}
ARG_OUTJava 1.2
org.omg.CORBA

This interface defines a single constant used with the ORB.create_named_value() method. See ARG_IN for details.

public abstract interface ARG_OUT {
// Public Constants
public static final int value ; =2
}
BAD_CONTEXTJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a context object cannot be processed.

public final class BAD_CONTEXT extends org.omg.CORBA.SystemException {
// Public Constructors
public BAD_CONTEXT ();
public BAD_CONTEXT (String s);
public BAD_CONTEXT (int minor, CompletionStatus completed);
public BAD_CONTEXT (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->BAD_CONTEXT

BAD_INV_ORDERJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when methods are called out of order. For example, if you call the arguments() method on a ServerRequest object, then try to reset the arguments by calling the method again, a BAD_INV_ORDER exception is thrown.

public final class BAD_INV_ORDER extends org.omg.CORBA.SystemException {
// Public Constructors
public BAD_INV_ORDER ();
public BAD_INV_ORDER (String s);
public BAD_INV_ORDER (int minor, CompletionStatus completed);
public BAD_INV_ORDER (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->BAD_INV_ORDER

BAD_OPERATIONJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid method is invoked. If, for example, you call an extract_XXX() method on an Any object for a type it does not contain, a BAD_OPERATION is thrown.

public final class BAD_OPERATION extends org.omg.CORBA.SystemException {
// Public Constructors
public BAD_OPERATION ();
public BAD_OPERATION (String s);
public BAD_OPERATION (int minor, CompletionStatus completed);
public BAD_OPERATION (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->BAD_OPERATION

Thrown By: Any.{extract_any(), extract_boolean(), extract_char(), extract_double(), extract_float(), extract_long(), extract_longlong(), extract_Object(), extract_octet(), extract_Principal(), extract_short(), extract_string(), extract_TypeCode(), extract_ulong(), extract_ulonglong(), extract_ushort(), extract_Value(), extract_wchar(), extract_wstring(), insert_Object()}

BAD_PARAMJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid argument is passed into a remote method. This exception defines a single error code value for the SystemException.minor data member:

Minor Code

Meaning

1

A null value was passed into a remote method.
public final class BAD_PARAM extends org.omg.CORBA.SystemException {
// Public Constructors
public BAD_PARAM ();
public BAD_PARAM (String s);
public BAD_PARAM (int minor, CompletionStatus completed);
public BAD_PARAM (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->BAD_PARAM

Thrown By: CompletionStatus.from_int(), DefinitionKind.from_int(), SetOverrideType.from_int(), TCKind.from_int(), org.omg.CosNaming.BindingIteratorHelper.narrow(), org.omg.CosNaming.BindingType.from_int(), org.omg.CosNaming.NamingContextHelper.narrow(), NotFoundReason.from_int()

BAD_TYPECODEJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid TypeCode is specified.

public final class BAD_TYPECODE extends org.omg.CORBA.SystemException {
// Public Constructors
public BAD_TYPECODE ();
public BAD_TYPECODE (String s);
public BAD_TYPECODE (int minor, CompletionStatus completed);
public BAD_TYPECODE (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->BAD_TYPECODE

BooleanHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java boolean values.

public final class BooleanHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public BooleanHolder ();
public BooleanHolder (boolean initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public boolean value ;
}

Hierarchy: Object-->BooleanHolder(org.omg.CORBA.portable.Streamable)

BoundsJava 1.2
org.omg.CORBAserializable checked

An exception thrown when a value that falls out of the valid bounds is passed into a method (e.g., when an index passed into a list object is greater than the size of the list).

public final class Bounds extends UserException {
// Public Constructors
public Bounds ();
public Bounds (String reason);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->UserException(org.omg.CORBA.portable.IDLEntity(Serializable))-->org.omg.CORBA.Bounds

Thrown By: ContextList.{item(), remove()}, ExceptionList.{item(), remove()}, NVList.{item(), remove()}, TypeCode.member_visibility()

ByteHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java byte values.

public final class ByteHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public ByteHolder ();
public ByteHolder (byte initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public byte value ;
}

Hierarchy: Object-->ByteHolder(org.omg.CORBA.portable.Streamable)

CharHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java char values.

public final class CharHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public CharHolder ();
public CharHolder (char initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public char value ;
}

Hierarchy: Object-->CharHolder(org.omg.CORBA.portable.Streamable)

COMM_FAILUREJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a communications failure occurs during a remote operation. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning
1

Unable to connect to the required remote ORB.
2

A write to a socket failed, either because the socket has been closed by the remote peer or because the socket connection has been aborted.
3

A write to a socket failed because the connection was closed on this side of the socket.
6

Multiple attempts to connect to the remote server have failed.
public final class COMM_FAILURE extends org.omg.CORBA.SystemException {
// Public Constructors
public COMM_FAILURE ();
public COMM_FAILURE (String s);
public COMM_FAILURE (int minor, CompletionStatus completed);
public COMM_FAILURE (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->COMM_FAILURE

CompletionStatusJava 1.2
org.omg.CORBAserializable

When an org.omg.CORBA.SystemException is thrown, it contains a CompletionStatus object that indicates whether the method invocation was completed before the exception was encountered. CompletionStatus has three static instances, COMPLETED_YES, COMPLETED_MAYBE, and COMPLETED_NO, and three static int members, _COMPLETED_YES, _COMPLETED_MAYBE and _COMPLETED_NO. When you receive a CompletionStatus, you can either compare it to one of the static instances or compare its value (queried using the value() method) to one of the static int values.

public class CompletionStatus implements org.omg.CORBA.portable.IDLEntity {
// Protected Constructors
protected CompletionStatus (int _value);
// Public Constants
public static final int _COMPLETED_MAYBE ; =2
public static final int _COMPLETED_NO ; =1
public static final int _COMPLETED_YES ; =0
public static final CompletionStatus COMPLETED_MAYBE ;
public static final CompletionStatus COMPLETED_NO ;
public static final CompletionStatus COMPLETED_YES ;
// Public Class Methods
public static CompletionStatus from_int (int i) throws BAD_PARAM;
// Public Instance Methods
public int value ();
}

Hierarchy: Object-->CompletionStatus(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: Too many methods to list.

Returned By: CompletionStatus.from_int()

Type Of: CompletionStatus.{COMPLETED_MAYBE, COMPLETED_NO, COMPLETED_YES}, org.omg.CORBA.SystemException.completed

ContextJava 1.2
org.omg.CORBA

A Context object contains a list of properties, stored as NamedValue objects, that is passed along with a method request to indicate properties of the client context. Every ORB has a default context, accessed using the ORB.get_default_context() method. Contexts can be linked in a hierarchy of contexts. If a search for a property is made on a Context object, and the search within the object fails, the search is continued in the parent Context, and so on until the root context is reached. You can create a new child of a Context using its create_child() method. Other methods on the Context class let you get, set, and delete values from the Context.

public abstract class Context {
// Public Constructors
public Context ();
// Public Instance Methods
public abstract String context_name ();
public abstract org.omg.CORBA.Context create_child (String child_ctx_name);
public abstract void delete_values (String propname);
public abstract NVList get_values (String start_scope, int op_flags, String pattern);
public abstract org.omg.CORBA.Context parent ();
public abstract void set_one_value (String propname, Any propvalue);
public abstract void set_values (NVList values);
}

Passed To: org.omg.CORBA.Object._create_request(), Request.ctx(), org.omg.CORBA.portable.Delegate.create_request(), org.omg.CORBA.portable.ObjectImpl._create_request(), org.omg.CORBA.portable.OutputStream.write_Context()

Returned By: org.omg.CORBA.Context.{create_child(), parent()}, ORB.get_default_context(), Request.ctx(), ServerRequest.ctx(), org.omg.CORBA.portable.InputStream.read_Context()

ContextListJava 1.2
org.omg.CORBA

A ContextList is a list of context property names only (i.e., a list of String objects). A ContextList along with an NVList that contains NamedValue objects represents the relevant subset of a Context that is passed along with a remote method call.

public abstract class ContextList {
// Public Constructors
public ContextList ();
// Public Instance Methods
public abstract void add (String ctx);
public abstract int count ();
public abstract String item (int index) throws org.omg.CORBA.Bounds;
public abstract void remove (int index) throws org.omg.CORBA.Bounds;
}

Passed To: org.omg.CORBA.Object._create_request(), org.omg.CORBA.portable.Delegate.create_request(), org.omg.CORBA.portable.ObjectImpl._create_request(), org.omg.CORBA.portable.OutputStream.write_Context()

Returned By: ORB.create_context_list(), Request.contexts()

CTX_RESTRICT_SCOPEJava 1.2
org.omg.CORBA

This interface contains a static value member that can be used as a flag to the search routine accessible through the Context.get_values() method. Using CTX_RESTRICT_SCOPE.value as the flag to this method indicates that the search for context values should be restricted to the scope specified in the first method argument, or to the context object that invokes the method, if the scope is null. For example, this call to the search method:

Context ctx = ... // get context somehow
NVList myVals = ctx.get_values(null, org.omg.CORBA.CTX_RESTRICT_SCOPE.value, "username");

searches the context represented by the context object for values named "username".

public abstract interface CTX_RESTRICT_SCOPE {
// Public Constants
public static final int value ; =15
}
CurrentJava 1.2
org.omg.CORBA

The Current interface represents an optional feature provided by CORBA that allows the ORB and CORBA services to export information about the thread in which they are running. Sun's Java IDL does not use this feature. If an ORB or service provider decides to provide this information, it should create a concrete subclass of this interface and make it available through the ORB's resolve_initial_references() method.

public abstract interface Current extends org.omg.CORBA.Object {
}

Hierarchy: (Current(org.omg.CORBA.Object))

Returned By: ORB.get_current()

DATA_CONVERSIONJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when the ORB fails to convert some piece of data, such as during the conversion of a stringified object reference. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning
1

A bad hexadecimal character was found while converting a stringified object reference back to an object reference.
2

The byte length of a stringified object reference is odd, when it must be even.
3

The "IOR:" preface is missing from the stringified object reference passed into string_to_object().
4

The resolve_initial_references() method failed because the location (host and port number) of the remote ORB specified is invalid or unspecified, or the remote server doesn't support the Java IDL bootstrap protocol.
public final class DATA_CONVERSION extends org.omg.CORBA.SystemException {
// Public Constructors
public DATA_CONVERSION ();
public DATA_CONVERSION (String s);
public DATA_CONVERSION (int minor, CompletionStatus completed);
public DATA_CONVERSION (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->DATA_CONVERSION

Thrown By: Any.{insert_char(), insert_string()}

DefinitionKindJava 1.2
org.omg.CORBAserializable

Used by an IRObject to indicate what type of repository object it represents (e.g., method, attribute). To determine the type of an IRObject, either compare the value member of DefinitionKind to the static int members of this class or compare the DefinitionKind object itself to the static instances defined in this class.

public class DefinitionKind implements org.omg.CORBA.portable.IDLEntity {
// Protected Constructors
protected DefinitionKind (int _value);
// Public Constants
public static final int _dk_Alias ; =9
public static final int _dk_all ; =1
public static final int _dk_Array ; =16
public static final int _dk_Attribute ; =2
public static final int _dk_Constant ; =3
public static final int _dk_Enum ; =12
public static final int _dk_Exception ; =4
public static final int _dk_Fixed ; =19
public static final int _dk_Interface ; =5
public static final int _dk_Module ; =6
public static final int _dk_Native ; =23
public static final int _dk_none ; =0
public static final int _dk_Operation ; =7
public static final int _dk_Primitive ; =13
public static final int _dk_Repository ; =17
public static final int _dk_Sequence ; =15
public static final int _dk_String ; =14
public static final int _dk_Struct ; =10
public static final int _dk_Typedef ; =8
public static final int _dk_Union ; =11
public static final int _dk_Value ; =20
public static final int _dk_ValueBox ; =21
public static final int _dk_ValueMember ; =22
public static final int _dk_Wstring ; =18
public static final DefinitionKind dk_Alias ;
public static final DefinitionKind dk_all ;
public static final DefinitionKind dk_Array ;
public static final DefinitionKind dk_Attribute ;
public static final DefinitionKind dk_Constant ;
public static final DefinitionKind dk_Enum ;
public static final DefinitionKind dk_Exception ;
public static final DefinitionKind dk_Fixed ;
public static final DefinitionKind dk_Interface ;
public static final DefinitionKind dk_Module ;
public static final DefinitionKind dk_Native ;
public static final DefinitionKind dk_none ;
public static final DefinitionKind dk_Operation ;
public static final DefinitionKind dk_Primitive ;
public static final DefinitionKind dk_Repository ;
public static final DefinitionKind dk_Sequence ;
public static final DefinitionKind dk_String ;
public static final DefinitionKind dk_Struct ;
public static final DefinitionKind dk_Typedef ;
public static final DefinitionKind dk_Union ;
public static final DefinitionKind dk_Value ;
public static final DefinitionKind dk_ValueBox ;
public static final DefinitionKind dk_ValueMember ;
public static final DefinitionKind dk_Wstring ;
// Public Class Methods
public static DefinitionKind from_int (int i) throws BAD_PARAM;
// Public Instance Methods
public int value ();
}

Hierarchy: Object-->DefinitionKind(org.omg.CORBA.portable.IDLEntity(Serializable))

Returned By: DefinitionKind.from_int(), IRObject.def_kind()

Type Of: DefinitionKind.{dk_Alias, dk_all, dk_Array, dk_Attribute, dk_Constant, dk_Enum, dk_Exception, dk_Fixed, dk_Interface, dk_Module, dk_Native, dk_none, dk_Operation, dk_Primitive, dk_Repository, dk_Sequence, dk_String, dk_Struct, dk_Typedef, dk_Union, dk_Value, dk_ValueBox, dk_ValueMember, dk_Wstring}

DomainManagerJava 1.2
org.omg.CORBA

The DomainManager interface represents an object that manages a group of objects (a domain) under a common set of access policies. A set of policies control access to certain operations over the objects in a given domain. You can access the DomainManager for an org.omg.CORBA.Object by using its _get_domain_managers() method, which returns an array of DomainManager objects, one for each domain of the Object. DomainManagerobjects can be hierarchical, in that a domain can contain other DomainManager objects. Since the DomainManager is an Object, you can use its _get_domain_managers() method to traverse the manager hierarchy.

DomainManager defines a single method, get_domain_policy(), that allows you to get the policy of a given type for the objects in the domain. The policy is represented by a Policy object. The type of policy is indicated with an integer identifier, where the possible values are application-specific. The CORBA Security service, for example, defines its own set of policy types. If the policy type you pass into get_domain_policy() is not supported by the ORB, or if the domain doesn't define that type of policy, an BAD_PARAM system exception is thrown.

The DomainManager interface, and the corresponding methods on the org.omg.CORBA.Object interface, are really just a placeholder for future support for object domains in the CORBA standard. There are currently no interfaces defined for adding objects and policies to domains, for example. The OMG intends to provide this in a management facility specification in the future.

public abstract interface DomainManager extends org.omg.CORBA.Object {
// Public Instance Methods
public abstract org.omg.CORBA.Policy get_domain_policy (int policy_type);
}

Hierarchy: (DomainManager(org.omg.CORBA.Object))

Returned By: org.omg.CORBA.Object._get_domain_managers(), org.omg.CORBA.portable.Delegate.get_domain_managers(), org.omg.CORBA.portable.ObjectImpl._get_domain_managers()

DoubleHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java double values.

public final class DoubleHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public DoubleHolder ();
public DoubleHolder (double initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public double value ;
}

Hierarchy: Object-->DoubleHolder(org.omg.CORBA.portable.Streamable)

DynamicImplementationJava 1.2
org.omg.CORBA

The abstract base class for servant object implementations in the Dynamic Skeleton Interface. Derived servant classes must implement the invoke() method, which is called by the ORB to handle requests on the object represented by the servant.

public abstract class DynamicImplementation extends org.omg.CORBA.portable.ObjectImpl {
// Public Constructors
public DynamicImplementation ();
// Public Instance Methods
public abstract void invoke (ServerRequest request);
}

Hierarchy: Object-->org.omg.CORBA.portable.ObjectImpl(org.omg.CORBA.Object)-->DynamicImplementation

Subclasses: org.omg.CosNaming._BindingIteratorImplBase, org.omg.CosNaming._NamingContextImplBase

DynAnyJava 1.2
org.omg.CORBA

The DynAny interface forms the core of CORBA's facility for the dynamic introspection of Any values for which the implementation class is not available. This facility has similar goals as Java's built-in introspection facilities, but CORBA provides it as IDL interfaces so that it can be used no matter what implementation language is chosen. The CORBA facility allows services and objects to determine the type and contents of a value passed into a method, without having access to its implementation interface. The service or object can wrap an incoming Any value with DynAny to probe its properties and structure.

DynAny objects should not be exported outside the processes in which they are created. If you attempt to create a stringified reference to a DynAny object using the ORB.object_to_string() method, a MARSHAL exception is thrown.

The DynAny interface provides a series of get_XXX() and insert_XXX() methods that can be used to access or modify the contents of the Any value if it is an IDL basic type. The TypeCode for the contents can also be accessed, using the type() method. If the Any value holds a complex data type, such as a struct, the next(), seek(), rewind(), and current_component() methods on the DynAny interface can iterate through the data members of the contents.

There are various subtypes of DynAny that provide access to the components of specific IDL complex types, such as structs, enums, and unions. These subtypes and basic DynAny objects can be created using the create_dyn_XXX() methods available on the ORB interface.

public abstract interface DynAny extends org.omg.CORBA.Object {
// Public Instance Methods
public abstract void assign (DynAny dyn_any) throws org.omg.CORBA.DynAnyPackage.Invalid;
public abstract DynAny copy ();
public abstract DynAny current_component ();
public abstract void destroy ();
public abstract void from_any (Any value) throws org.omg.CORBA.DynAnyPackage.Invalid;
public abstract Any get_any () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract boolean get_boolean () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract char get_char () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract double get_double () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract float get_float () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract int get_long () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract long get_longlong () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract byte get_octet () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract org.omg.CORBA.Object get_reference () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract short get_short () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract String get_string () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract TypeCode get_typecode () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract int get_ulong () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract long get_ulonglong () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract short get_ushort () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract Serializable get_val () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract char get_wchar () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract String get_wstring () throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
public abstract void insert_any (Any value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_boolean (boolean value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_char (char value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_double (double value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_float (float value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_long (int value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_longlong (long value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_octet (byte value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_reference (org.omg.CORBA.Object value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_short (short value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_string (String value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_typecode (TypeCode value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_ulong (int value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_ulonglong (long value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_ushort (short value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_val (Serializable value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_wchar (char value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract void insert_wstring (String value) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
public abstract boolean next ();
public abstract void rewind ();
public abstract boolean seek (int index);
public abstract Any to_any () throws org.omg.CORBA.DynAnyPackage.Invalid;
public abstract TypeCode type ();
}

Hierarchy: (DynAny(org.omg.CORBA.Object))

Implementations: DynArray, DynEnum, DynFixed, DynSequence, DynStruct, DynUnion, DynValue

Passed To: DynAny.assign()

Returned By: DynAny.{copy(), current_component()}, DynUnion.{discriminator(), member()}, ORB.{create_basic_dyn_any(), create_dyn_any()}

DynArrayJava 1.2
org.omg.CORBA

A DynAny object associated with an array. The get_elements() and set_elements() methods allow for access to the elements of the array, as Any values.

public abstract interface DynArray extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract Any[ ] get_elements ();
public abstract void set_elements (Any[ ] value) throws org.omg.CORBA.DynAnyPackage.InvalidSeq;
}

Hierarchy: (DynArray(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

Returned By: ORB.create_dyn_array()

DynEnumJava 1.2
org.omg.CORBA

A DynAny object associated with the Java mapping of an IDL enum type. The methods on the interface allow you to access the value of the enumerated type as either a String or an int.

public abstract interface DynEnum extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract String value_as_string ();
public abstract void value_as_string (String arg);
public abstract int value_as_ulong ();
public abstract void value_as_ulong (int arg);
}

Hierarchy: (DynEnum(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

Returned By: ORB.create_dyn_enum()

DynFixedJava 1.2
org.omg.CORBA

A DynAny object associated with the Java mapping of an IDL fixed type.

public abstract interface DynFixed extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract byte[ ] get_value ();
public abstract void set_value (byte[ ] val) throws org.omg.CORBA.DynAnyPackage.InvalidValue;
}

Hierarchy: (DynFixed(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

DynSequenceJava 1.2
org.omg.CORBA

A DynAny object associated with the Java mapping of an IDL sequence type.

public abstract interface DynSequence extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract Any[ ] get_elements ();
public abstract int length ();
public abstract void length (int arg);
public abstract void set_elements (Any[ ] value) throws org.omg.CORBA.DynAnyPackage.InvalidSeq;
}

Hierarchy: (DynSequence(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

Returned By: ORB.create_dyn_sequence()

DynStructJava 1.2
org.omg.CORBA

A DynAny object associated with the Java mapping of an IDL struct type. In addition to the DynAny methods that allow you to traverse the components of the struct, the DynStruct interface provides methods that allow you to access an array of all of the members of the struct and to access their names within the struct.

public abstract interface DynStruct extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract TCKind current_member_kind ();
public abstract String current_member_name ();
public abstract NameValuePair[ ] get_members ();
public abstract void set_members (NameValuePair[ ] value) throws org.omg.CORBA.DynAnyPackage.InvalidSeq;
}

Hierarchy: (DynStruct(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

Returned By: ORB.create_dyn_struct()

DynUnionJava 1.2
org.omg.CORBA

A DynAny object associated with the Java mapping of an IDL union type. Methods on the interface allow you to access the discriminator value of the union and the current member of the union, as a DynAny object.

public abstract interface DynUnion extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract DynAny discriminator ();
public abstract TCKind discriminator_kind ();
public abstract DynAny member ();
public abstract TCKind member_kind ();
public abstract String member_name ();
public abstract void member_name (String arg);
public abstract boolean set_as_default ();
public abstract void set_as_default (boolean arg);
}

Hierarchy: (DynUnion(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

Returned By: ORB.create_dyn_union()

DynValueJava 1.2
org.omg.CORBA

A DynAny object associated with a value being passed using the proposed Objects-by-Value extension to CORBA. This extension to CORBA allows arguments to be passed by value, rather than strictly be reference, as they are in the core CORBA standard. Sun's implementation of the Java IDL binding does not yet implement the Objects-by-Value extension, but the relevant interfaces are included in the API.

public abstract interface DynValue extends org.omg.CORBA.Object, DynAny {
// Public Instance Methods
public abstract TCKind current_member_kind ();
public abstract String current_member_name ();
public abstract NameValuePair[ ] get_members ();
public abstract void set_members (NameValuePair[ ] value) throws org.omg.CORBA.DynAnyPackage.InvalidSeq;
}

Hierarchy: (DynValue(org.omg.CORBA.Object,DynAny(org.omg.CORBA.Object)))

EnvironmentJava 1.2
org.omg.CORBA

After a Dynamic Invocation Interface Request has been invoked, any exception it may have thrown can be accessed by retrieving the Environment from the Request using its env() method. The exception that was thrown can then be retrieved from the Environment using its exception() method.

public abstract class Environment {
// Public Constructors
public Environment ();
// Public Instance Methods
public abstract void clear ();
public abstract Exception exception ();
public abstract void exception (Exception except);
}

Returned By: ORB.create_environment(), Request.env()

ExceptionListJava 1.2
org.omg.CORBA

This class represents a list of exceptions that can be thrown by a remote method, in the form of the TypeCode objects for the corresponding Exception classes. An ExceptionList can be created using the ORB.create_exception_list() method; the TypeCode for each required exception can be created using the ORB.create_exception_tc() method. Once completed, the ExceptionList can create a Dynamic Invocation Interface Request object.

public abstract class ExceptionList {
// Public Constructors
public ExceptionList ();
// Public Instance Methods
public abstract void add (TypeCode exc);
public abstract int count ();
public abstract TypeCode item (int index) throws org.omg.CORBA.Bounds;
public abstract void remove (int index) throws org.omg.CORBA.Bounds;
}

Passed To: org.omg.CORBA.Object._create_request(), org.omg.CORBA.portable.Delegate.create_request(), org.omg.CORBA.portable.ObjectImpl._create_request()

Returned By: ORB.create_exception_list(), Request.exceptions()

FixedHolderJava 1.2
org.omg.CORBA

The holder class for IDL fixed values, which are tentatively mapped to the java.math.BigDecimal class. A FixedHolder wraps a BigDecimal value.

public final class FixedHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public FixedHolder ();
public FixedHolder (java.math.BigDecimal initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public java.math.BigDecimal value ;
}

Hierarchy: Object-->FixedHolder(org.omg.CORBA.portable.Streamable)

FloatHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java float values.

public final class FloatHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public FloatHolder ();
public FloatHolder (float initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public float value ;
}

Hierarchy: Object-->FloatHolder(org.omg.CORBA.portable.Streamable)

FREE_MEMJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an attempt to free memory fails.

public final class FREE_MEM extends org.omg.CORBA.SystemException {
// Public Constructors
public FREE_MEM ();
public FREE_MEM (String s);
public FREE_MEM (int minor, CompletionStatus completed);
public FREE_MEM (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->FREE_MEM

IDLTypeJava 1.2
org.omg.CORBAserializable

IDLType is an extension of IRObject that represents IDL basic types in the Interface Repository. It allows you to query the TypeCode of the type it represents. See the IRObject interface for more details on the Interface Repository.

public abstract interface IDLType extends org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, IRObject {
// Public Instance Methods
public abstract TypeCode type ();
}

Hierarchy: (IDLType(org.omg.CORBA.Object,org.omg.CORBA.portable.IDLEntity(Serializable),IRObject(org.omg.CORBA.Object,org.omg.CORBA.portable.IDLEntity(Serializable))))

Passed To: StructMember.StructMember(), UnionMember.UnionMember(), ValueMember.ValueMember()

Type Of: StructMember.type_def, UnionMember.type_def, ValueMember.type_def

IMP_LIMITJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when some implementation limit has been exceeded.

public final class IMP_LIMIT extends org.omg.CORBA.SystemException {
// Public Constructors
public IMP_LIMIT ();
public IMP_LIMIT (String s);
public IMP_LIMIT (int minor, CompletionStatus completed);
public IMP_LIMIT (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->IMP_LIMIT

INITIALIZEJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an error occurs while initializing an ORB.

public final class INITIALIZE extends org.omg.CORBA.SystemException {
// Public Constructors
public INITIALIZE ();
public INITIALIZE (String s);
public INITIALIZE (int minor, CompletionStatus completed);
public INITIALIZE (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INITIALIZE

INTERNALJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an ORB encounters an internal error. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

3

An IIOP reply message contained a bad status.

6

The repository ID of a user exception had an incorrect length during an unmarshalling operation.

7

The ORB failed to get the local hostname through the InetAddress.getLocalHost().getHostName() method.

8

The ORB was unable to create a listener port on its designated port because the port was in use, the creation of the daemon thread failed, or a security violation occurred.

9

An IIOP locate message contained a bad status.

10

An error was encountered while creating a stringified object reference.

11

An IIOP message contained a bad GIOP v1.0 message type.

14

An error occurred while unmarshalling a user exception.

18

The ORB failed during internal initialization.
public final class INTERNAL extends org.omg.CORBA.SystemException {
// Public Constructors
public INTERNAL ();
public INTERNAL (String s);
public INTERNAL (int minor, CompletionStatus completed);
public INTERNAL (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INTERNAL

INTF_REPOSJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an error occurs while attempting to use the interface repository.

public final class INTF_REPOS extends org.omg.CORBA.SystemException {
// Public Constructors
public INTF_REPOS ();
public INTF_REPOS (String s);
public INTF_REPOS (int minor, CompletionStatus completed);
public INTF_REPOS (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INTF_REPOS

IntHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java int values.

public final class IntHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public IntHolder ();
public IntHolder (int initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public int value ;
}

Hierarchy: Object-->IntHolder(org.omg.CORBA.portable.Streamable)

INV_FLAGJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid flag is specified in a method call.

public final class INV_FLAG extends org.omg.CORBA.SystemException {
// Public Constructors
public INV_FLAG ();
public INV_FLAG (String s);
public INV_FLAG (int minor, CompletionStatus completed);
public INV_FLAG (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INV_FLAG

INV_IDENTJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid identifier is specified.

public final class INV_IDENT extends org.omg.CORBA.SystemException {
// Public Constructors
public INV_IDENT ();
public INV_IDENT (String s);
public INV_IDENT (int minor, CompletionStatus completed);
public INV_IDENT (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INV_IDENT

INV_OBJREFJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an invalid object reference is used. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

1

A stringified object reference had no profile.
public final class INV_OBJREF extends org.omg.CORBA.SystemException {
// Public Constructors
public INV_OBJREF ();
public INV_OBJREF (String s);
public INV_OBJREF (int minor, CompletionStatus completed);
public INV_OBJREF (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INV_OBJREF

INV_POLICYJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an incompatibility between Policy objects is encountered during a remote method call.

public class INV_POLICY extends org.omg.CORBA.SystemException {
// Public Constructors
public INV_POLICY ();
public INV_POLICY (String s);
public INV_POLICY (int minor, CompletionStatus completed);
public INV_POLICY (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INV_POLICY

INVALID_TRANSACTIONJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a transaction error occurs during a remote method call.

public final class INVALID_TRANSACTION extends org.omg.CORBA.SystemException {
// Public Constructors
public INVALID_TRANSACTION ();
public INVALID_TRANSACTION (String s);
public INVALID_TRANSACTION (int minor, CompletionStatus completed);
public INVALID_TRANSACTION (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->INVALID_TRANSACTION

IRObjectJava 1.2
org.omg.CORBAserializable

All the informational interfaces used and exported by the Interface Repository derive from the IRObject interface. The Interface Repository is a component of the ORB that stores definitions of object interfaces. These interface definitions are used by the ORB at runtime to check the correctness of method requests and to support Dynamic Invocation Interface requests. They can also be used within development tools, to provide information about remote interfaces for browsing and linking them. The Interface Repository is analogous to a table schema in a relational database, in that it describes the type of objects an ORB is supporting. The Interface Repository uses a set of IDL interfaces (e.g., InterfaceDef, AttributeDef) to represent the modules, interfaces, attributes, methods, etc., it manages. All of these interfaces derive from the IRObject interface.

The IRObject has a def_kind() method that indicates the type of definition the object represents (module, attribute, etc.).

public abstract interface IRObject extends org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity {
// Public Instance Methods
public abstract DefinitionKind def_kind ();
public abstract void destroy ();
}

Hierarchy: (IRObject(org.omg.CORBA.Object,org.omg.CORBA.portable.IDLEntity(Serializable)))

Implementations: IDLType

LongHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java long values.

public final class LongHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public LongHolder ();
public LongHolder (long initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public long value ;
}

Hierarchy: Object-->LongHolder(org.omg.CORBA.portable.Streamable)

MARSHALJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when the ORB fails to marshal or unmarshal method arguments, return values or exceptions. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

4

An error occurred while unmarshalling an object reference.

5

An attempt was made to marshal or unmarshal an IDL type that is not supported in this implementation, such as wchar or wstring.

6

While marshalling or unmarshalling, a character not within the ISO Latin-1 set was encountered.
public final class MARSHAL extends org.omg.CORBA.SystemException {
// Public Constructors
public MARSHAL ();
public MARSHAL (String s);
public MARSHAL (int minor, CompletionStatus completed);
public MARSHAL (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->MARSHAL

Thrown By: Any.{insert_string(), insert_Value(), insert_wstring(), read_value()}

NamedValueJava 1.2
org.omg.CORBA

This class represents a remote method argument or return value. It consists of an argument name (as a String), its value (as an Any object), and an argument mode, which can one of ARG_IN.value, ARG_OUT.value, ARG_INOUT.value, or zero. If the argument mode is zero, the NamedValue represents a Context property value. NamedValue objects are used in Dynamic Invocation Interface and Dynamic Skeleton Interface operations (e.g., to build the argument list for a client-side method Request object).

public abstract class NamedValue {
// Public Constructors
public NamedValue ();
// Public Instance Methods
public abstract int flags ();
public abstract String name ();
public abstract Any value ();
}

Passed To: org.omg.CORBA.Object._create_request(), org.omg.CORBA.portable.Delegate.create_request(), org.omg.CORBA.portable.ObjectImpl._create_request()

Returned By: NVList.{add(), add_item(), add_value(), item()}, ORB.create_named_value(), Request.result()

NameValuePairJava 1.2
org.omg.CORBAserializable

A DynStruct object uses NameValuePair objects to represent its data members. It consists of a String name and a value represented as an Any object.

public final class NameValuePair implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public NameValuePair ();
public NameValuePair (String __id, Any __value);
// Public Instance Fields
public String id ;
public Any value ;
}

Hierarchy: Object-->NameValuePair(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: DynStruct.set_members(), DynValue.set_members()

Returned By: DynStruct.get_members(), DynValue.get_members()

NO_IMPLEMENTJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a call is made on a method that is not implemented. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

1

An attempt to use the Dynamic Skeleton Interface was made. The DSI is not implemented in Sun's Java IDL implementation.
public final class NO_IMPLEMENT extends org.omg.CORBA.SystemException {
// Public Constructors
public NO_IMPLEMENT ();
public NO_IMPLEMENT (String s);
public NO_IMPLEMENT (int minor, CompletionStatus completed);
public NO_IMPLEMENT (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->NO_IMPLEMENT

NO_MEMORYJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when insufficient dynamic memory is available to carry out a request.

public final class NO_MEMORY extends org.omg.CORBA.SystemException {
// Public Constructors
public NO_MEMORY ();
public NO_MEMORY (String s);
public NO_MEMORY (int minor, CompletionStatus completed);
public NO_MEMORY (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->NO_MEMORY

NO_PERMISSIONJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a client does not have sufficient permission to make a request.

public final class NO_PERMISSION extends org.omg.CORBA.SystemException {
// Public Constructors
public NO_PERMISSION ();
public NO_PERMISSION (String s);
public NO_PERMISSION (int minor, CompletionStatus completed);
public NO_PERMISSION (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->NO_PERMISSION

NO_RESOURCESJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when resources cannot be allocated to execute a request, on either the client or the server.

public final class NO_RESOURCES extends org.omg.CORBA.SystemException {
// Public Constructors
public NO_RESOURCES ();
public NO_RESOURCES (String s);
public NO_RESOURCES (int minor, CompletionStatus completed);
public NO_RESOURCES (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->NO_RESOURCES

NO_RESPONSEJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a server response to an asynchronous remote method call is not yet available.

public final class NO_RESPONSE extends org.omg.CORBA.SystemException {
// Public Constructors
public NO_RESPONSE ();
public NO_RESPONSE (String s);
public NO_RESPONSE (int minor, CompletionStatus completed);
public NO_RESPONSE (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->NO_RESPONSE

NVListJava 1.2
org.omg.CORBA

A list of NamedValue objects. An NVList can be created using either the ORB.create_list() method or the ORB.create_operation_list() method. The latter method initializes the list with NamedValue objects that describe the arguments to the method definition you pass into the create_operation_list() method.

public abstract class NVList {
// Public Constructors
public NVList ();
// Public Instance Methods
public abstract NamedValue add (int flags);
public abstract NamedValue add_item (String item_name, int flags);
public abstract NamedValue add_value (String item_name, Any val, int flags);
public abstract int count ();
public abstract NamedValue item (int index) throws org.omg.CORBA.Bounds;
public abstract void remove (int index) throws org.omg.CORBA.Bounds;
}

Passed To: org.omg.CORBA.Context.set_values(), org.omg.CORBA.Object._create_request(), ServerRequest.{arguments(), params()}, org.omg.CORBA.portable.Delegate.create_request(), org.omg.CORBA.portable.ObjectImpl._create_request()

Returned By: org.omg.CORBA.Context.get_values(), ORB.{create_list(), create_operation_list()}, Request.arguments()

OBJ_ADAPTERJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when an error is encountered by an object adapter in the ORB. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

1

On the server, no adapter matching the one referenced in the object reference was found.

2

Same as above, but error occurred during a locate request.

4

An error occurred while attempting to connect a servant to the ORB.
public final class OBJ_ADAPTER extends org.omg.CORBA.SystemException {
// Public Constructors
public OBJ_ADAPTER ();
public OBJ_ADAPTER (String s);
public OBJ_ADAPTER (int minor, CompletionStatus completed);
public OBJ_ADAPTER (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->OBJ_ADAPTER

ObjectJava 1.2
org.omg.CORBA

This is the base interface for all CORBA objects. An Object can be either a reference (stub) to a remote CORBA object or a local object implementation. The methods declared in the Object interface allow you to create Dynamic Invocation Interface requests on the object, get its Interface Repository definition, and check the equivalence of two objects, among other things. The org.omg.CORBA.portable.ObjectImpl class provides a default, concrete implementation of the Object interface.

public abstract interface Object {
// Public Instance Methods
public abstract Request _create_request (org.omg.CORBA.Context ctx, String operation, NVList arg_list, NamedValue result);
public abstract Request _create_request (org.omg.CORBA.Context ctx, String operation, NVList arg_list, NamedValue result, ExceptionList exclist, ContextList ctxlist);
public abstract org.omg.CORBA.Object _duplicate ();
public abstract DomainManager[ ] _get_domain_managers ();
public abstract org.omg.CORBA.Object _get_interface_def ();
public abstract org.omg.CORBA.Policy _get_policy (int policy_type);
public abstract int _hash (int maximum);
public abstract boolean _is_a (String repositoryIdentifier);
public abstract boolean _is_equivalent (org.omg.CORBA.Object other);
public abstract boolean _non_existent ();
public abstract void _release ();
public abstract Request _request (String operation);
public abstract org.omg.CORBA.Object _set_policy_override (org.omg.CORBA.Policy[ ] policies, SetOverrideType set_add);
}

Implementations: Current, DomainManager, DynAny, DynArray, DynEnum, DynFixed, DynSequence, DynStruct, DynUnion, DynValue, IDLType, IRObject, org.omg.CORBA.Policy, org.omg.CORBA.portable.ObjectImpl, org.omg.CosNaming.BindingIterator, org.omg.CosNaming.NamingContext

Passed To: Too many methods to list.

Returned By: Any.extract_Object(), DynAny.get_reference(), org.omg.CORBA.Object.{_duplicate(), _get_interface_def(), _set_policy_override()}, ORB.{resolve_initial_references(), string_to_object()}, Request.target(), org.omg.CORBA.portable.Delegate.{duplicate(), get_interface_def(), set_policy_override()}, org.omg.CORBA.portable.InputStream.read_Object(), org.omg.CORBA.portable.ObjectImpl.{_duplicate(), _get_interface_def(), _set_policy_override()}, org.omg.CosNaming._NamingContextImplBase.resolve(), org.omg.CosNaming._NamingContextStub.resolve(), org.omg.CosNaming.NamingContext.resolve()

Type Of: ObjectHolder.value

OBJECT_NOT_EXISTJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a request is made of a server object that no longer exists. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

1

The target of a locate request sent back a response indicating it did not know the object.

2

A method request was received by a server whose ID does not match the server ID referenced in the object reference.

4

The skeleton referenced in the object reference was not found on the server.
public final class OBJECT_NOT_EXIST extends org.omg.CORBA.SystemException {
// Public Constructors
public OBJECT_NOT_EXIST ();
public OBJECT_NOT_EXIST (String s);
public OBJECT_NOT_EXIST (int minor, CompletionStatus completed);
public OBJECT_NOT_EXIST (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->OBJECT_NOT_EXIST

ObjectHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java org.omg.CORBA.Object values.

public final class ObjectHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public ObjectHolder ();
public ObjectHolder (org.omg.CORBA.Object initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public org.omg.CORBA.Object value ;
}

Hierarchy: Object-->ObjectHolder(org.omg.CORBA.portable.Streamable)

ORBJava 1.2
org.omg.CORBA

The ORB class is at the heart of the CORBA API. The ORB class provides CORBA clients and server objects access to the basic CORBA functions needed to engage in remote object operations. The static init() methods let you initialize a reference to an ORB. ORB provides access to initial objects and service through its resolve_initial_references() method. It also provides constructor methods that allow you to create key objects needed to perform remote method requests, like Any and NamedValue objects. The ORB also allows you to convert a CORBA object reference to a portable stringified form and back again, using its object_to_string() and string_to_object() methods.

public abstract class ORB {
// Public Constructors
public ORB ();
// Public Class Methods
public static ORB init ();
public static ORB init (String[ ] args, java.util.Properties props);
public static ORB init (java.applet.Applet app, java.util.Properties props);
// Public Instance Methods
public void connect (org.omg.CORBA.Object obj);
public TypeCode create_abstract_interface_tc (String id, String name);
public abstract TypeCode create_alias_tc (String id, String name, TypeCode original_type);
public abstract Any create_any ();
public abstract TypeCode create_array_tc (int length, TypeCode element_type);
public DynAny create_basic_dyn_any (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public abstract ContextList create_context_list ();
public DynAny create_dyn_any (Any value);
public DynArray create_dyn_array (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public DynEnum create_dyn_enum (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public DynSequence create_dyn_sequence (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public DynStruct create_dyn_struct (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public DynUnion create_dyn_union (TypeCode type) throws org.omg.CORBA.ORBPackage.InconsistentTypeCode;
public abstract TypeCode create_enum_tc (String id, String name, String[ ] members);
public abstract Environment create_environment ();
public abstract ExceptionList create_exception_list ();
public abstract TypeCode create_exception_tc (String id, String name, StructMember[ ] members);
public TypeCode create_fixed_tc (short digits, short scale);
public abstract TypeCode create_interface_tc (String id, String name);
public abstract NVList create_list (int count);
public abstract NamedValue create_named_value (String s, Any any, int flags);
public TypeCode create_native_tc (String id, String name);
public NVList create_operation_list (org.omg.CORBA.Object oper);
public abstract org.omg.CORBA.portable.OutputStream create_output_stream ();
public org.omg.CORBA.Policy create_policy (int type, Any val) throws PolicyError;
public TypeCode create_recursive_tc (String id);
public abstract TypeCode create_sequence_tc (int bound, TypeCode element_type);
public abstract TypeCode create_string_tc (int bound);
public abstract TypeCode create_struct_tc (String id, String name, StructMember[ ] members);
public abstract TypeCode create_union_tc (String id, String name, TypeCode discriminator_type, UnionMember[ ] members);
public TypeCode create_value_box_tc (String id, String name, TypeCode boxed_type);
public TypeCode create_value_tc (String id, String name, short type_modifier, TypeCode concrete_base, ValueMember[ ] members);
public abstract TypeCode create_wstring_tc (int bound);
public void disconnect (org.omg.CORBA.Object obj);
public abstract org.omg.CORBA.Context get_default_context ();
public abstract Request get_next_response () throws WrongTransaction;
public abstract TypeCode get_primitive_tc (TCKind tcKind);
public boolean get_service_information (short service_type, ServiceInformationHolder service_info);
public abstract String[ ] list_initial_services ();
public abstract String object_to_string (org.omg.CORBA.Object obj);
public void perform_work ();
public abstract boolean poll_next_response ();
public abstract org.omg.CORBA.Object resolve_initial_references (String object_name) throws org.omg.CORBA.ORBPackage.InvalidName;
public void run ();
public abstract void send_multiple_requests_deferred (Request[ ] req);
public abstract void send_multiple_requests_oneway (Request[ ] req);
public void shutdown (boolean wait_for_completion);
public abstract org.omg.CORBA.Object string_to_object (String str);
public boolean work_pending ();
// Protected Instance Methods
protected abstract void set_parameters (String[ ] args, java.util.Properties props);
protected abstract void set_parameters (java.applet.Applet app, java.util.Properties props);
// Deprecated Public Methods
#public abstract TypeCode create_recursive_sequence_tc (int bound, int offset);
#public Current get_current ();
}

Returned By: ORB.init(), org.omg.CORBA.portable.Delegate.orb(), org.omg.CORBA.portable.InputStream.orb(), org.omg.CORBA.portable.ObjectImpl._orb(), org.omg.CORBA.portable.OutputStream.orb()

PERSIST_STOREJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a server encounters an error with its persistent storage.

public final class PERSIST_STORE extends org.omg.CORBA.SystemException {
// Public Constructors
public PERSIST_STORE ();
public PERSIST_STORE (String s);
public PERSIST_STORE (int minor, CompletionStatus completed);
public PERSIST_STORE (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->PERSIST_STORE

PolicyJava 1.2
org.omg.CORBA

This is the base interface for objects that represent usage policies for ORBs and other CORBA services. Policies for certain objects or domains of objects can be obtained from a DomainManager, which in turn can be obtained from the Object in question using its _get_domain_managers() method. The policy_type() method on Policy provides access to an integer type indicator, where the allowable values are implementation-specific.

public abstract interface Policy extends org.omg.CORBA.Object {
// Public Instance Methods
public abstract org.omg.CORBA.Policy copy ();
public abstract void destroy ();
public abstract int policy_type ();
}

Hierarchy: (org.omg.CORBA.Policy(Object))

Passed To: org.omg.CORBA.Object._set_policy_override(), org.omg.CORBA.portable.Delegate.set_policy_override(), org.omg.CORBA.portable.ObjectImpl._set_policy_override()

Returned By: DomainManager.get_domain_policy(), org.omg.CORBA.Object._get_policy(), ORB.create_policy(), org.omg.CORBA.Policy.copy(), org.omg.CORBA.portable.Delegate.get_policy(), org.omg.CORBA.portable.ObjectImpl._get_policy()

PolicyErrorJava 1.2
org.omg.CORBAserializable checked

An exception thrown when an error occurs during creation of a Policy object.

public final class PolicyError extends UserException {
// Public Constructors
public PolicyError ();
public PolicyError (short __reason);
public PolicyError (String reason_string, short __reason);
// Public Instance Fields
public short reason ;
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->UserException(org.omg.CORBA.portable.IDLEntity(Serializable))-->PolicyError

Thrown By: ORB.create_policy()

PrincipalJava 1.2; Deprecated in Java 1.2
org.omg.CORBA

This deprecated class was used in previous versions of the CORBA standard to hold the identity of a client, in the form of an array of bytes that represents the encoded name of the client. This functionality has now been assumed by the Security Service, but the class is still available in the Java IDL API to provide temporary backward compatibility with previous CORBA applications.

public abstract class Principal {
// Public Constructors
public Principal ();
// Deprecated Public Methods
#public abstract byte[ ] name ();
#public abstract void name (byte[ ] value);
}

Passed To: Any.insert_Principal(), PrincipalHolder.PrincipalHolder(), org.omg.CORBA.portable.OutputStream.write_Principal()

Returned By: Any.extract_Principal(), org.omg.CORBA.portable.InputStream.read_Principal()

Type Of: PrincipalHolder.value

PrincipalHolderJava 1.2; Deprecated in Java 1.2
org.omg.CORBA

This deprecated class is the holder class for out and inout remote method arguments that are mapped to Java Principal objects.

public final class PrincipalHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public PrincipalHolder ();
public PrincipalHolder (org.omg.CORBA.Principal initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public org.omg.CORBA.Principal value ;
}

Hierarchy: Object-->PrincipalHolder(org.omg.CORBA.portable.Streamable)

RequestJava 1.2
org.omg.CORBA

A Request represents a remote method request under the Dynamic Invocation Interface. Request objects are created by calling the create_request() method on the org.omg.CORBA.Object reference for the remote object that will service the method request. The Request contains the name of the method to be invoked, an NVList containing NamedValue objects that represent the method arguments, and the return value for the method, if appropriate. It can also contain a description of the exceptions the method can throw and the client context values that the method accepts.

You add method arguments to a Request by calling one of its add_XXX() methods, which all return an Any object that you can initialize with the value of the argument. Once the Request has been initialized with its arguments and any other information, the method can be invoked synchronously using the invoke() method, asynchronously using send_deferred(), or in one-way mode using send_oneway(). Immediately after the invoke() method returns, any return values or thrown exceptions are available for you to query. After calling the send_deferred() method, you can poll and retrieve the method response by calling the poll_response() and get_response() methods. If the response is ready, get_response() initializes the internal return value or exception in the Request object, and it can be retrieved using the return_value() method. After calling send_oneway(), no return value or exception is returned. You can use send_oneway() on methods even if they weren't declared as oneway in the corresponding IDL for the interface.

public abstract class Request {
// Public Constructors
public Request ();
// Public Instance Methods
public abstract Any add_in_arg ();
public abstract Any add_inout_arg ();
public abstract Any add_named_in_arg (String name);
public abstract Any add_named_inout_arg (String name);
public abstract Any add_named_out_arg (String name);
public abstract Any add_out_arg ();
public abstract NVList arguments ();
public abstract ContextList contexts ();
public abstract org.omg.CORBA.Context ctx ();
public abstract void ctx (org.omg.CORBA.Context c);
public abstract Environment env ();
public abstract ExceptionList exceptions ();
public abstract void get_response () throws WrongTransaction;
public abstract void invoke ();
public abstract String operation ();
public abstract boolean poll_response ();
public abstract NamedValue result ();
public abstract Any return_value ();
public abstract void send_deferred ();
public abstract void send_oneway ();
public abstract void set_return_type (TypeCode tc);
public abstract org.omg.CORBA.Object target ();
}

Passed To: ORB.{send_multiple_requests_deferred(), send_multiple_requests_oneway()}

Returned By: org.omg.CORBA.Object.{_create_request(), _request()}, ORB.get_next_response(), org.omg.CORBA.portable.Delegate.{create_request(), request()}, org.omg.CORBA.portable.ObjectImpl.{_create_request(), _request()}

ServerRequestJava 1.2
org.omg.CORBA

The server-side equivalent of the client-side Request object. A ServerRequest is used in the Dynamic Skeleton Interface to invoke a method on a server object through its DynamicImplementation.

public abstract class ServerRequest {
// Public Constructors
public ServerRequest ();
// Public Instance Methods
public void arguments (NVList args);
public abstract org.omg.CORBA.Context ctx ();
public String operation ();
public void set_exception (Any any);
public void set_result (Any any);
// Deprecated Public Methods
#public void except (Any any);
#public String op_name ();
#public void params (NVList params);
#public void result (Any any);
}

Passed To: DynamicImplementation.invoke(), org.omg.CosNaming._BindingIteratorImplBase.invoke(), org.omg.CosNaming._NamingContextImplBase.invoke()

ServiceDetailJava 1.2
org.omg.CORBAserializable

A component of a ServiceInformation object that describes a service available through an ORB. Each ServiceDetail stores an integer type code and an array of bytes that contains information about the service. The semantics of the type code and the format of the byte data are implementation-specific.

public final class ServiceDetail implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public ServiceDetail ();
public ServiceDetail (int service_detail_type, byte[ ] service_detail);
// Public Instance Fields
public byte[ ] service_detail ;
public int service_detail_type ;
}

Hierarchy: Object-->ServiceDetail(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: ServiceDetailHelper.{insert(), write()}, ServiceInformation.ServiceInformation()

Returned By: ServiceDetailHelper.{extract(), read()}

Type Of: ServiceInformation.service_details

ServiceDetailHelperJava 1.2
org.omg.CORBA

The helper class for the ServiceDetail class, used internally to read and write ServiceDetail objects when they are used as remote method arguments or return values.

public class ServiceDetailHelper {
// No Constructor
// Public Class Methods
public static ServiceDetail extract (Any a);
public static String id ();
public static void insert (Any a, ServiceDetail that);
public static ServiceDetail read (org.omg.CORBA.portable.InputStream in);
public static TypeCode type (); synchronized
public static void write (org.omg.CORBA.portable.OutputStream out, ServiceDetail that);
}
ServiceInformationJava 1.2
org.omg.CORBAserializable

This class represents information about a service available through an ORB. You query for information about a service using the ORB.get_service_information() method, which returns a ServiceInformation object. The ServiceInformation object consists of a set of ServiceDetail objects, each representing a particular piece of information about the service.

public final class ServiceInformation implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public ServiceInformation ();
public ServiceInformation (int[ ] __service_options, ServiceDetail[ ] __service_details);
// Public Instance Fields
public ServiceDetail[ ] service_details ;
public int[ ] service_options ;
}

Hierarchy: Object-->ServiceInformation(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: ServiceInformationHelper.{insert(), write()}, ServiceInformationHolder.ServiceInformationHolder()

Returned By: ServiceInformationHelper.{extract(), read()}

Type Of: ServiceInformationHolder.value

ServiceInformationHelperJava 1.2
org.omg.CORBA

The helper class for ServiceInformation objects, used internally to read and write ServiceInformation objects when they are used as remote method arguments or return values.

public class ServiceInformationHelper {
// No Constructor
// Public Class Methods
public static ServiceInformation extract (Any a);
public static String id ();
public static void insert (Any a, ServiceInformation that);
public static ServiceInformation read (org.omg.CORBA.portable.InputStream in);
public static TypeCode type (); synchronized
public static void write (org.omg.CORBA.portable.OutputStream out, ServiceInformation that);
}
ServiceInformationHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java ServiceInformation objects.

public final class ServiceInformationHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public ServiceInformationHolder ();
public ServiceInformationHolder (ServiceInformation arg);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream in);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream out);
// Public Instance Fields
public ServiceInformation value ;
}

Hierarchy: Object-->ServiceInformationHolder(org.omg.CORBA.portable.Streamable)

Passed To: ORB.get_service_information()

SetOverrideTypeJava 1.2
org.omg.CORBAserializable

The static instances on the SetOverrideType class are used in calls to the set_policy_overrides() method on org.omg.CORBA.Object. This method allows you to override security-related policies that are imposed on an object by a CORBA Security Service by passing in an array of Policy objects and a SetOverrideType object. There are two static SetOverrideType instances that can be passed in as the second argument to this method. SetOverrideType.ADD_OVERRIDE indicates that the policies being passed in should be added to any existing policies that apply to the object, while SetOverrideType.SET_OVERRIDE indicates that the policies being provided should replace any existing policies on the object.

public class SetOverrideType implements org.omg.CORBA.portable.IDLEntity {
// Protected Constructors
protected SetOverrideType (int _value);
// Public Constants
public static final int _ADD_OVERRIDE ; =1
public static final int _SET_OVERRIDE ; =0
public static final SetOverrideType ADD_OVERRIDE ;
public static final SetOverrideType SET_OVERRIDE ;
// Public Class Methods
public static SetOverrideType from_int (int i) throws BAD_PARAM;
// Public Instance Methods
public int value ();
}

Hierarchy: Object-->SetOverrideType(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: org.omg.CORBA.Object._set_policy_override(), org.omg.CORBA.portable.Delegate.set_policy_override(), org.omg.CORBA.portable.ObjectImpl._set_policy_override()

Returned By: SetOverrideType.from_int()

Type Of: SetOverrideType.{ADD_OVERRIDE, SET_OVERRIDE}

ShortHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java short values.

public final class ShortHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public ShortHolder ();
public ShortHolder (short initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public short value ;
}

Hierarchy: Object-->ShortHolder(org.omg.CORBA.portable.Streamable)

StringHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are mapped to Java String values.

public final class StringHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public StringHolder ();
public StringHolder (String initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public String value ;
}

Hierarchy: Object-->StringHolder(org.omg.CORBA.portable.Streamable)

StructMemberJava 1.2
org.omg.CORBAserializable

A class that represents a member of an IDL struct type. StructMember objects can create TypeCode objects for IDL struct and exception values with the ORB.create_struct_tc() and ORB.create_exception_tc() methods.

public final class StructMember implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public StructMember ();
public StructMember (String __name, TypeCode __type, IDLType __type_def);
// Public Instance Fields
public String name ;
public TypeCode type ;
public IDLType type_def ;
}

Hierarchy: Object-->StructMember(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: ORB.{create_exception_tc(), create_struct_tc()}

SystemExceptionJava 1.2
org.omg.CORBAserializable unchecked

This is the base class for all standard CORBA exceptions. A SystemException can be thrown by any CORBA remote method call. Many CORBA API methods throw SystemException objects as well. The SystemException class provides an integer minor code that can be optionally used by a subclass to indicate a more precise reason for an exception. The class also provides a CompletionStatus object that can indicate to the caller whether the method invocation was completed or not when the exception was encountered.

Subclasses of SystemException represent the many errors that can occur while a remote method request is being processed by the client's ORB, transferred to the server ORB, executed on the server object, and having its response transferred back to the client. A SystemException can originate on the client or on the server, before, during, or after the actual execution of the method on the remote object.

Since SystemException extends java.lang.RuntimeException, these exceptions don't need to be declared in method signatures. But remember that any remote method declared in an IDL interface can throw any of the subclasses of SystemException, just as any local Java method can throw any subclass of RuntimeException during execution.

public abstract class SystemException extends RuntimeException {
// Protected Constructors
protected SystemException (String reason, int minor, CompletionStatus completed);
// Public methods overriding Throwable
public String toString ();
// Public Instance Fields
public CompletionStatus completed ;
public int minor ;
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException

Subclasses: Too many classes to list.

Thrown By: org.omg.CORBA.portable.InvokeHandler._invoke()

TCKindJava 1.2
org.omg.CORBA

A class that represents the type of a TypeCode object. The TCKind class contains a set of static int values that correspond to the built-in IDL data types. It also contains a set of static TCKind instances that correspond to each of these IDL types. The TCKind of a TypeCode can be obtained using its kind() method, and its value can be compared to these static data members to determine the type of the TypeCode.

public class TCKind {
// Protected Constructors
protected TCKind (int _value);
// Public Constants
public static final int _tk_abstract_interface ; =32
public static final int _tk_alias ; =21
public static final int _tk_any ; =11
public static final int _tk_array ; =20
public static final int _tk_boolean ; =8
public static final int _tk_char ; =9
public static final int _tk_double ; =7
public static final int _tk_enum ; =17
public static final int _tk_except ; =22
public static final int _tk_fixed ; =28
public static final int _tk_float ; =6
public static final int _tk_long ; =3
public static final int _tk_longdouble ; =25
public static final int _tk_longlong ; =23
public static final int _tk_native ; =31
public static final int _tk_null ; =0
public static final int _tk_objref ; =14
public static final int _tk_octet ; =10
public static final int _tk_Principal ; =13
public static final int _tk_sequence ; =19
public static final int _tk_short ; =2
public static final int _tk_string ; =18
public static final int _tk_struct ; =15
public static final int _tk_TypeCode ; =12
public static final int _tk_ulong ; =5
public static final int _tk_ulonglong ; =24
public static final int _tk_union ; =16
public static final int _tk_ushort ; =4
public static final int _tk_value ; =29
public static final int _tk_value_box ; =30
public static final int _tk_void ; =1
public static final int _tk_wchar ; =26
public static final int _tk_wstring ; =27
public static final TCKind tk_abstract_interface ;
public static final TCKind tk_alias ;
public static final TCKind tk_any ;
public static final TCKind tk_array ;
public static final TCKind tk_boolean ;
public static final TCKind tk_char ;
public static final TCKind tk_double ;
public static final TCKind tk_enum ;
public static final TCKind tk_except ;
public static final TCKind tk_fixed ;
public static final TCKind tk_float ;
public static final TCKind tk_long ;
public static final TCKind tk_longdouble ;
public static final TCKind tk_longlong ;
public static final TCKind tk_native ;
public static final TCKind tk_null ;
public static final TCKind tk_objref ;
public static final TCKind tk_octet ;
public static final TCKind tk_Principal ;
public static final TCKind tk_sequence ;
public static final TCKind tk_short ;
public static final TCKind tk_string ;
public static final TCKind tk_struct ;
public static final TCKind tk_TypeCode ;
public static final TCKind tk_ulong ;
public static final TCKind tk_ulonglong ;
public static final TCKind tk_union ;
public static final TCKind tk_ushort ;
public static final TCKind tk_value ;
public static final TCKind tk_value_box ;
public static final TCKind tk_void ;
public static final TCKind tk_wchar ;
public static final TCKind tk_wstring ;
// Public Class Methods
public static TCKind from_int (int i) throws BAD_PARAM;
// Public Instance Methods
public int value ();
}

Passed To: ORB.get_primitive_tc()

Returned By: DynStruct.current_member_kind(), DynUnion.{discriminator_kind(), member_kind()}, DynValue.current_member_kind(), TCKind.from_int(), TypeCode.kind()

Type Of: Too many fields to list.

TRANSACTION_REQUIREDJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a remote method that must be run within a transaction is invoked outside of any transaction.

public final class TRANSACTION_REQUIRED extends org.omg.CORBA.SystemException {
// Public Constructors
public TRANSACTION_REQUIRED ();
public TRANSACTION_REQUIRED (String s);
public TRANSACTION_REQUIRED (int minor, CompletionStatus completed);
public TRANSACTION_REQUIRED (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->TRANSACTION_REQUIRED

TRANSACTION_ROLLEDBACKJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a remote method that was invoked within a transaction could not be completed because the enclosing transaction was rolled back.

public final class TRANSACTION_ROLLEDBACK extends org.omg.CORBA.SystemException {
// Public Constructors
public TRANSACTION_ROLLEDBACK ();
public TRANSACTION_ROLLEDBACK (String s);
public TRANSACTION_ROLLEDBACK (int minor, CompletionStatus completed);
public TRANSACTION_ROLLEDBACK (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->TRANSACTION_ROLLEDBACK

TRANSIENTJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when a transient (i.e., not necessarily repeatable) error occurs during a remote method call. Since the error might not occur again, it is possible to try making the same request again.

public final class TRANSIENT extends org.omg.CORBA.SystemException {
// Public Constructors
public TRANSIENT ();
public TRANSIENT (String s);
public TRANSIENT (int minor, CompletionStatus completed);
public TRANSIENT (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->TRANSIENT

TypeCodeJava 1.2
org.omg.CORBAserializable

A TypeCode object describes the IDL type of a CORBA object, analogously to how the Java Class for an object (obtained using the getClass() method on java.lang.Object) describes its Java type. At a minimum, a TypeCode object contains a TCKind element that specifies the IDL data type it represents. For structured IDL types, like struct and union, it also contains additional information about the data type. The member_XXX() methods can obtain information about the members of struct, union, enum, and exception types, while the length() method gives the length of string, sequence and array types.

public abstract class TypeCode implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public TypeCode ();
// Public Instance Methods
public TypeCode concrete_base_type () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract TypeCode content_type () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract int default_index () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract TypeCode discriminator_type () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract boolean equal (TypeCode tc);
public boolean equivalent (TypeCode tc);
public short fixed_digits () throws org.omg.CORBA.TypeCodePackage.BadKind;
public short fixed_scale () throws org.omg.CORBA.TypeCodePackage.BadKind;
public TypeCode get_compact_typecode ();
public abstract String id () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract TCKind kind ();
public abstract int length () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract int member_count () throws org.omg.CORBA.TypeCodePackage.BadKind;
public abstract Any member_label (int index) throws org.omg.CORBA.TypeCodePackage.BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
public abstract String member_name (int index) throws org.omg.CORBA.TypeCodePackage.BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
public abstract TypeCode member_type (int index) throws org.omg.CORBA.TypeCodePackage.BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
public short member_visibility (int index) throws org.omg.CORBA.TypeCodePackage.BadKind, org.omg.CORBA.Bounds;
public abstract String name () throws org.omg.CORBA.TypeCodePackage.BadKind;
public short type_modifier () throws org.omg.CORBA.TypeCodePackage.BadKind;
}

Hierarchy: Object-->TypeCode(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: Too many methods to list.

Returned By: Too many methods to list.

Type Of: StructMember.type, TypeCodeHolder.value, UnionMember.type, ValueMember.type

TypeCodeHolderJava 1.2
org.omg.CORBA

The holder class for out and inout remote method arguments that are TypeCode objects.

public final class TypeCodeHolder implements org.omg.CORBA.portable.Streamable {
// Public Constructors
public TypeCodeHolder ();
public TypeCodeHolder (TypeCode initial);
// Methods implementing Streamable
public void _read (org.omg.CORBA.portable.InputStream input);
public TypeCode _type ();
public void _write (org.omg.CORBA.portable.OutputStream output);
// Public Instance Fields
public TypeCode value ;
}

Hierarchy: Object-->TypeCodeHolder(org.omg.CORBA.portable.Streamable)

UnionMemberJava 1.2
org.omg.CORBAserializable

A class that represents a member of an IDL union type. UnionMember objects can create TypeCode objects for IDL union types with the ORB.create_union_tc() method.

public final class UnionMember implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public UnionMember ();
public UnionMember (String __name, Any __label, TypeCode __type, IDLType __type_def);
// Public Instance Fields
public Any label ;
public String name ;
public TypeCode type ;
public IDLType type_def ;
}

Hierarchy: Object-->UnionMember(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: ORB.create_union_tc()

UNKNOWNJava 1.2
org.omg.CORBAserializable unchecked

A standard CORBA exception thrown when the ORB encounters an error it can't interpret. Sun's Java IDL defines the following minor error code values for this exception, stored in the minor data member inherited from SystemException:

Minor Code

Meaning

1

During unmarshalling of the response to a method request, a user exception was returned by the server implementation that is not in the set of exceptions expected by the client.

3

The server implementation threw an unknown runtime exception.
public final class UNKNOWN extends org.omg.CORBA.SystemException {
// Public Constructors
public UNKNOWN ();
public UNKNOWN (String s);
public UNKNOWN (int minor, CompletionStatus completed);
public UNKNOWN (String s, int minor, CompletionStatus completed);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->RuntimeException-->org.omg.CORBA.SystemException-->UNKNOWN

UnknownUserExceptionJava 1.2
org.omg.CORBAserializable checked

This exception class can wrap any user exceptions that are thrown during Dynamic Invocation Interface remote method calls. If an exception is thrown by the server object during such a call, the client can call the env() method on its Request object to get the request's Environment. The exception contained within the Environment is an UnknownUserException. The actual user exception the server threw is contained in the except data member of the UnknownUserException, which is an Any object.

public final class UnknownUserException extends UserException {
// Public Constructors
public UnknownUserException ();
public UnknownUserException (Any a);
// Public Instance Fields
public Any except ;
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->UserException(org.omg.CORBA.portable.IDLEntity(Serializable))-->UnknownUserException

UserExceptionJava 1.2
org.omg.CORBAserializable checked

This is the base class for all user exceptions that are defined in IDL and mapped to Java. It extends java.lang.Exception directly, so it represents a Java exception that must be declared in method signatures and caught in application code that calls these methods. Unlike the SystemException, the UserException class doesn't declare any data members for describing the exception to the caller. A subclass must do this to suit the type of exception it represents. It does, however, inherit the message property from Throwable, which can store a descriptive message on the exception to describe the reason.

public abstract class UserException extends Exceptionimplements org.omg.CORBA.portable.IDLEntity {
// Protected Constructors
protected UserException ();
protected UserException (String reason);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->UserException(org.omg.CORBA.portable.IDLEntity(Serializable))

Subclasses: org.omg.CORBA.Bounds, PolicyError, UnknownUserException, WrongTransaction, org.omg.CORBA.DynAnyPackage.Invalid, org.omg.CORBA.DynAnyPackage.InvalidSeq, org.omg.CORBA.DynAnyPackage.InvalidValue, org.omg.CORBA.DynAnyPackage.TypeMismatch, org.omg.CORBA.ORBPackage.InconsistentTypeCode, org.omg.CORBA.ORBPackage.InvalidName, org.omg.CORBA.TypeCodePackage.BadKind, org.omg.CORBA.TypeCodePackage.Bounds, AlreadyBound, CannotProceed, org.omg.CosNaming.NamingContextPackage.InvalidName, NotEmpty, NotFound

ValueMemberJava 1.2
org.omg.CORBAserializable

A class that represents a member of an object passed by value using the proposed Objects-by-Value extension to CORBA. ValueMember objects can create TypeCode objects for values with the ORB.create_value_tc() method.

public final class ValueMember implements org.omg.CORBA.portable.IDLEntity {
// Public Constructors
public ValueMember ();
public ValueMember (String __name, String __id, String __defined_in, String __version, TypeCode __type, IDLType __type_def, short __access);
// Public Instance Fields
public short access ;
public String defined_in ;
public String id ;
public String name ;
public TypeCode type ;
public IDLType type_def ;
public String version ;
}

Hierarchy: Object-->ValueMember(org.omg.CORBA.portable.IDLEntity(Serializable))

Passed To: ORB.create_value_tc()

WrongTransactionJava 1.2
org.omg.CORBAserializable checked

A user exception thrown when an attempt is made to get the response to a deferred method request from a different transaction than the original request. If a client makes an asynchronous Dynamic Invocation Interface method request using the Request.send_deferred() method within a given transaction and then later makes a call to the Request object's get_response() method from within a different transaction, a WrongTransaction exception is thrown. This exception can also be thrown if the ORB.get_next_response() method is called from a different transaction than the original method request.

public class WrongTransaction extends UserException {
// Public Constructors
public WrongTransaction ();
public WrongTransaction (String reason);
}

Hierarchy: Object-->Throwable(Serializable)-->Exception-->UserException(org.omg.CORBA.portable.IDLEntity(Serializable))-->WrongTransaction

Thrown By: ORB.get_next_response(), Request.get_response()

PreviousHomeNext
29.1. The javax.transaction.xa PackageBook Index31. The org.omg.CORBA.DynAnyPackage Package
Library Navigation Links

Copyright © 2001 O'Reilly & Associates. All rights reserved.