org.acplt.oncrpc.OncRpcException Maven / Gradle / Ivy
Show all versions of remotetea-oncrpc Show documentation
/*
* $Header: /home/harald/repos/remotetea.sf.net/remotetea/src/org/acplt/oncrpc/OncRpcException.java,v 1.3 2008/01/02 15:13:35 haraldalbrecht Exp $
*
* Copyright (c) 1999, 2000
* Lehrstuhl fuer Prozessleittechnik (PLT), RWTH Aachen
* D-52064 Aachen, Germany.
* All rights reserved.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This library 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 Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program (see the file LICENSE.txt for more
* details); if not, write to the Free Software Foundation, Inc.,
* 675 Mass Ave, Cambridge, MA 02139, USA.
*/
package org.acplt.oncrpc;
/**
* The class OncRpcException indicates ONC/RPC conditions
* that a reasonable application might want to catch. We follow here the
* notation established by the Java environment that exceptions can be
* caught while errors usually can't. Because we don't want to throw our
* applications out of the virtual machine (should I mock here "out of the
* window"?), we only define exceptions.
*
* The class OncRpcException also defines a set of ONC/RPC
* error codes as defined by RFC 1831. Note that all these error codes are
* solely used on the client-side or server-side, but never transmitted
* over the wire. For error codes transmitted over the network, refer to
* {@link OncRpcAcceptStatus} and {@link OncRpcRejectStatus}.
*
* @version $Revision: 1.3 $ $Date: 2008/01/02 15:13:35 $ $State: Exp $ $Locker: $
* @author Harald Albrecht
*
* @see java.lang.Exception
*/
public class OncRpcException extends Exception {
/**
* Defines the serial version UID for OncRpcException.
*/
private static final long serialVersionUID = -2170017056632137324L;
/**
* Constructs an OncRpcException with a reason of
* {@link OncRpcException#RPC_FAILED}.
*/
public OncRpcException() {
this(OncRpcException.RPC_FAILED);
}
/**
* Constructs an OncRpcException with the specified detail
* message.
*
* @param s The detail message.
*/
public OncRpcException(String s) {
super();
reason = RPC_FAILED;
message = s;
}
/**
* Constructs an OncRpcException with the specified detail
* reason and message. For possible reasons, see below.
*
* @param r The detail reason.
* @param s The detail message.
*/
public OncRpcException(int r, String s) {
super();
reason = r;
message = s;
}
/**
* Constructs an OncRpcException with the specified detail
* reason. The detail message is derived automatically from the reason.
*
* @param r The reason. This can be one of the constants -- oops, that
* should be "public final static integers" -- defined in this
* interface.
*/
public OncRpcException(int r) {
super();
reason = r;
switch ( r ) {
case RPC_CANTENCODEARGS:
message = "can not encode RPC arguments";
break;
case RPC_CANTDECODERES:
message = "can not decode RPC result";
break;
case RPC_CANTRECV:
message = "can not receive ONC/RPC data";
break;
case RPC_CANTSEND:
message = "can not send ONC/RPC data";
break;
case RPC_TIMEDOUT:
message = "ONC/RPC call timed out";
break;
case RPC_VERSMISMATCH:
message = "ONC/RPC version mismatch";
break;
case RPC_AUTHERROR:
message = "ONC/RPC authentification error";
break;
case RPC_PROGUNAVAIL:
message = "ONC/RPC program not available";
break;
case RPC_CANTDECODEARGS:
message = "can not decode ONC/RPC arguments";
break;
case RPC_PROGVERSMISMATCH:
message = "ONC/RPC program version mismatch";
break;
case RPC_PROCUNAVAIL:
message = "ONC/RPC procedure not available";
break;
case RPC_SYSTEMERROR:
message = "ONC/RPC system error";
break;
case RPC_UNKNOWNPROTO:
message = "unknown protocol";
break;
case RPC_PMAPFAILURE:
message = "ONC/RPC portmap failure";
break;
case RPC_PROGNOTREGISTERED:
message = "ONC/RPC program not registered";
break;
case RPC_FAILED:
message = "ONC/RPC generic failure";
break;
case RPC_BUFFEROVERFLOW:
message = "ONC/RPC buffer overflow";
break;
case RPC_BUFFERUNDERFLOW:
message = "ONC/RPC buffer underflow";
break;
case RPC_WRONGMESSAGE:
message = "wrong ONC/RPC message type received";
break;
case RPC_CANNOTREGISTER:
message = "cannot register ONC/RPC port with local portmap";
break;
case RPC_SUCCESS:
default:
break;
}
}
/**
* Returns the error message string of this ONC/RPC object.
*
* @return The error message string of this OncRpcException
* object if it was created either with an error message string or an
* ONC/RPC error code.
*/
public String getMessage() {
return message;
}
/**
* Returns the error reason of this ONC/RPC exception object.
*
* @return The error reason of this OncRpcException object if
* it was {@link #OncRpcException(int) created} with an error reason; or
* RPC_FAILED if it was {@link #OncRpcException() created}
* with no error reason.
*/
public int getReason() {
return reason;
}
/**
* The remote procedure call was carried out successfully.
*/
public static final int RPC_SUCCESS = 0;
/**
* The client can not encode the argments to be sent for the remote
* procedure call.
*/
public static final int RPC_CANTENCODEARGS = 1;
/**
* The client can not decode the result from the remote procedure call.
*/
public static final int RPC_CANTDECODERES = 2;
/**
* Encoded information can not be sent.
*/
public static final int RPC_CANTSEND = 3;
/**
* Information to be decoded can not be received.
*/
public static final int RPC_CANTRECV = 4;
/**
* The remote procedure call timed out.
*/
public static final int RPC_TIMEDOUT = 5;
/**
* ONC/RPC versions of server and client are not compatible.
*/
public static final int RPC_VERSMISMATCH = 6;
/**
* The ONC/RPC server did not accept the authentication sent by the
* client. Bad girl/guy!
*/
public static final int RPC_AUTHERROR = 7;
/**
* The ONC/RPC server does not support this particular program.
*/
public static final int RPC_PROGUNAVAIL = 8;
/**
* The ONC/RPC server does not support this particular version of the
* program.
*/
public static final int RPC_PROGVERSMISMATCH = 9;
/**
* The given procedure is not available at the ONC/RPC server.
*/
public static final int RPC_PROCUNAVAIL = 10;
/**
* The ONC/RPC server could not decode the arguments sent within the
* call message.
*/
public static final int RPC_CANTDECODEARGS = 11;
/**
* The ONC/RPC server encountered a system error and thus was not able
* to carry out the requested remote function call successfully.
*/
public static final int RPC_SYSTEMERROR = 12;
/**
* The caller specified an unknown/unsupported IP protocol. Currently,
* only {@link OncRpcProtocols#ONCRPC_TCP} and
* {@link OncRpcProtocols#ONCRPC_UDP} are supported.
*/
public static final int RPC_UNKNOWNPROTO = 17;
/**
* The portmapper could not be contacted at the given host.
*/
public static final int RPC_PMAPFAILURE = 14;
/**
* The requested program is not registered with the given host.
*/
public static final int RPC_PROGNOTREGISTERED = 15;
/**
* A generic ONC/RPC exception occured. Shit happens...
*/
public static final int RPC_FAILED = 16;
/**
* A buffer overflow occured with an encoding XDR stream. This happens
* if you use UDP-based (datagram-based) XDR streams and you try to encode
* more data than can fit into the sending buffers.
*/
public static final int RPC_BUFFEROVERFLOW = 42;
/**
* A buffer underflow occured with an decoding XDR stream. This happens
* if you try to decode more data than was sent by the other communication
* partner.
*/
public static final int RPC_BUFFERUNDERFLOW = 43;
/**
* Either a ONC/RPC server or client received the wrong type of ONC/RPC
* message when waiting for a request or reply. Currently, only the
* decoding methods of the classes {@link OncRpcCallMessage} and
* {@link OncRpcReplyMessage} throw exceptions with this reason.
*/
public static final int RPC_WRONGMESSAGE = 44;
/**
* Indicates that a server could not register a transport with the
* ONC/RPC port mapper.
*/
public static final int RPC_CANNOTREGISTER = 45;
/**
* Specific detail (reason) about this OncRpcException,
* like the ONC/RPC error code, as defined by the RPC_xxx
* constants of this interface.
*
* @serial
*/
private int reason;
/**
* Specific detail about this OncRpcException, like a
* detailed error message.
*
* @serial
*/
private String message;
}
// End of OncRpcException.java