java.rmi

Class RemoteException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

java.rmi.RemoteException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccessException, StubException, UnexpectedException

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

Since:

JDK1.1

Version:

1.22, 01/23/03

Author:

Ann Wollrath

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Throwable	detail Nested Exception to hold wrapped remote exception.

Constructor Summary

Constructors

Constructor and Description
RemoteException() Constructs a RemoteException with no specified detail message.
RemoteException(String s) Constructs a RemoteException with the specified detail message.
RemoteException(String s, Throwable ex) Constructs a RemoteException with the specified detail message and nested exception.

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getCause() Returns the wrapped remote exception (the cause).
String	getMessage() Returns the detail message, including the message from the nested exception if there is one.

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

Nested Exception to hold wrapped 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 with no specified detail message.

RemoteException

public RemoteException(String s)

Constructs a RemoteException with the specified detail message.

Parameters:

s - the detail message

RemoteException

public RemoteException(String s,
               Throwable ex)

Constructs a RemoteException with the specified detail message and nested exception.

Parameters:

s - the detail message

ex - the nested exception

Method Detail

getMessage

public String getMessage()

Returns the detail message, including the message from the nested exception if there is one.

Overrides:

getMessage in class Throwable

Returns:

the detail message, including nested exception message if any

getCause

public Throwable getCause()

Returns the wrapped remote exception (the cause).

Overrides:

getCause in class Throwable

Returns:

the wrapped remote exception, which may be null.

Since:

1.4