Internationalisation of error messages

Author: Peter Mount

src/interfaces/jdbc/postgresql/Connection.java

@@ -10,7 +10,7 @@
 import postgresql.util.*;
 
 /**
- * $Id: Connection.java,v 1.16 1999/05/17 22:43:23 peter Exp $
+ * $Id: Connection.java,v 1.17 1999/05/18 23:17:15 peter Exp $
  *
  * This abstract class is used by postgresql.Driver to open either the JDBC1 or
  * JDBC2 versions of the Connection class.
@@ -95,9 +95,9 @@ protected void openConnection(String host, int port, Properties info, String dat
     // This occasionally occurs when the client uses the properties version
     // of getConnection(), and is a common question on the email lists
     if(info.getProperty("user")==null)
-      throw new SQLException("The user property is missing. It is mandatory.");
+      throw new PSQLException("postgresql.con.user");
     if(info.getProperty("password")==null)
-      throw new SQLException("The password property is missing. It is mandatory.");
+      throw new PSQLException("postgresql.con.pass");
 
     this_driver = d;
     this_url = new String(url);
@@ -116,9 +116,9 @@ protected void openConnection(String host, int port, Properties info, String dat
 	// Added by Peter Mount <peter@retep.org.uk>
 	// ConnectException is thrown when the connection cannot be made.
 	// we trap this an return a more meaningful message for the end user
-	throw new SQLException ("Connection refused. Check that the hostname and port is correct, and that the postmaster is running with the -i flag, which enables TCP/IP networking.");
+	throw new PSQLException ("postgresql.con.refused");
       } catch (IOException e) {
-	throw new SQLException ("Connection failed: " + e.toString());
+	throw new PSQLException ("postgresql.con.failed",e);
       }
 
       // Now we need to construct and send a startup packet
@@ -173,11 +173,11 @@ protected void openConnection(String host, int port, Properties info, String dat
 
 		  case AUTH_REQ_KRB4:
 		    DriverManager.println("postgresql: KRB4");
-		    throw new SQLException("Kerberos 4 not supported");
+		    throw new PSQLException("postgresql.con.kerb4");
 
 		  case AUTH_REQ_KRB5:
 		    DriverManager.println("postgresql: KRB5");
-		    throw new SQLException("Kerberos 5 not supported");
+		    throw new PSQLException("postgresql.con.kerb5");
 
 		  case AUTH_REQ_PASSWORD:
 		    DriverManager.println("postgresql: PASSWORD");
@@ -197,17 +197,17 @@ protected void openConnection(String host, int port, Properties info, String dat
 		    break;
 
 		  default:
-		    throw new SQLException("Authentication type "+areq+" not supported. Check that you have configured the pg_hba.conf file to include the client's IP address or Subnet, and is using a supported authentication scheme.");
+		    throw new PSQLException("postgresql.con.auth",new Integer(areq));
 		  }
 		break;
 
 	      default:
-		throw new SQLException("error getting authentication request");
+		throw new PSQLException("postgresql.con.authfail");
 	      }
 	    } while(areq != AUTH_REQ_OK);
 
 	} catch (IOException e) {
-	  throw new SQLException("Connection failed: " + e.toString());
+	  throw new PSQLException("postgresql.con.failed",e);
 	}
 
       // Originally we issued a SHOW DATESTYLE statement to find the databases default
@@ -290,7 +290,7 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 	    SQLException final_error = null;
 
 	    if (sql.length() > 8192)
-		throw new SQLException("SQL Statement too long: " + sql);
+		throw new PSQLException("postgresql.con.toolong",sql);
 	    try
 		{
 		    pg_stream.SendChar('Q');
@@ -299,7 +299,7 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 		    pg_stream.SendChar(0);
 		    pg_stream.flush();
 		} catch (IOException e) {
-		    throw new SQLException("I/O Error: " + e.toString());
+		    throw new PSQLException("postgresql.con.ioerror",e);
 		}
 
 	    while (!hfr || fqp > 0)
@@ -316,7 +316,7 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 			    break;
 			case 'B':	// Binary Data Transfer
 			    if (fields == null)
-				throw new SQLException("Tuple received before MetaData");
+				throw new PSQLException("postgresql.con.tuple");
 			    tup = pg_stream.ReceiveTuple(fields.length, true);
 			    // This implements Statement.setMaxRows()
 			    if(maxrows==0 || tuples.size()<maxrows)
@@ -330,7 +330,7 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 					try {
 						update_count = Integer.parseInt(recv_status.substring(1+recv_status.lastIndexOf(' ')));
 					} catch(NumberFormatException nfe) {
-						throw new SQLException("Unable to fathom update count \""+recv_status+"\"");
+						throw new PSQLException("postgresql.con.fathom",recv_status);
 					}
 				}
 			    if (fields != null)
@@ -344,14 +344,14 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 					    pg_stream.SendChar(0);
 					    pg_stream.flush();
 					} catch (IOException e) {
-					    throw new SQLException("I/O Error: " + e.toString());
+					    throw new PSQLException("postgresql.con.ioerror",e);
 					}
 				    fqp++;
 				}
 			    break;
 			case 'D':	// Text Data Transfer
 			    if (fields == null)
-				throw new SQLException("Tuple received before MetaData");
+				throw new PSQLException("postgresql.con.tuple");
 			    tup = pg_stream.ReceiveTuple(fields.length, false);
 			    // This implements Statement.setMaxRows()
 			    if(maxrows==0 || tuples.size()<maxrows)
@@ -366,7 +366,7 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 			    int t = pg_stream.ReceiveChar();
 
 			    if (t != 0)
-				throw new SQLException("Garbled Data");
+				throw new PSQLException("postgresql.con.garbled");
 			    if (fqp > 0)
 				fqp--;
 			    if (fqp == 0)
@@ -380,11 +380,11 @@ public java.sql.ResultSet ExecSQL(String sql) throws SQLException
 			    break;
 			case 'T':	// MetaData Field Description
 			    if (fields != null)
-				throw new SQLException("Cannot handle multiple result groups");
+				throw new PSQLException("postgresql.con.multres");
 			    fields = ReceiveFields();
 			    break;
 			default:
-			    throw new SQLException("Unknown Response Type: " + (char)c);
+			    throw new PSQLException("postgresql.con.type",new Character((char)c));
 			}
 		}
 	    if (final_error != null)
@@ -587,7 +587,7 @@ public Object getObject(String type,String value) throws SQLException
 	    sx.fillInStackTrace();
 	    throw sx;
 	} catch(Exception ex) {
-	    throw new SQLException("Failed to create object for "+type+": "+ex);
+	    throw new PSQLException("postgresql.con.creobj",type,ex);
 	}
 
 	// should never be reached
@@ -622,14 +622,14 @@ public int putObject(Object o) throws SQLException
 		return ((Serialize)x).store(o);
 
 	    // Thow an exception because the type is unknown
-	    throw new SQLException("The object could not be stored. Check that any tables required have already been created in the database.");
+	    throw new PSQLException("postgresql.con.strobj");
 
 	} catch(SQLException sx) {
 	    // rethrow the exception. Done because we capture any others next
 	    sx.fillInStackTrace();
 	    throw sx;
 	} catch(Exception ex) {
-	    throw new SQLException("Failed to store object: "+ex);
+	    throw new PSQLException("postgresql.con.strobjex",ex);
 	}
     }
 

src/interfaces/jdbc/postgresql/Driver.java

@@ -3,11 +3,6 @@
 import java.sql.*;
 import java.util.*;
 
-// You will find some mentions to a PSQLException class. This was intended
-// to allow internationalisation of error messages. However, this is not
-// working quite to plan, so the class exists in the source, but it's not
-// quite implemented yet. Peter May 17 1999.
-//
 import postgresql.util.PSQLException;
 
 /**
@@ -109,10 +104,8 @@ public java.sql.Connection connect(String url, Properties info) throws SQLExcept
 	return (java.sql.Connection)con;
     } catch(ClassNotFoundException ex) {
 	throw new PSQLException("postgresql.jvm.version",ex);
-	//throw new SQLException("The postgresql.jar file does not contain the correct JDBC classes for this JVM. Try rebuilding.\nException thrown was "+ex.toString());
     } catch(Exception ex2) {
 	throw new PSQLException("postgresql.unusual",ex2);
-	//throw new SQLException("Something unusual has occured to cause the driver to fail. Please report this exception: "+ex2.toString());
     }
     // The old call - remove before posting
     //return new Connection (host(), port(), props, database(), url, this);
@@ -356,7 +349,6 @@ public String property(String name)
     public static SQLException notImplemented()
     {
 	return new PSQLException("postgresql.unimplemented");
-	//return new SQLException("This method is not yet implemented.");
     }
 }
 

src/interfaces/jdbc/postgresql/Field.java

@@ -4,6 +4,7 @@
 import java.sql.*;
 import java.util.*;
 import postgresql.*;
+import postgresql.util.*;
 
 /**
  * postgresql.Field is a class used to describe fields in a PostgreSQL
@@ -62,7 +63,7 @@ public int getSQLType() throws SQLException
       if(type_name==null) {
 	ResultSet result = (postgresql.ResultSet)conn.ExecSQL("select typname from pg_type where oid = " + oid);
 	if (result.getColumnCount() != 1 || result.getTupleCount() != 1)
-	  throw new SQLException("Unexpected return from query for type");
+	  throw new PSQLException("postgresql.unexpected");
 	result.next();
 	type_name = result.getString(1);
 	conn.fieldCache.put(new Integer(oid),type_name);

src/interfaces/jdbc/postgresql/PG_Stream.java

@@ -6,6 +6,7 @@
 import java.util.*;
 import java.sql.*;
 import postgresql.*;
+import postgresql.util.*;
 
 /**
  * @version 1.0 15-APR-1997
@@ -22,15 +23,6 @@ public class PG_Stream
   private InputStream pg_input;
   private BufferedOutputStream pg_output;
 
-  // This is the error message returned when an EOF occurs
-  private static final String EOF_MSG = "The backend has broken the connection. Possibly the action you have attempted has caused it to close.";
-  
-  // This is the error message returned when an IOException occurs
-  private static final String IOE_MSG = "IOError while reading from backend: ";
-  
-  // This is the error message returned when flushing the stream.
-  private static final String FLUSH_MSG = "Error flushing output: ";
-  
   /**
    * Constructor:  Connect to the PostgreSQL back end and return
    * a stream connection.
@@ -178,9 +170,9 @@ public int ReceiveChar() throws SQLException
     try
       {
 	c = pg_input.read();
-	if (c < 0) throw new IOException(EOF_MSG);
+	if (c < 0) throw new PSQLException("postgresql.stream.eof");
       } catch (IOException e) {
-	throw new SQLException(IOE_MSG + e.toString());
+	throw new PSQLException("postgresql.stream.ioerror",e);
       }
       return c;
   }
@@ -203,11 +195,11 @@ public int ReceiveInteger(int siz) throws SQLException
 	    int b = pg_input.read();
 
 	    if (b < 0)
-	      throw new IOException(EOF_MSG);
+	      throw new PSQLException("postgresql.stream.eof");
 	    n = n | (b << (8 * i)) ;
 	  }
       } catch (IOException e) {
-	throw new SQLException(IOE_MSG + e.toString());
+	throw new PSQLException("postgresql.stream.ioerror",e);
       }
       return n;
   }
@@ -230,11 +222,11 @@ public int ReceiveIntegerR(int siz) throws SQLException
 	    int b = pg_input.read();
 
 	    if (b < 0)
-	      throw new IOException(EOF_MSG);
+	      throw new PSQLException("postgresql.stream.eof");
 	    n = b | (n << 8);
 	  }
       } catch (IOException e) {
-	throw new SQLException(IOE_MSG + e.toString());
+	throw new PSQLException("postgresql.stream.ioerror",e);
       }
       return n;
   }
@@ -259,16 +251,16 @@ public String ReceiveString(int maxsiz) throws SQLException
 	  {
 	    int c = pg_input.read();
 	    if (c < 0)
-	      throw new IOException(EOF_MSG);
+	      throw new PSQLException("postgresql.stream.eof");
 	    else if (c == 0)
 	      break;
 	    else
 	      rst[s++] = (byte)c;
 	  }
 	if (s >= maxsiz)
-	  throw new IOException("Too Much Data");
+	  throw new PSQLException("postgresql.stream.toomuch");
       } catch (IOException e) {
-	throw new SQLException(IOE_MSG + e.toString());
+	throw new PSQLException("postgresql.stream.ioerror",e);
       }
       String v = new String(rst, 0, s);
       return v;
@@ -349,11 +341,11 @@ public void Receive(byte[] b,int off,int siz) throws SQLException
 	  {
 	    int w = pg_input.read(b, off+s, siz - s);
 	    if (w < 0)
-	      throw new IOException(EOF_MSG);
+	      throw new PSQLException("postgresql.stream.eof");
 	    s += w;
 	  }
       } catch (IOException e) {
-	throw new SQLException(IOE_MSG + e.toString());
+	  throw new PSQLException("postgresql.stream.ioerror",e);
       }
   }
 
@@ -367,7 +359,7 @@ public void flush() throws SQLException
     try {
       pg_output.flush();
     } catch (IOException e) {
-      throw new SQLException(FLUSH_MSG + e.toString());
+      throw new PSQLException("postgresql.stream.flush",e);
     }
   }
 

src/interfaces/jdbc/postgresql/errors.properties

@@ -1,4 +1,67 @@
 # This is the default errors
+postgresql.con.auth:The authentication type {1} is not supported. Check that you have configured the pg_hba.conf file to include the client's IP address or Subnet, and that it is using an authentication scheme supported by the driver.
+postgresql.con.authfail:An error occured while getting the authentication request.
+postgresql.con.call:Callable Statements are not supported at this time.
+postgresql.con.creobj:Failed to create object for {1} {2}
+postgresql.con.failed:The connection attempt failed because {1}
+postgresql.con.fathom:Unable to fathom update count {1}
+postgresql.con.garbled:Garbled data received.
+postgresql.con.ioerror:An IO erro occured while sending to the backend - {1}
+postgresql.con.kerb4:Kerberos 4 authentication is not supported by this driver.
+postgresql.con.kerb5:Kerberos 5 authentication is not supported by this driver.
+postgresql.con.multres:Cannot handle multiple result groups.
+postgresql.con.pass:The password property is missing. It is mandatory.
+postgresql.con.refused:Connection refused. Check that the hostname and port is correct, and that the postmaster is running with the -i flag, which enables TCP/IP networking.
+postgresql.con.strobj:The object could not be stored. Check that any tables required have already been created in the database.
+postgresql.con.strobjex:Failed to store object - {1}
+postgresql.con.toolong:The SQL Statement is too long - {1}
+postgresql.con.tuple:Tuple received before MetaData.
+postgresql.con.type:Unknown Response Type {1}
+postgresql.con.user:The user property is missing. It is mandatory.
+postgresql.fp.error:FastPath call returned {1}
+postgresql.fp.expint:Fastpath call {1} - No result was returned and we expected an integer.
+postgresql.fp.protocol:FastPath protocol error: {1}
+postgresql.fp.send:Failed to send fastpath call {1} {2}
+postgresql.fp.unknown:The fastpath function {1} is unknown.
+postgresql.geo.box:Conversion of box failed - {1}
+postgresql.geo.circle:Conversion of circle failed - {1}
+postgresql.geo.line:Conversion of line failed - {1}
+postgresql.geo.lseg:Conversion of lseg failed - {1}
+postgresql.geo.path:Cannot tell if path is open or closed.
+postgresql.geo.point:Conversion of point failed - {1}
 postgresql.jvm.version:The postgresql.jar file does not contain the correct JDBC classes for this JVM. Try rebuilding.\nException thrown was {1}
+postgresql.lo.init:failed to initialise LargeObject API
+postgresql.money:conversion of money failed - {1}.
+postgresql.prep.is:InputStream as parameter not supported
+postgresql.prep.param:No value specified for parameter {1}.
+postgresql.prep.range:Parameter index out of range.
+postgresql.prep.type:Unknown Types value.
+postgresql.res.badbigdec:Bad BigDecimal {1}
+postgresql.res.badbyte:Bad Byte {1}
+postgresql.res.baddate:Bad Date Format at {1} in {2}
+postgresql.res.baddouble:Bad Double {1}
+postgresql.res.badfloat:Bad Float {1}
+postgresql.res.badint:Bad Integer {1}
+postgresql.res.badlong:Bad Long {1}
+postgresql.res.badshort:Bad Short {1}
+postgresql.res.badtime:Bad Time {1}
+postgresql.res.badtimestamp:Bad Timestamp Format at {1} in {2}
+postgresql.res.colname:The column name {1} not found.
+postgresql.res.colrange:The column index is out of range.
+postgresql.serial.interface:You cannot serialize an interface.
+postgresql.serial.namelength:Class & Package name length cannot be longer than 32 characters. {1} is {2} characters.
+postgresql.serial.noclass:No class found for {1}.
+postgresql.serial.table:The table for {1} is not in the database. Contact the DBA, as the database is in an inconsistent state.
+postgresql.serial.underscore:Class names may not have _ in them. You supplied {1}.
+postgresql.stat.batch.empty:The batch is empty. There is nothing to execute.
+postgresql.stat.batch.error:Batch entry {1} {2} was aborted.
+postgresql.stat.maxfieldsize:An attempt to setMaxFieldSize() failed - compile time default in force.
+postgresql.stat.noresult:No results were returned by the query.
+postgresql.stat.result:A result was returned by the statement, when none was expected.
+postgresql.stream.eof:The backend has broken the connection. Possibly the action you have attempted has caused it to close.
+postgresql.stream.flush:An I/O error has occured while flushing the output - {1}
+postgresql.stream.ioerror:An I/O error occured while reading from backend - {1}
+postgresql.stream.toomuch:Too much data was received.
 postgresql.unusual:Something unusual has occured to cause the driver to fail. Please report this exception: {1}
 postgresql.unimplemented:This method is not yet implemented.
+postgresql.unexpected:An unexpected result was returned by a query.