org.firebirdsql.gds.GDSExceptionHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk15 Show documentation
Show all versions of jaybird-jdk15 Show documentation
JDBC Driver for the Firebird RDBMS
/*
* Public Firebird Java API.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.firebirdsql.gds;
import org.firebirdsql.logging.Logger;
import org.firebirdsql.logging.LoggerFactory;
import java.util.Properties;
import java.io.InputStream;
/**
* This class is supposed to return messages for the specified error code.
* It loads all messages during the class initialization and keeps messages
* in the static java.util.Properties variable.
*
* @author David Jencks
* @author Roman Rokytskyy
* @author Blas Rodriguez Somoza
* @version 1.0
*/
public class GDSExceptionHelper {
private static final Logger log = LoggerFactory.getLogger(GDSExceptionHelper.class,false);
private static final String MESSAGES = "isc_error_msg";
private static final String SQLSTATES = "isc_error_sqlstates";
private static Properties messages = new Properties();
private static Properties sqlstates = new Properties();
private static boolean initialized = false;
/**
* This method initializes the messages map.
* @todo think about better exception handling.
*/
private static void init() {
loadResource(MESSAGES, messages);
loadResource(SQLSTATES, sqlstates);
}
private static void loadResource(String resource, Properties propeties) {
try {
String res = "/" + resource.replace('.','/') + ".properties";
InputStream in = GDSException.class.getResourceAsStream(res);
if (in == null) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
in = cl.getResourceAsStream(res);
}
if (in != null)
propeties.load(in);
} catch (Exception ex) {
if (log!=null) log.info("Exception in init of GDSExceptionHelper", ex);
} finally {
initialized = true;
}
}
/**
* This method returns a message for the specified error code.
* @param code Firebird error code
* @return instance of GDSExceptionHelper.GDSMesssage class
* where you can set desired parameters.
*/
public static GDSMessage getMessage(int code) {
if (!initialized) init();
return new GDSMessage(messages.getProperty(
"" + code, "No message for code " + code + " found."));
}
/**
* Get the SQL state for the specified error code.
*
* @param code Firebird error code
*
* @return string with SQL state, "HY000" if nothing found.
*/
public static String getSQLState(int code) {
if (!initialized) init();
String result = sqlstates.getProperty(Integer.toString(code));
if (result == null)
result = "HY000";
return result;
}
/**
* This class wraps message template obtained from isc_error_msg.properties
* file and allows to set parameters to the message.
*/
public static class GDSMessage {
private String template;
private String[] params;
/**
* Constructs an instance of GDSMessage for the specified template.
*/
public GDSMessage(String template) {
this.template = template;
params = new String[getParamCount()];
}
/**
* Returns the number of parameters for the message template.
* @return number of parameters.
*/
public int getParamCount() {
int count = 0;
for(int i = 0; i < template.length(); i++)
if (template.charAt(i) == '{') count++;
return count;
}
/**
* Sets the parameter value
* @param position the parameter number, 0 - first parameter.
* @param text value of parameter
*/
public void setParameter(int position, String text) {
if (position < params.length)
params[position] = text;
}
/**
* Puts parameters into the template and return the obtained string.
* @return string representation of the message.
*/
public String toString() {
String message = template;
for(int i = 0; i < params.length; i++) {
String param = "{" + i + "}";
int pos = message.indexOf(param);
if (pos > -1)
{
String temp = message.substring(0, pos);
temp += (params[i] == null) ? "" : params[i];
temp += message.substring(pos + param.length());
message = temp;
} // end of if ()
}
return message;
}
}
}