Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> rmi >> [ CORBA overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.rmi.CORBA
Class Util  

java.lang.Object
  javax.rmi.CORBA.Util

---

public class Util

extends java.lang.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.

---

Field Summary
(package private) static UtilDelegate	delegate           The delegate, responsible for all functionality.

 

Constructor Summary
private	Util()           Prevents this class from being instantiated.

 

Method Summary
static java.lang.Object	copyObject(java.lang.Object object, org.omg.CORBA.ORB orb)           Used by local stubs to create a copy of the object.
static java.lang.Object[]	copyObjects(java.lang.Object[] object, org.omg.CORBA.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 java.lang.String	getCodebase(java.lang.Class clz)           This call is finally delegated to RMIClassLoader.getClassAnnotation(java.lang.Class)>RMIClassLoader.getClassAnnotation(java.lang.Class) 55 ;
static Tie	getTie(java.rmi.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 java.lang.Class	loadClass(java.lang.String className, java.lang.String remoteCodebase, java.lang.ClassLoader loader)           Load the class.
static java.rmi.RemoteException	mapSystemException(org.omg.CORBA.SystemException ex)           Converts CORBA SystemException into RMI java.rmi.RemoteException.
static java.lang.Object	readAny(org.omg.CORBA.portable.InputStream input)           Read Any from the input stream.
static void	registerTarget(Tie tie, java.rmi.Remote target)           Register the Tie-target pair.
static void	unexportObject(java.rmi.Remote target)           Deactivate the associated Tie, if it is found and is not connected to other registered targets.
static java.rmi.RemoteException	wrapException(java.lang.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(org.omg.CORBA.portable.OutputStream output, java.lang.Object object)           Write abstract interface to the CORBA output stream.
static void	writeAny(org.omg.CORBA.portable.OutputStream output, java.lang.Object object)           Write the passed java object to the output stream in the form of the CORBA org.omg.CORBA.Any.
static void	writeRemoteObject(org.omg.CORBA.portable.OutputStream output, java.lang.Object object)           Write the passed parameter to the output stream as CORBA object.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

delegate

static UtilDelegate delegate

The delegate, responsible for all functionality.

Constructor Detail

Util

private Util()

Prevents this class from being instantiated.

Method Detail

copyObject

public static java.lang.Object copyObject(java.lang.Object object,
                                          org.omg.CORBA.ORB orb)
                                   throws java.rmi.RemoteException

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 java.lang.Object[] copyObjects(java.lang.Object[] object,
                                             org.omg.CORBA.ORB orb)
                                      throws java.rmi.RemoteException

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

---

getCodebase

public static java.lang.String getCodebase(java.lang.Class clz)

This call is finally delegated to RMIClassLoader.getClassAnnotation(java.lang.Class)>RMIClassLoader.getClassAnnotation(java.lang.Class) 55 ;

---

getTie

public static Tie getTie(java.rmi.Remote target)

Get the Tie that handles invocations on the given target. If the target/Tie pair has not been previously registered using registerTarget(javax.rmi.CORBA.Tie, java.rmi.Remote) 55 , this method tries to locate a tie class by the name pattern. If this succeeds, the tie-target pair is also registered.

---

isLocal

public static boolean isLocal(Stub stub)
                       throws java.rmi.RemoteException

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

---

loadClass

public static java.lang.Class loadClass(java.lang.String className,
                                        java.lang.String remoteCodebase,
                                        java.lang.ClassLoader loader)
                                 throws java.lang.ClassNotFoundException

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

---

mapSystemException

public static java.rmi.RemoteException mapSystemException(org.omg.CORBA.SystemException ex)

Converts CORBA SystemException into RMI java.rmi.RemoteException. The exception is converted as defined in the following table:

CORBA Exception	RMI Exception
org.omg.CORBA.COMM_FAILURE	java.rmi.MarshalException
org.omg.CORBA.INV_OBJREF	java.rmi.NoSuchObjectException
org.omg.CORBA.NO_PERMISSION	java.rmi.AccessException
org.omg.CORBA.MARSHAL	java.rmi.MarshalException
org.omg.CORBA.BAD_PARAM (all other cases)	java.rmi.MarshalException
org.omg.CORBA.OBJECT_NOT_EXIST	java.rmi.NoSuchObjectException
org.omg.CORBA.TRANSACTION_REQUIRED	javax.transaction.TransactionRequiredException
org.omg.CORBA.TRANSACTION_ROLLEDBACK	javax.transaction.TransactionRolledbackException
org.omg.CORBA.INVALID_TRANSACTION	javax.transaction.InvalidTransactionException
Any other SystemException	java.rmi.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 org.omg.CORBA.OMGVMCID).
5. single space
6. the org.omg.CORBA.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.

---

registerTarget

public static void registerTarget(Tie tie,
                                  java.rmi.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(java.rmi.Remote target)
                           throws java.rmi.NoSuchObjectException

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 java.rmi.RemoteException wrapException(java.lang.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
java.lang.Error	java.rmi.ServerError
java.rmi.RemoteException	java.rmi.ServerException
SystemException	wrapException(mapSystemException(org.omg.CORBA.SystemException) 55 )
java.lang.RuntimeException	rethrows
Any other exception	java.rmi.UnexpectedException

---

writeAbstractObject

public static void writeAbstractObject(org.omg.CORBA.portable.OutputStream output,
                                       java.lang.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. java.rmi.Remotes are processed as defined in writeRemoteObject(org.omg.CORBA.portable.OutputStream, java.lang.Object) 55 . The written data contains discriminator, defining, that was written. Another method that writes the same content is OutputStream.write_abstract_interface(java.lang.Object)>OutputStream.write_abstract_interface(java.lang.Object) 55 .

---

writeAny

public static void writeAny(org.omg.CORBA.portable.OutputStream output,
                            java.lang.Object object)

Write the passed java object to the output stream in the form of the CORBA org.omg.CORBA.Any. This includes creating an writing the object org.omg.CORBA.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.

---

readAny

public static java.lang.Object readAny(org.omg.CORBA.portable.InputStream input)

Read Any from the input stream.

---

writeRemoteObject

public static void writeRemoteObject(org.omg.CORBA.portable.OutputStream output,
                                     java.lang.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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> rmi >> [ CORBA overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---