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.
| Any | Java 1.2 | |
|
||
| org.omg.CORBA | serializable | |
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
| AnyHolder | Java 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_IN | Java 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_INOUT | Java 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_OUT | Java 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_CONTEXT | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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_ORDER | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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_OPERATION | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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_PARAM | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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_TYPECODE | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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
| BooleanHolder | Java 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)
| Bounds | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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()
| ByteHolder | Java 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)
| CharHolder | Java 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_FAILURE | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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
| CompletionStatus | Java 1.2 | |
|
||
| org.omg.CORBA | serializable | |
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
| Context | Java 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()
| ContextList | Java 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_SCOPE | Java 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 | |
| } | ||
| Current | Java 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_CONVERSION | Java 1.2 | |
|
||
| org.omg.CORBA | serializable 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()}
| DefinitionKind | Java 1.2 | |
|
||
| org.omg.CORBA | serializable | |
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}
| DomainManager | Java 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()
| DoubleHolder | Java 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)
| DynamicImplementation | Java 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
| DynAny | Java 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()}
| DynArray | Java 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()
| DynEnum | Java 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()
| DynFixed | Java 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)))
| DynSequence | Java 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()
| DynStruct | Java 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()
| DynUnion | Java 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()
| DynValue | Java 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)))
| Environment | Java 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()
| ExceptionList | Java 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()
| FixedHolder | Java 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)
| FloatHolder | Java 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 | ||