javax.rmi.CORBA

Interface UtilDelegate

Known Implementing Classes:
UtilDelegateImpl

public interface UtilDelegate

A delegate, implementing the functionality, provided by the Util. The default delegate can be altered by setting the system property "javax.rmi.CORBA.UtilClass" to the name of the alternative class that must implement this interface.

Method Summary

Object
copyObject(Object obj, ORB orb)
Used by local stubs to create a copy of the object.
Object[]
copyObjects(Object[] obj, ORB orb)
Used by local stubs to create a multiple copies of the object, preserving sharing accross the parameters if necessary.
ValueHandler
createValueHandler()
Get the value handler that Serializes Java objects to and from CDR (GIOP) streams.
String
getCodebase(Class<T> clz)
Tie
getTie(Remote target)
Get the Tie that handles invocations on the given target.
boolean
isLocal(Stub stub)
Checks if the given stub is local.
Class<T>
loadClass(String className, String remoteCodebase, ClassLoader loader)
RemoteException
mapSystemException(SystemException ex)
Converts CORBA SystemException into RMI RemoteException.
Object
readAny(InputStream input)
Read Any from the input stream.
void
registerTarget(Tie tie, Remote target)
Register the Tie-target pair.
void
unexportObject(Remote target)
Deactivate the associated Tie, if it is found and is not connected to other registered targets.
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.
void
writeAbstractObject(OutputStream output, Object object)
Write abstract interface to the CORBA output stream.
void
writeAny(OutputStream output, Object object)
Write the passed java object to the output stream in the form of the CORBA Any.
void
writeRemoteObject(OutputStream output, Object obj)
Write the passed parameter to the output stream as CORBA object.

Method Details

copyObject

public Object copyObject(Object obj,
                         ORB orb)
            throws RemoteException
Used by local stubs to create a copy of the object.

copyObjects

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

createValueHandler

public ValueHandler createValueHandler()
Get the value handler that Serializes Java objects to and from CDR (GIOP) streams.

getCodebase

public String getCodebase(Class<T> clz)

getTie

public Tie getTie(Remote target)
Get the Tie that handles invocations on the given target. The target/Tie pair must be previously registered using registerTarget(Tie,Remote).
Returns:
the Tie, or null if no such is known.

isLocal

public boolean isLocal(Stub stub)
            throws RemoteException
Checks if the given stub is local.

loadClass

public Class<T> loadClass(String className,
                       String remoteCodebase,
                       ClassLoader loader)
            throws ClassNotFoundException

mapSystemException

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

CORBA ExceptionRMI Exception
COMM_FAILUREMarshalException
INV_OBJREFNoSuchObjectException
NO_PERMISSIONAccessException
MARSHALMarshalException
BAD_PARAM (all other cases)MarshalException
OBJECT_NOT_EXISTNoSuchObjectException
TRANSACTION_REQUIREDTransactionRequiredException
TRANSACTION_ROLLEDBACKTransactionRolledbackException
INVALID_TRANSACTIONInvalidTransactionException
Any other SystemExceptionRemoteException

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 OMGVMCID).
  5. single space
  6. 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:
  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 Object readAny(InputStream input)
Read Any from the input stream.

registerTarget

public void registerTarget(Tie tie,
                           Remote target)
Register the Tie-target pair.

unexportObject

public void unexportObject(Remote target)
            throws NoSuchObjectException
Deactivate the associated Tie, if it is found and is not connected to other registered targets.

wrapException

public 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:
Exception to map (or subclass)Maps into
ErrorServerError
RemoteExceptionServerException
SystemExceptionwrapException(mapSystemException(SystemException))
RuntimeExceptionrethrows
Any other exceptionUnexpectedException
Parameters:
Returns:
the corresponding RemoteException unless it is a RuntimeException.
Throws:
RuntimeException - the passed exception if it is an instance of RuntimeException.

writeAbstractObject

public 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 writeRemoteObject(OutputStream,Object). The written data contains discriminator, defining, that was written. Another method that writes the same content is OutputStream.write_abstract_interface(Object).
Parameters:
output - a stream to write to, must be OutputStream.
object - an object to write, must be CORBA object, Remote

writeAny

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

writeRemoteObject

public void writeRemoteObject(OutputStream output,
                              Object obj)
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. This method is used in write_value(..) method group in 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
obj - an object to write.

UtilDelegate.java -- Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.