JavaTM 2 Platform
Standard Ed. 5.0

java.rmi
Class RemoteException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by java.rmi.RemoteException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AccessException, ActivateFailedException, ActivityCompletedException, ActivityRequiredException, ConnectException, ConnectIOException, ExportException, InvalidActivityException, InvalidTransactionException, MarshalException, NoSuchObjectException, ServerError, ServerException, ServerRuntimeException, SkeletonMismatchException, SkeletonNotFoundException, StubNotFoundException, TransactionRequiredException, TransactionRolledbackException, UnexpectedException, UnknownHostException, UnmarshalException

public class RemoteException
extends IOException

A RemoteException is the common superclass for a number of communication-related exceptions that may occur during the execution of a remote method call. Each method of a remote interface, an interface that extends java.rmi.Remote, must list RemoteException in its throws clause.

As of release 1.4, this exception has been retrofitted to conform to the general purpose exception-chaining mechanism. The "wrapped remote exception" that may be provided at construction time and accessed via the public detail field is now known as the cause, and may be accessed via the Throwable.getCause() method, as well as the aforementioned "legacy field."

Invoking the method Throwable.initCause(Throwable) on an instance of RemoteException always throws IllegalStateException.

Since:
JDK1.1
See Also:
Serialized Form

Field Summary
 Throwable detail
          The cause of the remote exception.
 
Constructor Summary
RemoteException()
          Constructs a RemoteException.
RemoteException(String s)
          Constructs a RemoteException with the specified detail message.
RemoteException(String s, Throwable cause)
          Constructs a RemoteException with the specified detail message and cause.
 
Method Summary
 Throwable getCause()
          Returns the cause of this exception.
 String getMessage()
          Returns the detail message, including the message from the cause, if any, of this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

detail

public Throwable detail
The cause of the remote exception.

This field predates the general-purpose exception chaining facility. The Throwable.getCause() method is now the preferred means of obtaining this information.

Constructor Detail

RemoteException

public RemoteException()
Constructs a RemoteException.


RemoteException

public RemoteException(String s)
Constructs a RemoteException with the specified detail message.

Parameters:
s - the detail message

RemoteException

public RemoteException(String s,
                       Throwable cause)
Constructs a RemoteException with the specified detail message and cause. This constructor sets the detail field to the specified Throwable.

Parameters:
s - the detail message
cause - the cause
Method Detail

getMessage

public String getMessage()
Returns the detail message, including the message from the cause, if any, of this exception.

Overrides:
getMessage in class Throwable
Returns:
the detail message

getCause

public Throwable getCause()
Returns the cause of this exception. This method returns the value of the detail field.

Overrides:
getCause in class Throwable
Returns:
the cause, which may be null.
Since:
1.4

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.