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
UtilDelegate.
Method Summary |
static Object | copyObject(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 ValueHandler | createValueHandler()
Get the value handler that Serializes Java objects to and from CDR (GIOP)
streams.
|
static String | getCodebase(Class clz)
This call is finally delegated to RMIClassLoader#getClassAnnotation; |
static Tie | getTie(Remote target)
Get the Tie that handles invocations on the given target. |
static boolean | isLocal(Stub stub)
Checks if the given stub is local. |
static Class | loadClass(String className, String remoteCodebase, ClassLoader loader)
Load the class. |
static RemoteException | mapSystemException(SystemException ex)
Converts CORBA SystemException into RMI RemoteException.
|
static Object | readAny(InputStream input)
Read Any from the input stream. |
static void | registerTarget(Tie tie, Remote target)
Register the Tie-target pair. |
static void | unexportObject(Remote target)
Deactivate the associated Tie, if it is found and is not connected to other
registered targets. |
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. |
static void | writeAbstractObject(OutputStream output, Object object)
Write abstract interface to the CORBA output stream. |
static void | writeAny(OutputStream output, Object object)
Write the passed java object to the output stream in the form of the CORBA
Any. |
static void | writeRemoteObject(OutputStream output, Object object)
Write the passed parameter to the output stream as CORBA object. |
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.
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.
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
ValueHandler.
public static String getCodebase(Class clz)
This call is finally delegated to RMIClassLoader#getClassAnnotation;
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
Util,
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.
public static boolean isLocal(
Stub stub)
Checks if the given stub is local. The implementation it delegates call to
ObjectImpl#_is_local().
Parameters: stub a stub to check.
Returns: true if the stub is local, false otherwise.
Throws: RemoteException if the ObjectImpl#_is_local() throws a
org.omg.CORBA.SystemException.
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".
- If remoteCodebase is non-null and useCodebaseOnly is "false" then call
java.rmi.server.RMIClassLoader.loadClass (remoteCodebase, className)
- If remoteCodebase is null or useCodebaseOnly is true then call
java.rmi.server.RMIClassLoader.loadClass(className)
- If a class is still not successfully loaded and the loader != null
then try Class.forName(className, false, loader).
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.
public static RemoteException mapSystemException(SystemException ex)
Converts CORBA SystemException into RMI RemoteException.
The exception is converted as defined in the following table:
CORBA Exception |
RMI Exception |
COMM_FAILURE |
MarshalException |
INV_OBJREF |
NoSuchObjectException |
NO_PERMISSION |
AccessException |
MARSHAL |
MarshalException |
BAD_PARAM (all other cases) |
MarshalException |
OBJECT_NOT_EXIST |
NoSuchObjectException |
TRANSACTION_REQUIRED |
TransactionRequiredException |
TRANSACTION_ROLLEDBACK |
TransactionRolledbackException |
INVALID_TRANSACTION |
InvalidTransactionException |
Any other SystemException |
RemoteException |
The exception detailed message always consists of
- the string "CORBA "
- the CORBA name of the system exception
- single space
- the hexadecimal value of the system exception's minor code, preceeded
by 0x (higher bits contain OMGVMCID).
- single space
- the 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:
- the phrase "
; nested exception is: (line feed)(tab)
"
- the full name of the mapped SystemException, as returned by
Class.getName().
- the ": ".
- 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.
public static Object readAny(InputStream input)
Read Any from the input stream.
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.
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.
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 |
Error |
ServerError |
RemoteException |
ServerException |
SystemException |
wrapException(Util) |
RuntimeException |
rethrows |
Any other exception |
UnexpectedException |
Parameters: exception 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.
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. Remotes are processed as defined in
Util. The written data contains discriminator,
defining, that was written. Another method that writes the same content is
org.omg.CORBA_2_3.portable.OutputStream#write_abstract_interface(java.lang.Object).
Parameters: output a stream to write to, must be
org.omg.CORBA_2_3.portable.OutputStream.
object an object to write, must be CORBA object, Remote
public static void writeAny(OutputStream output, Object object)
Write the passed java object to the output stream in the form of the CORBA
Any. This includes creating an writing the object TypeCode
first. Such Any can be later read by a non-RMI-IIOP CORBA implementation
and manipulated, for instance, by means, provided in
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
Any.
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
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.