RemoteProcedureException (Apache HBase 1.2.12 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.io.IOException
    - - org.apache.hadoop.hbase.procedure2.ProcedureException
      - org.apache.hadoop.hbase.procedure2.RemoteProcedureException

All Implemented Interfaces:

Serializable
```
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class RemoteProcedureException
extends ProcedureException
```
A RemoteProcedureException is an exception from another thread or process.
RemoteProcedureExceptions are sent to 'remote' peers to signal an abort in the face of failures. When serialized for transmission we encode using Protobufs to ensure version compatibility.
RemoteProcedureException exceptions contain a Throwable as its cause. This can be a "regular" exception generated locally or a ProxyThrowable that is a representation of the original exception created on original 'remote' source. These ProxyThrowables have their their stacks traces and messages overridden to reflect the original 'remote' exception.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

private String source
Name of the throwable's source such as a host or thread name.

Fields
Modifier and Type	Field and Description
`private String`	`source` Name of the throwable's source such as a host or thread name.

Constructor Summary

Constructors
Constructor and Description

RemoteProcedureException(String source, Throwable cause)
Create a new RemoteProcedureException that can be serialized.

Constructors
Constructor and Description
`RemoteProcedureException(String source, Throwable cause)` Create a new RemoteProcedureException that can be serialized.

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage`	`convert()`
`static RemoteProcedureException`	`deserialize(byte[] bytes)` Takes a series of bytes and tries to generate an RemoteProcedureException instance for it.
`static RemoteProcedureException`	`fromProto(org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage eem)`
`String`	`getSource()`
`static byte[]`	`serialize(String source, Throwable t)` Converts a RemoteProcedureException to an array of bytes.
`static org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage`	`toProto(String source, Throwable t)`
`String`	`toString()`
`IOException`	`unwrapRemoteException()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- source
```
private final String source
```
  Name of the throwable's source such as a host or thread name. Must be non-null.

Constructor Detail
- RemoteProcedureException
```
public RemoteProcedureException(String source,
                        Throwable cause)
```
  Create a new RemoteProcedureException that can be serialized. It is assumed that this came form a local source.
  
  Parameters:
  source -
  cause -

Method Detail

getSource
```
public String getSource()
```

unwrapRemoteException

public IOException unwrapRemoteException()

toString
```
public String toString()
```
Overrides:

toString in class Throwable

serialize
```
public static byte[] serialize(String source,
               Throwable t)
```
Converts a RemoteProcedureException to an array of bytes.

Parameters:
source - the name of the external exception source
t - the "local" external exception (local)

Returns:
protobuf serialized version of RemoteProcedureException

deserialize
```
public static RemoteProcedureException deserialize(byte[] bytes)
                                            throws com.google.protobuf.InvalidProtocolBufferException
```
Takes a series of bytes and tries to generate an RemoteProcedureException instance for it.

Parameters:
bytes -

Returns:
the ForeignExcpetion instance

Throws:

com.google.protobuf.InvalidProtocolBufferException - if there was deserialization problem this is thrown.

convert

public org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage convert()

toProto

public static org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage toProto(String source,
                                                                                             Throwable t)

fromProto

public static RemoteProcedureException fromProto(org.apache.hadoop.hbase.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage eem)

Class RemoteProcedureException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

source

Constructor Detail

RemoteProcedureException

Method Detail

getSource

unwrapRemoteException

toString

serialize

deserialize

convert

toProto

fromProto