diff options
Diffstat (limited to 'libjava/classpath/javax/rmi/CORBA/Util.java')
| -rw-r--r-- | libjava/classpath/javax/rmi/CORBA/Util.java | 413 |
1 files changed, 322 insertions, 91 deletions
diff --git a/libjava/classpath/javax/rmi/CORBA/Util.java b/libjava/classpath/javax/rmi/CORBA/Util.java index 0370cce83a2..cfd3d7bd686 100644 --- a/libjava/classpath/javax/rmi/CORBA/Util.java +++ b/libjava/classpath/javax/rmi/CORBA/Util.java @@ -1,5 +1,5 @@ -/* Util.java -- - Copyright (C) 2002, 2004 Free Software Foundation, Inc. +/* Util.java -- + Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -38,148 +38,379 @@ exception statement from your version. */ package javax.rmi.CORBA; +import org.omg.CORBA.Any; +import org.omg.CORBA.BAD_PARAM; +import org.omg.CORBA.COMM_FAILURE; +import org.omg.CORBA.CompletionStatus; +import org.omg.CORBA.INVALID_TRANSACTION; +import org.omg.CORBA.INV_OBJREF; +import org.omg.CORBA.MARSHAL; +import org.omg.CORBA.NO_PERMISSION; +import org.omg.CORBA.OBJECT_NOT_EXIST; +import org.omg.CORBA.OMGVMCID; +import org.omg.CORBA.ORB; +import org.omg.CORBA.SystemException; +import org.omg.CORBA.TRANSACTION_REQUIRED; +import org.omg.CORBA.TRANSACTION_ROLLEDBACK; +import org.omg.CORBA.TypeCode; +import org.omg.CORBA.portable.InputStream; +import org.omg.CORBA.portable.OutputStream; + import gnu.javax.rmi.CORBA.DelegateFactory; -import gnu.javax.rmi.CORBA.GetDelegateInstanceException; -import java.io.InputStream; -import java.io.OutputStream; +import java.rmi.AccessException; +import java.rmi.MarshalException; +import java.rmi.NoSuchObjectException; import java.rmi.Remote; import java.rmi.RemoteException; +import java.rmi.ServerError; +import java.rmi.ServerException; +import java.rmi.UnexpectedException; +import java.rmi.server.RMIClassLoader; + +import javax.transaction.InvalidTransactionException; +import javax.transaction.TransactionRequiredException; +import javax.transaction.TransactionRolledbackException; +/** + * 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}. + * + * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) + */ public class Util { + /** + * The delegate, responsible for all functionality. + */ + static UtilDelegate delegate = (UtilDelegate) DelegateFactory.getInstance(DelegateFactory.UTIL); - private static UtilDelegate delegate; - static - { - try - { - delegate = (UtilDelegate)DelegateFactory.getInstance("Util"); - } - catch(GetDelegateInstanceException e) - { - delegate = null; - } - } - + /** + * Prevents this class from being instantiated. + */ private Util() { } - // XXX - javax.rmi.ORB -> org.omg.CORBA.ORB - public static Object copyObject(Object obj, javax.rmi.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 java.lang.Object copyObject(java.lang.Object object, ORB orb) throws RemoteException { - if(delegate != null) - return delegate.copyObject(obj, orb); - else - return null; + return delegate.copyObject(object, orb); } - // XXX - javax.rmi.ORB -> org.omg.CORBA.ORB - public static Object[] copyObjects(Object obj[], javax.rmi.ORB orb) + /** + * Used by local stubs to create a multiple copies of the object, preserving + * sharing accross the parameters if necessary. + */ + public static java.lang.Object[] copyObjects(java.lang.Object[] object, + ORB orb) throws RemoteException { - if(delegate != null) - return delegate.copyObjects(obj, orb); - else - return null; + return delegate.copyObjects(object, orb); } - + + /** + * 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}. + */ public static ValueHandler createValueHandler() { - if(delegate != null) - return delegate.createValueHandler(); - else - return null; + return delegate.createValueHandler(); } - + + /** + * This call is finally delegated to {@link RMIClassLoader#getClassAnnotation}; + */ public static String getCodebase(Class clz) { - if(delegate != null) - return delegate.getCodebase(clz); - else - return null; + return delegate.getCodebase(clz); } - + + /** + * 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. + * + * @return the Tie. + */ public static Tie getTie(Remote target) { - if(delegate != null) - return delegate.getTie(target); - else - return null; + return delegate.getTie(target); } + /** + * Checks if the given stub is local. The implementation it delegates call to + * {@link ObjectImpl#_is_local(). + * + * @param stub a stub to check. + * @return true if the stub is local, false otherwise. + * + * @throws RemoteException if the {@link ObjectImpl#_is_local()} throws a + * {@link org.omg.CORBA.SystemException}. + */ public static boolean isLocal(Stub stub) throws RemoteException { - if(delegate != null) - return delegate.isLocal(stub); - else - return false; + return delegate.isLocal(stub); } - 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". + * + * <ul> + * <li>If remoteCodebase is non-null and useCodebaseOnly is "false" then call + * java.rmi.server.RMIClassLoader.loadClass (remoteCodebase, className)</li> + * <li> If remoteCodebase is null or useCodebaseOnly is true then call + * java.rmi.server.RMIClassLoader.loadClass(className)</li> + * <li>If a class is still not successfully loaded and the loader != null + * then try Class.forName(className, false, loader). </li> + * </ul> + * + * @param className the name of the class. + * @param remoteCodebase the codebase. + * @param loader the class loader. + * @return the loaded class. + * + * @throws ClassNotFoundException of the class cannot be loaded. + */ + public static Class loadClass(String className, String remoteCodebase, + ClassLoader loader) throws ClassNotFoundException { - if(delegate != null) - return delegate.loadClass(className, remoteCodebase, loader); - else - throw new ClassNotFoundException(className + ": delegate == null"); - } - - public static RemoteException mapSystemException(SystemException ex) - { - if(delegate != null) - return delegate.mapSystemException(ex); - else - return null; + return delegate.loadClass(className, remoteCodebase, loader); } - public static Object readAny(InputStream in) + /** + * Converts CORBA {@link SystemException} into RMI {@link RemoteException}. + * The exception is converted as defined in the following table: + * <p> + * <table border = "1"> + * <tr> + * <th>CORBA Exception</th> + * <th>RMI Exception</th> + * </tr> + * <tr> + * <td>{@link COMM_FAILURE}</td> + * <td>{@link MarshalException}</td> + * </tr> + * <tr> + * <td>{@link INV_OBJREF}</td> + * <td>{@link NoSuchObjectException}</td> + * </tr> + * <tr> + * <td>{@link NO_PERMISSION}</td> + * <td>{@link AccessException}</td> + * </tr> + * <tr> + * <td>{@link MARSHAL}</td> + * <td>{@link MarshalException}</td> + * </tr> + * <tr> + * <td>{@link BAD_PARAM} (all other cases)</td> + * <td>{@link MarshalException}</td> + * </tr> + * <tr> + * <td>{@link OBJECT_NOT_EXIST}</td> + * <td>{@link NoSuchObjectException}</td> + * </tr> + * <tr> + * <td>{@link TRANSACTION_REQUIRED}</td> + * <td>{@link TransactionRequiredException}</td> + * </tr> + * <tr> + * <td>{@link TRANSACTION_ROLLEDBACK}</td> + * <td>{@link TransactionRolledbackException}</td> + * </tr> + * <tr> + * <td>{@link INVALID_TRANSACTION}</td> + * <td>{@link InvalidTransactionException}</td> + * </tr> + * <tr> + * <td bgcolor="lightgray">Any other {@link SystemException}</td> + * <td bgcolor="lightgray">{@link RemoteException}</td> + * </tr> + * </table> + * </p> + * <p> + * The exception detailed message always consists of + * <ol> + * <li>the string "CORBA "</li> + * <li>the CORBA name of the system exception</li> + * <li>single space</li> + * <li>the hexadecimal value of the system exception's minor code, preceeded + * by 0x (higher bits contain {@link OMGVMCID}).</li> + * <li>single space</li> + * <li>the {@link CompletionStatus} of the exception: "Yes", "No" or "Maybe".</li> + * </ol> + * The subsequent content is not part of the official RMI-IIOP standart and is + * added for compatibility with Sun's implementation: + * <ol> + * <li>the phrase "<code>; nested exception is: <i>(line feed)(tab)</i></code>"</li> + * <li>the full name of the mapped SystemException, as returned by + * Class.getName().</li> + * <li>the ": ". + * <li>the value, returned by .getMessage() of the passed parameter.</li> + * </ol> + * <p> + * For instance, if the Internet connection was refused: + * </p><p> + * <code>CORBA COMM_FAILURE 0x535500C9 No</code> + * </p><p> + * The original CORBA exception is set as the cause of the RemoteException + * being created. + * </p> + */ + public static RemoteException mapSystemException(SystemException ex) { - if(delegate != null) - return delegate.readAny(in); - else - return null; + return delegate.mapSystemException(ex); } + /** + * 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 registerTarget(Tie tie, Remote target) { - if(delegate != null) - delegate.registerTarget(tie, target); + delegate.registerTarget(tie, 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 void unexportObject(Remote target) + throws NoSuchObjectException { - if(delegate != null) - delegate.unexportObject(target); + delegate.unexportObject(target); } - - public static RemoteException wrapException(Throwable orig) + + /** + * 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: <table border = "1"> + * <tr> + * <th>Exception to map (or subclass)</th> + * <th>Maps into</th> + * </tr> + * <tr> + * <td>{@link Error}</td> + * <td>{@link ServerError}</td> + * </tr> + * <tr> + * <td>{@link RemoteException}</td> + * <td>{@link ServerException}</td> + * </tr> + * <tr> + * <td>{@link SystemException}</td> + * <td>wrapException({@link #mapSystemException})</td> + * </tr> + * <tr> + * <td>{@link RuntimeException}</td> + * <td><b>rethrows</b></td> + * </tr> + * <tr> + * <td>Any other exception</td> + * <td>{@link UnexpectedException}</td> + * </tr> + * </table> + * + * @param ex an exception that was thrown on a server side implementation. + * + * @return the corresponding RemoteException unless it is a RuntimeException. + * + * @throws RuntimeException the passed exception if it is an instance of + * RuntimeException. + * + * @specnote It is the same behavior, as in Suns implementations 1.4.0-1.5.0. + */ + public static RemoteException wrapException(Throwable exception) { - if(delegate != null) - return delegate.wrapException(orig); - else - return null; + return delegate.wrapException(exception); } - - public static void writeAbstractObject(OutputStream out, Object obj) + + /** + * 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)}. + * + * @param output a stream to write to, must be + * {@link org.omg.CORBA_2_3.portable.OutputStream}. + * + * @param object an object to write, must be CORBA object, Remote + */ + public static void writeAbstractObject(OutputStream output, + java.lang.Object object) { - if(delegate != null) - delegate.writeAbstractObject(out, obj); + delegate.writeAbstractObject(output, object); } - - public static void writeAny(OutputStream out, Object obj) + + /** + * 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. + * + * @param output the object to write. + * @param object the java object that must be written in the form of the CORBA + * {@link Any}. + */ + public static void writeAny(OutputStream output, java.lang.Object object) { - if(delegate != null) - delegate.writeAny(out, obj); + delegate.writeAny(output, object); } - - public static void writeRemoteObject(OutputStream out, Object obj) + + /** + * Read Any from the input stream. + */ + public static java.lang.Object readAny(InputStream input) { - if(delegate != null) - delegate.writeRemoteObject(out, obj); + return delegate.readAny(input); } -} + /** + * 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. + * + * @param output a stream to write to, must be + * org.omg.CORBA_2_3.portable.OutputStream + * @param object an object to write. + */ + public static void writeRemoteObject(OutputStream output, + java.lang.Object object) + { + delegate.writeRemoteObject(output, object); + } +}
\ No newline at end of file |