javax.rmi.CORBA

Class Util

public class Util extends Object

Provides utility methods used by stubs and ties to perform common operations. The functionality is forwarded to the enclosed UtilDelegate. This delegate can be altered by setting the system property "javax.rmi.CORBA.UtilClass" to the name of the alternative class that must implement {@link UtilDelegate}.
Method Summary
static ObjectcopyObject(Object object, ORB orb)
Used by local stubs to create a copy of the object.
static Object[]copyObjects(Object[] object, ORB orb)
Used by local stubs to create a multiple copies of the object, preserving sharing accross the parameters if necessary.
static ValueHandlercreateValueHandler()
Get the value handler that Serializes Java objects to and from CDR (GIOP) streams.
static StringgetCodebase(Class clz)
This call is finally delegated to {@link RMIClassLoader#getClassAnnotation};
static TiegetTie(Remote target)
Get the Tie that handles invocations on the given target.
static booleanisLocal(Stub stub)
Checks if the given stub is local.
static ClassloadClass(String className, String remoteCodebase, ClassLoader loader)
Load the class.
static RemoteExceptionmapSystemException(SystemException ex)
Converts CORBA {@link SystemException} into RMI {@link RemoteException}.
static ObjectreadAny(InputStream input)
Read Any from the input stream.
static voidregisterTarget(Tie tie, Remote target)
Register the Tie-target pair.
static voidunexportObject(Remote target)
Deactivate the associated Tie, if it is found and is not connected to other registered targets.
static RemoteExceptionwrapException(Throwable exception)
Converts the exception that was thrown by the implementation method on a server side into RemoteException that can be transferred and re-thrown on a client side.
static voidwriteAbstractObject(OutputStream output, Object object)
Write abstract interface to the CORBA output stream.
static voidwriteAny(OutputStream output, Object object)
Write the passed java object to the output stream in the form of the CORBA {@link Any}.
static voidwriteRemoteObject(OutputStream output, Object object)
Write the passed parameter to the output stream as CORBA object.

Method Detail

copyObject

public static Object copyObject(Object object, ORB orb)
Used by local stubs to create a copy of the object. The object must be Serializable for this operation to succeed. Strings are not copied and 1D-3D string arrays are only cloned.

copyObjects

public static Object[] copyObjects(Object[] object, ORB orb)
Used by local stubs to create a multiple copies of the object, preserving sharing accross the parameters if necessary.

createValueHandler

public static ValueHandler createValueHandler()
Get the value handler that Serializes Java objects to and from CDR (GIOP) streams. When using the default Util implementation, the class of the returned handler can be altered by setting by setting the system property "javax.rmi.CORBA.ValueHandlerClass" to the name of the alternative class that must implement {@link ValueHandler}.

getCodebase

public static String getCodebase(Class clz)
This call is finally delegated to {@link RMIClassLoader#getClassAnnotation};

getTie

public static Tie getTie(Remote target)
Get the Tie that handles invocations on the given target. If the target/Tie pair has not been previously registered using {@link #registerTarget}, this method tries to locate a tie class by the name pattern. If this succeeds, the tie-target pair is also registered.

Returns: the Tie.

isLocal

public static boolean isLocal(Stub stub)
Checks if the given stub is local. The implementation it delegates call to {@link ObjectImpl#_is_local().

Parameters: stub a stub to check.

Returns: true if the stub is local, false otherwise.

Throws: RemoteException if the {@link ObjectImpl#_is_local()} throws a {@link org.omg.CORBA.SystemException}.

loadClass

public static Class loadClass(String className, String remoteCodebase, ClassLoader loader)
Load the class. The method uses class loaders from the call stact first. If this fails, the further behaviour depends on the System Property "java.rmi.server.useCodebaseOnly" with default value "false".

Parameters: className the name of the class. remoteCodebase the codebase. loader the class loader.

Returns: the loaded class.

Throws: ClassNotFoundException of the class cannot be loaded.

mapSystemException

public static RemoteException mapSystemException(SystemException ex)
Converts CORBA {@link SystemException} into RMI {@link RemoteException}. The exception is converted as defined in the following table:

CORBA Exception RMI Exception
{@link COMM_FAILURE} {@link MarshalException}
{@link INV_OBJREF} {@link NoSuchObjectException}
{@link NO_PERMISSION} {@link AccessException}
{@link MARSHAL} {@link MarshalException}
{@link BAD_PARAM} (all other cases) {@link MarshalException}
{@link OBJECT_NOT_EXIST} {@link NoSuchObjectException}
{@link TRANSACTION_REQUIRED} {@link TransactionRequiredException}
{@link TRANSACTION_ROLLEDBACK} {@link TransactionRolledbackException}
{@link INVALID_TRANSACTION} {@link InvalidTransactionException}
Any other {@link SystemException} {@link RemoteException}

The exception detailed message always consists of

  1. the string "CORBA "
  2. the CORBA name of the system exception
  3. single space
  4. the hexadecimal value of the system exception's minor code, preceeded by 0x (higher bits contain {@link OMGVMCID}).
  5. single space
  6. the {@link CompletionStatus} of the exception: "Yes", "No" or "Maybe".
The subsequent content is not part of the official RMI-IIOP standart and is added for compatibility with Sun's implementation:
  1. the phrase "; nested exception is: (line feed)(tab)"
  2. the full name of the mapped SystemException, as returned by Class.getName().
  3. the ": ".
  4. the value, returned by .getMessage() of the passed parameter.

For instance, if the Internet connection was refused:

CORBA COMM_FAILURE 0x535500C9 No

The original CORBA exception is set as the cause of the RemoteException being created.

readAny

public static Object readAny(InputStream input)
Read Any from the input stream.

registerTarget

public static void registerTarget(Tie tie, Remote target)
Register the Tie-target pair. As the Tie is a Servant, it can potentially be connected to several objects and hence may be registered with several targets.

unexportObject

public static void unexportObject(Remote target)
Deactivate the associated Tie, if it is found and is not connected to other registered targets. Independing from the POA policies, the transparent reactivation will not be possible.

wrapException

public static RemoteException wrapException(Throwable exception)
Converts the exception that was thrown by the implementation method on a server side into RemoteException that can be transferred and re-thrown on a client side. The method converts exceptions as defined in the following table:
Exception to map (or subclass) Maps into
{@link Error} {@link ServerError}
{@link RemoteException} {@link ServerException}
{@link SystemException} wrapException({@link #mapSystemException})
{@link RuntimeException} rethrows
Any other exception {@link UnexpectedException}

Parameters: ex an exception that was thrown on a server side implementation.

Returns: the corresponding RemoteException unless it is a RuntimeException.

Throws: RuntimeException the passed exception if it is an instance of RuntimeException.

UNKNOWN: It is the same behavior, as in Suns implementations 1.4.0-1.5.0.

writeAbstractObject

public static void writeAbstractObject(OutputStream output, Object object)
Write abstract interface to the CORBA output stream. The write format is matching CORBA abstract interface. Remotes and CORBA objects are written as objects, other classes are supposed to be value types and are written as such. {@link Remote}s are processed as defined in {@link #writeRemoteObject}. The written data contains discriminator, defining, that was written. Another method that writes the same content is {@link org.omg.CORBA_2_3.portable.OutputStream#write_abstract_interface(java.lang.Object)}.

Parameters: output a stream to write to, must be {@link org.omg.CORBA_2_3.portable.OutputStream}. object an object to write, must be CORBA object, Remote

writeAny

public static void writeAny(OutputStream output, Object object)
Write the passed java object to the output stream in the form of the CORBA {@link Any}. This includes creating an writing the object {@link TypeCode} first. Such Any can be later read by a non-RMI-IIOP CORBA implementation and manipulated, for instance, by means, provided in {@link org.omg.DynamicAny.DynAny}. Depending from the passed value, this method writes CORBA object, value type or value box. For value types Null is written with the abstract interface, its typecode having repository id "IDL:omg.org/CORBA/AbstractBase:1.0" and the empty string name.

Parameters: output the object to write. object the java object that must be written in the form of the CORBA {@link Any}.

writeRemoteObject

public static void writeRemoteObject(OutputStream output, Object object)
Write the passed parameter to the output stream as CORBA object. If the parameter is an instance of Remote and not an instance of Stub, the method instantiates a suitable Tie, connects the parameter to this Tie and then connects that Tie to the ORB that is requested from the output stream. Then the object reference is written to the stream, making remote invocations possible (the ORB is started and activated, if required). This method is used in write_value(..) method group in {@link org.omg.CORBA_2_3.portable.OutputStream} and also may be called directly from generated Stubs and Ties.

Parameters: output a stream to write to, must be org.omg.CORBA_2_3.portable.OutputStream object an object to write.