FileDocCategorySizeDatePackage
ORB.javaAPI DocJava SE 5 API53456Fri Aug 26 14:58:30 BST 2005org.omg.CORBA

ORB

public abstract class ORB extends Object
A class providing APIs for the CORBA Object Request Broker features. The ORB class also provides "pluggable ORB implementation" APIs that allow another vendor's ORB implementation to be used.

An ORB makes it possible for CORBA objects to communicate with each other by connecting objects making requests (clients) with objects servicing requests (servers).

The ORB class, which encapsulates generic CORBA functionality, does the following: (Note that items 5 and 6, which include most of the methods in the class ORB, are typically used with the Dynamic Invocation Interface (DII) and the Dynamic Skeleton Interface (DSI). These interfaces may be used by a developer directly, but most commonly they are used by the ORB internally and are not seen by the general programmer.)

  1. initializes the ORB implementation by supplying values for predefined properties and environmental parameters
  2. obtains initial object references to services such as the NameService using the method resolve_initial_references
  3. converts object references to strings and back
  4. connects the ORB to a servant (an instance of a CORBA object implementation) and disconnects the ORB from a servant
  5. creates objects such as
    • TypeCode
    • Any
    • NamedValue
    • Context
    • Environment
    • lists (such as NVList) containing these objects
  6. sends multiple messages in the DII

The ORB class can be used to obtain references to objects implemented anywhere on the network.

An application or applet gains access to the CORBA environment by initializing itself into an ORB using one of three init methods. Two of the three methods use the properties (associations of a name with a value) shown in the table below.
Property Name Property Value
Standard Java CORBA Properties:
org.omg.CORBA.ORBClass class name of an ORB implementation
org.omg.CORBA.ORBSingletonClass class name of the ORB returned by init()

These properties allow a different vendor's ORB implementation to be "plugged in."

When an ORB instance is being created, the class name of the ORB implementation is located using the following standard search order:

  1. check in Applet parameter or application string array, if any
  2. check in properties parameter, if any
  3. check in the System properties
  4. check in the orb.properties file located in the user.home directory (if any)
  5. check in the orb.properties file located in the java.home/lib directory (if any)
  6. fall back on a hardcoded default behavior (use the Java IDL implementation)

Note that Java IDL provides a default implementation for the fully-functional ORB and for the Singleton ORB. When the method init is given no parameters, the default Singleton ORB is returned. When the method init is given parameters but no ORB class is specified, the Java IDL ORB implementation is returned.

The following code fragment creates an ORB object initialized with the default ORB Singleton. This ORB has a restricted implementation to prevent malicious applets from doing anything beyond creating typecodes. It is called a singleton because there is only one instance for an entire virtual machine.

ORB orb = ORB.init();

The following code fragment creates an ORB object for an application. The parameter args represents the arguments supplied to the application's main method. Since the property specifies the ORB class to be "SomeORBImplementation", the new ORB will be initialized with that ORB implementation. If p had been null, and the arguments had not specified an ORB class, the new ORB would have been initialized with the default Java IDL implementation.

Properties p = new Properties();
p.put("org.omg.CORBA.ORBClass", "SomeORBImplementation");
ORB orb = ORB.init(args, p);

The following code fragment creates an ORB object for the applet supplied as the first parameter. If the given applet does not specify an ORB class, the new ORB will be initialized with the default Java IDL implementation.

ORB orb = ORB.init(myApplet, null);

An application or applet can be initialized in one or more ORBs. ORB initialization is a bootstrap call into the CORBA world.

version
1.70, 09/09/97
since
JDK1.2

Fields Summary
private static final String
ORBClassKey
private static final String
ORBSingletonClassKey
private static final String
defaultORB
private static final String
defaultORBSingleton
private static ORB
singleton
Constructors Summary
Methods Summary
public voidconnect(org.omg.CORBA.Object obj)
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.

param
obj The servant object reference

	throw new NO_IMPLEMENT();
    
public org.omg.CORBA.TypeCodecreate_abstract_interface_tc(java.lang.String id, java.lang.String name)
Create a TypeCode object for an IDL abstract interface.

param
id the logical id for the abstract interface type.
param
name the name of the abstract interface type.
return
the requested TypeCode.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract TypeCodecreate_alias_tc(java.lang.String id, java.lang.String name, TypeCode original_type)
Creates a TypeCode object representing an IDL alias (typedef). The TypeCode object is initialized with the given id, name, and original type.

param
id the repository id for the alias
param
name the name for the alias
param
original_type the TypeCode object describing the original type for which this is an alias
return
a newly-created TypeCode object describing an IDL alias

public abstract Anycreate_any()
Creates an IDL Any object initialized to contain a Typecode object whose kind field is set to TCKind.tc_null.

return
a newly-created Any object

public abstract TypeCodecreate_array_tc(int length, TypeCode element_type)
Creates a TypeCode object representing an IDL array. The TypeCode object is initialized with the given length and element type.

param
length the length of the array
param
element_type a TypeCode object describing the type of element contained in the array
return
a newly-created TypeCode object describing an IDL array

public org.omg.CORBA.DynAnycreate_basic_dyn_any(org.omg.CORBA.TypeCode type)
Creates a basic DynAny object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynAny object
return
the new DynAny object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract ContextListcreate_context_list()
Creates an empty ContextList object.

return
the newly-created ContextList object
see
ContextList
see
Context

public org.omg.CORBA.DynAnycreate_dyn_any(org.omg.CORBA.Any value)
Creates a new DynAny object from the given Any object.

param
value the Any object from which to create a new DynAny object
return
the new DynAny object created from the given Any object
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.DynArraycreate_dyn_array(org.omg.CORBA.TypeCode type)
Creates a new DynArray object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynArray object
return
the new DynArray object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.DynEnumcreate_dyn_enum(org.omg.CORBA.TypeCode type)
Creates a new DynEnum object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynEnum object
return
the new DynEnum object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.DynSequencecreate_dyn_sequence(org.omg.CORBA.TypeCode type)
Creates a new DynSequence object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynSequence object
return
the new DynSequence object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.DynStructcreate_dyn_struct(org.omg.CORBA.TypeCode type)
Creates a new DynStruct object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynStruct object
return
the new DynStruct object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.DynUnioncreate_dyn_union(org.omg.CORBA.TypeCode type)
Creates a new DynUnion object from the given TypeCode object.

param
type the TypeCode object from which to create a new DynUnion object
return
the new DynUnion object created from the given TypeCode object
throws
org.omg.CORBA.ORBPackage.InconsistentTypeCode if the given TypeCode object is not consistent with the operation.
see
CORBA package comments for unimplemented features
deprecated
Use the new DynAnyFactory API instead

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract TypeCodecreate_enum_tc(java.lang.String id, java.lang.String name, java.lang.String[] members)
Creates a TypeCode object representing an IDL enum. The TypeCode object is initialized with the given id, name, and members.

param
id the repository id for the enum
param
name the name for the enum
param
members an array describing the members of the enum
return
a newly-created TypeCode object describing an IDL enum

public abstract Environmentcreate_environment()
Creates an Environment object.

return
the newly-created Environment object
see
Environment

public abstract ExceptionListcreate_exception_list()
Creates an empty ExceptionList object.

return
the newly-created ExceptionList object

public abstract TypeCodecreate_exception_tc(java.lang.String id, java.lang.String name, StructMember[] members)
Creates a TypeCode object representing an IDL exception. The TypeCode object is initialized with the given id, name, and members.

param
id the repository id for the exception
param
name the name for the exception
param
members an array describing the members of the exception
return
a newly-created TypeCode object describing an IDL exception

public org.omg.CORBA.TypeCodecreate_fixed_tc(short digits, short scale)
Create a TypeCode object for an IDL fixed type.

param
digits specifies the total number of decimal digits in the number and must be from 1 to 31 inclusive.
param
scale specifies the position of the decimal point.
return
the requested TypeCode.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
private static org.omg.CORBA.ORBcreate_impl(java.lang.String className)

        
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        if (cl == null)
            cl = ClassLoader.getSystemClassLoader();

        try {
            return (ORB) Class.forName(className, true, cl).newInstance();
        } catch (Throwable ex) {
	    SystemException systemException = new INITIALIZE(
               "can't instantiate default ORB implementation " + className);
	    systemException.initCause(ex);
	    throw systemException;
        }
    
public abstract TypeCodecreate_interface_tc(java.lang.String id, java.lang.String name)
Creates a TypeCode object representing an IDL interface. The TypeCode object is initialized with the given id and name.

param
id the repository id for the interface
param
name the name for the interface
return
a newly-created TypeCode object describing an IDL interface

public abstract NVListcreate_list(int count)
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.

param
count suggested number of NamedValue objects for which to allocate space
return
the newly-created NVList
see
NVList

public abstract NamedValuecreate_named_value(java.lang.String s, org.omg.CORBA.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.

param
s the name of the NamedValue object
param
any the Any value to be inserted into the NamedValue object
param
flags the argument mode flags for the NamedValue: one of ARG_IN.value, ARG_OUT.value, or ARG_INOUT.value.
return
the newly-created NamedValue object
see
NamedValue

public org.omg.CORBA.TypeCodecreate_native_tc(java.lang.String id, java.lang.String name)
Create a TypeCode object for an IDL native type.

param
id the logical id for the native type.
param
name the name of the native type.
return
the requested TypeCode.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public NVListcreate_operation_list(org.omg.CORBA.Object oper)
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.

param
oper the OperationDef object to use to create the list
return
a newly-created NVList object containing descriptions of the arguments to the method described in the given OperationDef object
see
NVList

	// If we came here, it means that the actual ORB implementation
	// did not have a create_operation_list(...CORBA.Object oper) method,
	// so lets check if it has a create_operation_list(OperationDef oper)
	// method.
	try {
	    // First try to load the OperationDef class
	    String opDefClassName = "org.omg.CORBA.OperationDef";
	    Class opDefClass = null;

	    ClassLoader cl = Thread.currentThread().getContextClassLoader();
	    if ( cl == null )
		cl = ClassLoader.getSystemClassLoader();
	    // if this throws a ClassNotFoundException, it will be caught below.
	    opDefClass = Class.forName(opDefClassName, true, cl);
	    
	    // OK, we loaded OperationDef. Now try to get the
	    // create_operation_list(OperationDef oper) method.
	    Class[] argc = { opDefClass };
            java.lang.reflect.Method meth = 
                this.getClass().getMethod("create_operation_list", argc);

	    // OK, the method exists, so invoke it and be happy.
	    Object[] argx = { oper };
            return (org.omg.CORBA.NVList)meth.invoke(this, argx);
        } 
        catch( java.lang.reflect.InvocationTargetException exs ) {
            Throwable t = exs.getTargetException();
            if (t instanceof Error) {
                throw (Error) t;
            }
            else if (t instanceof RuntimeException) {
                throw (RuntimeException) t;
            }
            else {
                throw new org.omg.CORBA.NO_IMPLEMENT();
            }
        }
	catch( RuntimeException ex ) {
	    throw ex;
	} 
	catch( Exception exr ) {
            throw new org.omg.CORBA.NO_IMPLEMENT();
        }
    
public abstract org.omg.CORBA.portable.OutputStreamcreate_output_stream()
Creates a new org.omg.CORBA.portable.OutputStream into which IDL method parameters can be marshalled during method invocation.

return
the newly-created org.omg.CORBA.portable.OutputStream object

public org.omg.CORBA.Policycreate_policy(int type, org.omg.CORBA.Any val)
Can be invoked to create new instances of policy objects of a specific type with specified initial state. If create_policy fails to instantiate a new Policy object due to its inability to interpret the requested type and content of the policy, it raises the PolicyError exception with the appropriate reason.

param
type the PolicyType of the policy object to be created
param
val the value that will be used to set the initial state of the Policy object that is created
return
Reference to a newly created Policy object of type specified by the type parameter and initialized to a state specified by the val parameter
throws
org.omg.CORBA.PolicyError when the requested policy is not supported or a requested initial state for the policy is not supported.

	// Currently not implemented until PIORB.
        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract TypeCodecreate_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;
};

param
bound the bound for the sequence, 0 if unbounded
param
offset the index to the enclosing TypeCode object that describes the elements of this sequence
return
a newly-created TypeCode object describing a recursive sequence
deprecated
Use a combination of create_recursive_tc and create_sequence_tc instead
see
#create_recursive_tc(String) create_recursive_tc
see
#create_sequence_tc(int, TypeCode) create_sequence_tc

public org.omg.CORBA.TypeCodecreate_recursive_tc(java.lang.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. 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.

param
id the logical id of the referenced type
return
the requested TypeCode

        // implemented in subclass
        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract TypeCodecreate_sequence_tc(int bound, TypeCode element_type)
Creates a TypeCode object representing an IDL sequence. The TypeCode object is initialized with the given bound and element type.

param
bound the bound for the sequence, 0 if unbounded
param
element_type the TypeCode object describing the elements contained in the sequence
return
a newly-created TypeCode object describing an IDL sequence

public abstract TypeCodecreate_string_tc(int bound)
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.

param
bound the bound for the string; cannot be negative
return
a newly-created TypeCode object describing a bounded IDL string
exception
BAD_PARAM if bound is a negative value

public abstract TypeCodecreate_struct_tc(java.lang.String id, java.lang.String name, StructMember[] members)
Creates a TypeCode object representing an IDL struct. The TypeCode object is initialized with the given id, name, and members.

param
id the repository id for the struct
param
name the name of the struct
param
members an array describing the members of the struct
return
a newly-created TypeCode object describing an IDL struct

public abstract TypeCodecreate_union_tc(java.lang.String id, java.lang.String name, TypeCode discriminator_type, UnionMember[] members)
Creates a TypeCode object representing an IDL union. The TypeCode object is initialized with the given id, name, discriminator type, and members.

param
id the repository id of the union
param
name the name of the union
param
discriminator_type the type of the union discriminator
param
members an array describing the members of the union
return
a newly-created TypeCode object describing an IDL union

public org.omg.CORBA.TypeCodecreate_value_box_tc(java.lang.String id, java.lang.String name, TypeCode boxed_type)
Creates a TypeCode object for an IDL value box.

param
id the logical id for the value type
param
name the name of the value type
param
boxed_type the TypeCode for the type
return
the requested TypeCode

        // implemented in subclass
        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public org.omg.CORBA.TypeCodecreate_value_tc(java.lang.String id, java.lang.String name, short type_modifier, TypeCode concrete_base, ValueMember[] members)
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.

param
id the logical id for the value type.
param
name the name of the value type.
param
type_modifier one of the value type modifier constants: VM_NONE, VM_CUSTOM, VM_ABSTRACT or VM_TRUNCATABLE
param
concrete_base a TypeCode object describing the concrete valuetype base
param
members an array containing the members of the value type
return
the requested TypeCode

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract TypeCodecreate_wstring_tc(int bound)
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.

param
bound the bound for the wstring; cannot be negative
return
a newly-created TypeCode object describing a bounded IDL wstring
exception
BAD_PARAM if bound is a negative value

public voiddestroy()
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

	throw new NO_IMPLEMENT();
    
public voiddisconnect(org.omg.CORBA.Object obj)
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.

param
obj The servant object to be disconnected from the ORB

	throw new NO_IMPLEMENT();
    
private static java.lang.StringgetPropertyFromFile(java.lang.String name)

	// This will not throw a SecurityException because this
	// class was loaded from rt.jar using the bootstrap classloader.

        String propValue = (String) AccessController.doPrivileged(
	    new PrivilegedAction() {
		private Properties getFileProperties( String fileName ) {
		    try {
			File propFile = new File( fileName ) ;
			if (!propFile.exists())
			    return null ;

			Properties props = new Properties() ;
			FileInputStream fis = new FileInputStream(propFile);
			try {
			    props.load( fis );
			} finally {
			    fis.close() ;
			}

			return props ;
		    } catch (Exception exc) {
			return null ;
		    }
		}

		public java.lang.Object run() {
		    String userHome = System.getProperty("user.home");
		    String fileName = userHome + File.separator + 
			"orb.properties" ;
		    Properties props = getFileProperties( fileName ) ;

		    if (props != null) {
			String value = props.getProperty( name ) ;
			if (value != null) 
			    return value ;
		    }
			
		    String javaHome = System.getProperty("java.home");
		    fileName = javaHome + File.separator
			+ "lib" + File.separator + "orb.properties";
		    props = getFileProperties( fileName ) ;

		    if (props == null) 
			return null ;
		    else
			return props.getProperty( name ) ;
		}	
	    }
	);

	return propValue;
    
private static java.lang.StringgetSystemProperty(java.lang.String name)


    // Get System property
          

	// This will not throw a SecurityException because this
	// class was loaded from rt.jar using the bootstrap classloader.
        String propValue = (String) AccessController.doPrivileged(
	    new PrivilegedAction() {
		public java.lang.Object run() {
	            return System.getProperty(name);
	        }
            }
	);

	return propValue;
    
public org.omg.CORBA.Currentget_current()
Retrieves a Current object. The Current interface is used to manage thread-specific information for use by services such as transactions and security.

see
CORBA package comments for unimplemented features
return
a newly-created Current object
deprecated
use resolve_initial_references.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract Contextget_default_context()
Gets the default Context object.

return
the default Context object
see
Context

public abstract Requestget_next_response()
Gets the next Request instance for which a response has been received.

return
the next Request object ready with a response
exception
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.

public abstract TypeCodeget_primitive_tc(TCKind tcKind)
Retrieves the TypeCode object that represents the given primitive IDL type.

param
tcKind the TCKind instance corresponding to the desired primitive type
return
the requested TypeCode object

public booleanget_service_information(short service_type, ServiceInformationHolder service_info)
Used to obtain information about CORBA facilities and services that are supported by this ORB. The service type for which information is being requested is passed in as the in parameter service_type, the values defined by constants in the CORBA module. If service information is available for that type, that is returned in the out parameter service_info, and the operation returns the value true. If no information for the requested services type is available, the operation returns false (i.e., the service is not supported by this ORB).

param
service_type a short indicating the service type for which information is being requested
param
service_info a ServiceInformationHolder object that will hold the ServiceInformation object produced by this method
return
true if service information is available for the service_type; false if no information for the requested services type is available
see
CORBA package comments for unimplemented features

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public static org.omg.CORBA.ORBinit()
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.

return
the singleton ORB

        if (singleton == null) {
            String className = getSystemProperty(ORBSingletonClassKey);
            if (className == null)
                className = getPropertyFromFile(ORBSingletonClassKey);
            if (className == null)
                className = defaultORBSingleton;

            singleton = create_impl(className);
        }
	return singleton;
    
public static org.omg.CORBA.ORBinit(java.lang.String[] args, java.util.Properties props)
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.

param
args command-line arguments for the application's main method; may be null
param
props application-specific properties; may be null
return
the newly-created ORB instance

	//
	// Note that there is no standard command-line argument for
	// specifying the default ORB implementation. For an
	// application you can choose an implementation either by
	// setting the CLASSPATH to pick a different org.omg.CORBA
	// and it's baked-in ORB implementation default or by
	// setting an entry in the properties object or in the
	// system properties.
	//
        String className = null;
	ORB orb;

	if (props != null)
	    className = props.getProperty(ORBClassKey);
	if (className == null)
	    className = getSystemProperty(ORBClassKey);
	if (className == null)
            className = getPropertyFromFile(ORBClassKey);
        if (className == null)
            className = defaultORB;

	orb = create_impl(className);
	orb.set_parameters(args, props);
	return orb;
    
public static org.omg.CORBA.ORBinit(java.applet.Applet app, java.util.Properties props)
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.

param
app the applet; may be null
param
props applet-specific properties; may be null
return
the newly-created ORB instance

        String className;
	ORB orb;

        className = app.getParameter(ORBClassKey);
	if (className == null && props != null)
	    className = props.getProperty(ORBClassKey);
	if (className == null)
	    className = getSystemProperty(ORBClassKey);
	if (className == null)
            className = getPropertyFromFile(ORBClassKey);
        if (className == null)
            className = defaultORB;

        orb = create_impl(className);
        orb.set_parameters(app, props);
	return orb;
    
public abstract java.lang.String[]list_initial_services()
Returns a list of the initially available CORBA object references, such as "NameService" and "InterfaceRepository".

return
an array of String objects that represent the object references for CORBA services that are initially available with this ORB

public abstract java.lang.Stringobject_to_string(org.omg.CORBA.Object obj)
Converts the given CORBA object reference to a string. Note that the format of this string is predefined by IIOP, allowing strings generated by a different ORB to be converted back into an object reference.

The resulting String object may be stored or communicated in any way that a String object can be manipulated.

param
obj the object reference to stringify
return
the string representing the object reference

public voidperform_work()
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.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract booleanpoll_next_response()
Finds out if any of the deferred (asynchronous) invocations have a response yet.

return
true if there is a response available; false otherwise

public abstract org.omg.CORBA.Objectresolve_initial_references(java.lang.String object_name)
Resolves a specific object reference from the set of available initial service names.

param
object_name the name of the initial service as a string
return
the object reference associated with the given name
exception
InvalidName if the given name is not associated with a known service

public voidrun()
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.

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract voidsend_multiple_requests_deferred(Request[] req)
Sends multiple dynamic (DII) requests asynchronously.

param
req an array of Request objects

public abstract voidsend_multiple_requests_oneway(Request[] req)
Sends multiple dynamic (DII) requests asynchronously without expecting any responses. Note that oneway invocations are not guaranteed to reach the server.

param
req an array of request objects

protected abstract voidset_parameters(java.lang.String[] args, java.util.Properties props)
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.

param
args command-line arguments for the application's main method; may be null
param
props application-specific properties; may be null

protected abstract voidset_parameters(java.applet.Applet app, java.util.Properties props)
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.

param
app the applet; may be null
param
props applet-specific properties; may be null

public voidshutdown(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. 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.

param
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

        throw new org.omg.CORBA.NO_IMPLEMENT();
    
public abstract org.omg.CORBA.Objectstring_to_object(java.lang.String str)
Converts a string produced by the method object_to_string back to a CORBA object reference.

param
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.
return
the object reference

public booleanwork_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.

return
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

        throw new org.omg.CORBA.NO_IMPLEMENT();