ORB JDK 1.6)

Standard Java CORBA Properties:
Property Name	Property Value
org.omg.CORBA.ORBClass	class name of an ORB implementation
org.omg.CORBA.ORBSingletonClass	class name of the ORB returned by `init()`

public void connect (Object obj)

Connects the given servant object (a Java object that is an instance of the server implementation class) to the ORB.

Connects the given servant object (a Java object that is an instance of the server implementation class) to the ORB. The servant class must extend the ImplBase class corresponding to the interface that is supported by the server. The servant must thus be a CORBA object reference, and inherit from org.omg.CORBA.Object. Servants created by the user can start receiving remote invocations after the method connect has been called. A servant may also be automatically and implicitly connected to the ORB if it is passed as an IDL parameter in an IDL method invocation on a non-local object, that is, if the servant object has to be marshalled and sent outside of the process address space.

Calling the method connect has no effect when the servant object is already connected to the ORB.

Deprecated by the OMG in favor of the Portable Object Adapter APIs.
Parameters:
- obj - The servant object reference

public TypeCode create_abstract_interface_tc (String id, String name)

Create a TypeCode object for an IDL abstract interface.

Create a TypeCode object for an IDL abstract interface.
Returns: the requested TypeCode.
Parameters:
- id - the logical id for the abstract interface type.
- name - the name of the abstract interface type.

publicabstract TypeCode create_alias_tc (String id, String name, TypeCode original_type)

Creates a TypeCode object representing an IDL alias (typedef).

Creates a TypeCode object representing an IDL alias
(typedef).
The TypeCode object is initialized with the given id,
name, and original type.
Returns: a newly-created TypeCode object describing an IDL alias
Parameters:
- id - the repository id for the alias
- name - the name for the alias
- original_type - the TypeCode object describing the original type for which this is an alias

publicabstract Any create_any ()

Creates an IDL Any object initialized to contain a Typecode object whose kind field is set to TCKind.tc_null.

Creates an IDL Any object initialized to
contain a Typecode object whose kind field
is set to TCKind.tc_null.
Returns: a newly-created Any object

publicabstract TypeCode create_array_tc (int length, TypeCode element_type)

Creates a TypeCode object representing an IDL array.

Creates a TypeCode object representing an IDL array.
The TypeCode object is initialized with the given length and
element type.
Returns: a newly-created TypeCode object describing an IDL array
Parameters:
- length - the length of the array
- element_type - a TypeCode object describing the type of element contained in the array

@Deprecated

public DynAny ~~create_basic_dyn_any~~ (TypeCode type) throws InconsistentTypeCode

Creates a basic DynAny object from the given TypeCode object.

Returns: the new DynAny object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynAny object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

publicabstract ContextList create_context_list ()

Creates an empty ContextList object.

Creates an empty ContextList object.
Returns: the newly-created ContextList object
See Also: ContextList, Context,

@Deprecated

public DynAny ~~create_dyn_any~~ (Any value)

Creates a new DynAny object from the given Any object.

Returns: the new DynAny object created from the given Any object
Parameters:
- value - the Any object from which to create a new DynAny object
See Also: CORBA package comments for unimplemented features,

@Deprecated

public DynArray ~~create_dyn_array~~ (TypeCode type) throws InconsistentTypeCode

Creates a new DynArray object from the given TypeCode object.

Returns: the new DynArray object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynArray object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

@Deprecated

public DynEnum ~~create_dyn_enum~~ (TypeCode type) throws InconsistentTypeCode

Creates a new DynEnum object from the given TypeCode object.

Returns: the new DynEnum object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynEnum object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

@Deprecated

public DynSequence ~~create_dyn_sequence~~ (TypeCode type) throws InconsistentTypeCode

Creates a new DynSequence object from the given TypeCode object.

Returns: the new DynSequence object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynSequence object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

@Deprecated

public DynStruct ~~create_dyn_struct~~ (TypeCode type) throws InconsistentTypeCode

Creates a new DynStruct object from the given TypeCode object.

Returns: the new DynStruct object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynStruct object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

@Deprecated

public DynUnion ~~create_dyn_union~~ (TypeCode type) throws InconsistentTypeCode

Creates a new DynUnion object from the given TypeCode object.

Returns: the new DynUnion object created from the given TypeCode object
Parameters:
- type - the TypeCode object from which to create a new DynUnion object
Throws:
- org.omg.CORBA.ORBPackage.InconsistentTypeCode - if the given TypeCode object is not consistent with the operation.
See Also: CORBA package comments for unimplemented features,

publicabstract TypeCode create_enum_tc (String id, String name, String members)

Creates a TypeCode object representing an IDL enum.

Creates a TypeCode object representing an IDL enum.
The TypeCode object is initialized with the given id,
name, and members.
Returns: a newly-created TypeCode object describing an IDL enum
Parameters:
- id - the repository id for the enum
- name - the name for the enum
- members - an array describing the members of the enum

publicabstract Environment create_environment ()

Creates an Environment object.

Creates an Environment object.
Returns: the newly-created Environment object
See Also: Environment,

publicabstract ExceptionList create_exception_list ()

Creates an empty ExceptionList object.

Creates an empty ExceptionList object.
Returns: the newly-created ExceptionList object

publicabstract TypeCode create_exception_tc (String id, String name, StructMember members)

Creates a TypeCode object representing an IDL exception.

Creates a TypeCode object representing an IDL exception.
The TypeCode object is initialized with the given id,
name, and members.
Returns: a newly-created TypeCode object describing an IDL exception
Parameters:
- id - the repository id for the exception
- name - the name for the exception
- members - an array describing the members of the exception

public TypeCode create_fixed_tc (short digits, short scale)

Create a TypeCode object for an IDL fixed type.

Create a TypeCode object for an IDL fixed type.
Returns: the requested TypeCode.
Parameters:
- digits - specifies the total number of decimal digits in the number and must be from 1 to 31 inclusive.
- scale - specifies the position of the decimal point.

publicabstract TypeCode create_interface_tc (String id, String name)

Creates a TypeCode object representing an IDL interface.

Creates a TypeCode object representing an IDL interface.
The TypeCode object is initialized with the given id
and name.
Returns: a newly-created TypeCode object describing an IDL interface
Parameters:
- id - the repository id for the interface
- name - the name for the interface

publicabstract NVList create_list (int count)

Allocates an NVList with (probably) enough space for the specified number of NamedValue objects.

Allocates an NVList with (probably) enough
space for the specified number of NamedValue objects.
Note that the specified size is only a hint to help with
storage allocation and does not imply the maximum size of the list.
Returns: the newly-created NVList
Parameters:
- count - suggested number of NamedValue objects for which to allocate space
See Also: NVList,

publicabstract NamedValue create_named_value (String s, Any any, int flags)

Creates a NamedValue object using the given name, value, and argument mode flags.

A NamedValue object serves as (1) a parameter or return value or (2) a context property. It may be used by itself or as an element in an NVList object.
Returns: the newly-created NamedValue object
Parameters:
- s - the name of the NamedValue object
- any - the Any value to be inserted into the NamedValue object
- flags - the argument mode flags for the NamedValue: one of ARG_IN.value, ARG_OUT.value, or ARG_INOUT.value.
See Also: NamedValue,

public TypeCode create_native_tc (String id, String name)

Create a TypeCode object for an IDL native type.

Create a TypeCode object for an IDL native type.
Returns: the requested TypeCode.
Parameters:
- id - the logical id for the native type.
- name - the name of the native type.

public NVList create_operation_list (Object oper)

Creates an NVList initialized with argument descriptions for the operation described in the given OperationDef object.

Creates an NVList initialized with argument
descriptions for the operation described in the given
OperationDef object. This OperationDef object
is obtained from an Interface Repository. The arguments in the
returned NVList object are in the same order as in the
original IDL operation definition, which makes it possible for the list
to be used in dynamic invocation requests.
Returns: a newly-created NVList object containing descriptions of the arguments to the method described in the given OperationDef object
Parameters:
- oper - the OperationDef object to use to create the list
See Also: NVList,

publicabstract OutputStream create_output_stream ()

Creates a new org.omg.CORBA.portable.OutputStream into which IDL method parameters can be marshalled during method invocation.

Creates a new org.omg.CORBA.portable.OutputStream into which
IDL method parameters can be marshalled during method invocation.
Returns: the newly-created org.omg.CORBA.portable.OutputStream object

public Policy create_policy (int type, Any val) throws PolicyError

Can be invoked to create new instances of policy objects of a specific type with specified initial state.

@Deprecated

publicabstract TypeCode ~~create_recursive_sequence_tc~~ (int bound, int offset)

Creates a TypeCode object representing a a recursive IDL sequence.

For the IDL struct Node in following code fragment, the offset parameter for creating its sequence would be 1:

    Struct Node {
        long value;
        Sequence <Node> subnodes;
    };

Returns: a newly-created TypeCode object describing a recursive sequence
Parameters:
- bound - the bound for the sequence, 0 if unbounded
- offset - the index to the enclosing TypeCode object that describes the elements of this sequence
See Also: create_recursive_tc, create_sequence_tc,

public TypeCode create_recursive_tc (String id)

Create a recursive TypeCode object which serves as a placeholder for a concrete TypeCode during the process of creating TypeCodes which contain recursion.

Create a recursive TypeCode object which serves as a placeholder for a concrete TypeCode during the process of creating TypeCodes which contain recursion. The id parameter specifies the repository id of the type for which the recursive TypeCode is serving as a placeholder. Once the recursive TypeCode has been properly embedded in the enclosing TypeCode which corresponds to the specified repository id, it will function as a normal TypeCode. Invoking operations on the recursive TypeCode before it has been embedded in the enclosing TypeCode will result in a BAD_TYPECODE exception.

For example, the following IDL type declaration contains recursion:

    Struct Node {
        Sequence<Node> subnodes;
    };

To create a TypeCode for struct Node, you would invoke the TypeCode creation operations as shown below:

 String nodeID = "IDL:Node:1.0";
 TypeCode recursiveSeqTC = orb.create_sequence_tc(0, orb.create_recursive_tc(nodeID));
 StructMember[] members = { new StructMember("subnodes", recursiveSeqTC, null) };
 TypeCode structNodeTC = orb.create_struct_tc(nodeID, "Node", members);

Also note that the following is an illegal IDL type declaration:

    Struct Node {
        Node next;
    };

Recursive types can only appear within sequences which can be empty. That way marshaling problems, when transmitting the struct in an Any, are avoided.

Returns: the requested TypeCode
Parameters:
- id - the logical id of the referenced type

publicabstract TypeCode create_sequence_tc (int bound, TypeCode element_type)

Creates a TypeCode object representing an IDL sequence.

Creates a TypeCode object representing an IDL sequence.
The TypeCode object is initialized with the given bound and
element type.
Returns: a newly-created TypeCode object describing an IDL sequence
Parameters:
- bound - the bound for the sequence, 0 if unbounded
- element_type - the TypeCode object describing the elements contained in the sequence

publicabstract TypeCode create_string_tc (int bound)

Creates a TypeCode object representing a bounded IDL string.

Creates a TypeCode object representing a bounded IDL
string.
The TypeCode object is initialized with the given bound,
which represents the maximum length of the string. Zero indicates
that the string described by this type code is unbounded.
Returns: a newly-created TypeCode object describing a bounded IDL string
Parameters:
- bound - the bound for the string; cannot be negative
Throws:
- BAD_PARAM - if bound is a negative value

publicabstract TypeCode create_struct_tc (String id, String name, StructMember members)

Creates a TypeCode object representing an IDL struct.

Creates a TypeCode object representing an IDL struct.
The TypeCode object is initialized with the given id,
name, and members.
Returns: a newly-created TypeCode object describing an IDL struct
Parameters:
- id - the repository id for the struct
- name - the name of the struct
- members - an array describing the members of the struct

publicabstract TypeCode create_union_tc (String id, String name, TypeCode discriminator_type, UnionMember members)

Creates a TypeCode object representing an IDL union.

Creates a TypeCode object representing an IDL union.
The TypeCode object is initialized with the given id,
name, discriminator type, and members.
Returns: a newly-created TypeCode object describing an IDL union
Parameters:
- id - the repository id of the union
- name - the name of the union
- discriminator_type - the type of the union discriminator
- members - an array describing the members of the union

public TypeCode create_value_box_tc (String id, String name, TypeCode boxed_type)

Creates a TypeCode object for an IDL value box.

Creates a TypeCode object for an IDL value box.
Returns: the requested TypeCode
Parameters:
- id - the logical id for the value type
- name - the name of the value type
- boxed_type - the TypeCode for the type

public TypeCode create_value_tc (String id, String name, short type_modifier, TypeCode concrete_base, ValueMember members)

Create a TypeCode object for an IDL value type.

Create a TypeCode object for an IDL value type.
The concrete_base parameter is the TypeCode for the immediate
concrete valuetype base of the valuetype for which the TypeCode
is being created.
It may be null if the valuetype does not have a concrete base.
Returns: the requested TypeCode
Parameters:
- id - the logical id for the value type.
- name - the name of the value type.
- type_modifier - one of the value type modifier constants: VM_NONE, VM_CUSTOM, VM_ABSTRACT or VM_TRUNCATABLE
- concrete_base - a TypeCode object describing the concrete valuetype base
- members - an array containing the members of the value type

publicabstract TypeCode create_wstring_tc (int bound)

Creates a TypeCode object representing a bounded IDL wstring (wide string).

Creates a TypeCode object representing a bounded IDL
wstring (wide string).
The TypeCode object is initialized with the given bound,
which represents the maximum length of the wide string. Zero indicates
that the string described by this type code is unbounded.
Returns: a newly-created TypeCode object describing a bounded IDL wstring
Parameters:
- bound - the bound for the wstring; cannot be negative
Throws:
- BAD_PARAM - if bound is a negative value

public void destroy ()

Destroys the ORB so that its resources can be reclaimed.

Destroys the ORB so that its resources can be reclaimed. Any operation invoked on a destroyed ORB reference will throw the OBJECT_NOT_EXIST exception. Once an ORB has been destroyed, another call to init with the same ORBid will return a reference to a newly constructed ORB.

If destroy is called on an ORB that has not been shut down, it will start the shut down process and block until the ORB has shut down before it destroys the ORB.
If an application calls destroy in a thread that is currently servicing an invocation, the BAD_INV_ORDER system exception will be thrown with the OMG minor code 3, since blocking would result in a deadlock.

For maximum portability and to avoid resource leaks, an application should always call shutdown and destroy on all ORB instances before exiting.
Throws:
- org.omg.CORBA.BAD_INV_ORDER - if the current thread is servicing an invocation

public void disconnect (Object obj)

Disconnects the given servant object from the ORB.

Disconnects the given servant object from the ORB. After this method returns, the ORB will reject incoming remote requests for the disconnected servant and will send the exception org.omg.CORBA.OBJECT_NOT_EXIST back to the remote client. Thus the object appears to be destroyed from the point of view of remote clients. Note, however, that local requests issued using the servant directly do not pass through the ORB; hence, they will continue to be processed by the servant.

Calling the method disconnect has no effect if the servant is not connected to the ORB.

Deprecated by the OMG in favor of the Portable Object Adapter APIs.
Parameters:
- obj - The servant object to be disconnected from the ORB

@Deprecated

public Current ~~get_current~~ ()

Retrieves a Current object.

Retrieves a Current object.
The Current interface is used to manage thread-specific
information for use by services such as transactions and security.
Returns: a newly-created Current object
See Also: CORBA package comments for unimplemented features,

publicabstract Context get_default_context ()

Gets the default Context object.

Gets the default Context object.
Returns: the default Context object
See Also: Context,

publicabstract Request get_next_response () throws WrongTransaction

Gets the next Request instance for which a response has been received.

Gets the next Request instance for which a response
has been received.
Returns: the next Request object ready with a response
Throws:
- WrongTransaction - if the method get_next_response is called from a transaction scope different from the one from which the original request was sent. See the OMG Transaction Service specification for details.

publicabstract TypeCode get_primitive_tc (TCKind tcKind)

Retrieves the TypeCode object that represents the given primitive IDL type.

Retrieves the TypeCode object that represents
the given primitive IDL type.
Returns: the requested TypeCode object
Parameters:
- tcKind - the TCKind instance corresponding to the desired primitive type

public boolean get_service_information (short service_type, ServiceInformationHolder service_info)

Used to obtain information about CORBA facilities and services that are supported by this ORB.

publicstaticsynchronized ORB init ()

Returns the ORB singleton object.

Returns the ORB singleton object. This method always returns the same ORB instance, which is an instance of the class described by the org.omg.CORBA.ORBSingletonClass system property.

This no-argument version of the method init is used primarily as a factory for TypeCode objects, which are used by Helper classes to implement the method type. It is also used to create Any objects that are used to describe union labels (as part of creating a TypeCode object for a union).

This method is not intended to be used by applets, and in the event that it is called in an applet environment, the ORB it returns is restricted so that it can be used only as a factory for TypeCode objects. Any TypeCode objects it produces can be safely shared among untrusted applets.

If an ORB is created using this method from an applet, a system exception will be thrown if methods other than those for creating TypeCode objects are invoked.
Returns: the singleton ORB

publicstatic ORB init (Applet app, Properties props)

Creates a new ORB instance for an applet.

Creates a new ORB instance for an applet. This
method may be called from applets only and returns a new
fully-functional ORB object each time it is called.
Returns: the newly-created ORB instance
Parameters:
- app - the applet; may be null
- props - applet-specific properties; may be null

publicstatic ORB init (String args, Properties props)

Creates a new ORB instance for a standalone application.

Creates a new ORB instance for a standalone
application. This method may be called from applications
only and returns a new fully functional ORB object
each time it is called.
Returns: the newly-created ORB instance
Parameters:
- args - command-line arguments for the application's main method; may be null
- props - application-specific properties; may be null

publicabstract String list_initial_services ()

Returns a list of the initially available CORBA object references, such as "NameService" and "InterfaceRepository".

Returns a list of the initially available CORBA object references,
such as "NameService" and "InterfaceRepository".
Returns: an array of String objects that represent the object references for CORBA services that are initially available with this ORB

publicabstract String object_to_string (Object obj)

Converts the given CORBA object reference to a string.

public void perform_work ()

Performs an implementation-dependent unit of work if called by the main thread.

Performs an implementation-dependent unit of work if called
by the main thread. Otherwise it does nothing.
The methods work_pending and perform_work
can be used in
conjunction to implement a simple polling loop that multiplexes
the main thread among the ORB and other activities.

publicabstract boolean poll_next_response ()

Finds out if any of the deferred (asynchronous) invocations have a response yet.

Finds out if any of the deferred (asynchronous) invocations have
a response yet.
Returns: true if there is a response available; false otherwise

publicabstract Object resolve_initial_references (String object_name) throws InvalidName

Resolves a specific object reference from the set of available initial service names.

public void run ()

This operation blocks the current thread until the ORB has completed the shutdown process, initiated when some thread calls shutdown.

This operation blocks the current thread until the ORB has
completed the shutdown process, initiated when some thread calls
shutdown. It may be used by multiple threads which
get all notified when the ORB shuts down.

publicabstract void send_multiple_requests_deferred (Request req)

Sends multiple dynamic (DII) requests asynchronously.

Sends multiple dynamic (DII) requests asynchronously.
Parameters:
- req - an array of Request objects

publicabstract void send_multiple_requests_oneway (Request req)

Sends multiple dynamic (DII) requests asynchronously without expecting any responses.

protectedabstract void set_parameters (Applet app, Properties props)

Allows the ORB implementation to be initialized with the given applet and parameters.

Allows the ORB implementation to be initialized with the given
applet and parameters. This method, used in applets only,
is implemented by subclass ORB implementations and called
by the appropriate init method to pass in its parameters.
Parameters:
- app - the applet; may be null
- props - applet-specific properties; may be null

protectedabstract void set_parameters (String args, Properties props)

Allows the ORB implementation to be initialized with the given parameters and properties.

Allows the ORB implementation to be initialized with the given
parameters and properties. This method, used in applications only,
is implemented by subclass ORB implementations and called
by the appropriate init method to pass in its parameters.
Parameters:
- args - command-line arguments for the application's main method; may be null
- props - application-specific properties; may be null

public void shutdown (boolean wait_for_completion)

Instructs the ORB to shut down, which causes all object adapters to shut down, in preparation for destruction.
If the wait_for_completion parameter is true, this operation blocks until all ORB processing (including processing of currently executing requests, object deactivation, and other object adapter operations) has completed.

Instructs the ORB to shut down, which causes all object adapters to shut down, in preparation for destruction.
If the wait_for_completion parameter is true, this operation blocks until all ORB processing (including processing of currently executing requests, object deactivation, and other object adapter operations) has completed. If an application does this in a thread that is currently servicing an invocation, the BAD_INV_ORDER system exception will be thrown with the OMG minor code 3, since blocking would result in a deadlock.
If the wait_for_completion parameter is FALSE, then shutdown may not have completed upon return.

While the ORB is in the process of shutting down, the ORB operates as normal, servicing incoming and outgoing requests until all requests have been completed. Once an ORB has shutdown, only object reference management operations may be invoked on the ORB or any object reference obtained from it. An application may also invoke the destroy operation on the ORB itself. Invoking any other operation will throw the BAD_INV_ORDER system exception with the OMG minor code 4.

The ORB.run method will return after shutdown has been called.
Parameters:
- wait_for_completion - true if the call should block until the shutdown is complete; false if it should return immediately
Throws:
- org.omg.CORBA.BAD_INV_ORDER - if the current thread is servicing an invocation

publicabstract Object string_to_object (String str)

Converts a string produced by the method object_to_string back to a CORBA object reference.

Converts a string produced by the method object_to_string
back to a CORBA object reference.
Returns: the object reference
Parameters:
- str - the string to be converted back to an object reference. It must be the result of converting an object reference to a string using the method object_to_string.

public boolean work_pending ()

Returns true if the ORB needs the main thread to perform some work, and false if the ORB does not need the main thread.

Returns true if the ORB needs the main thread to
perform some work, and false if the ORB does not
need the main thread.
Returns: true if there is work pending, meaning that the ORB needs the main thread to perform some work; false if there is no work pending and thus the ORB does not need the main thread