org.apache.derby.client.am
Class Sqlca

java.lang.Object
  org.apache.derby.client.am.Sqlca

Direct Known Subclasses:

NetSqlca

public abstract class Sqlca
extends java.lang.Object

Field Summary

private Agent	agent_
private java.lang.String[]	cachedMessages Cached error messages (to prevent multiple invocations of the stored procedure to get the same message).
protected Connection	connection_
protected boolean	containsSqlcax_
(package private) SqlException	exceptionThrownOnStoredProcInvocation_
static int	HIGH_ORDER_ROW_COUNT
static int	HIGH_ORDER_UPDATE_COUNT
static int	LOW_ORDER_ROW_COUNT
static int	LOW_ORDER_UPDATE_COUNT
(package private) boolean	messageTextRetrievedContainsTokensOnly_
private boolean	returnTokensOnlyInMessageText_
protected long	rowsetRowCount_
static int	SQL_ERR_LENGTH
protected int	sqlCode_
protected int[]	sqlErrd_
private java.lang.String	sqlErrmc_ A string representation of sqlErrmcBytes_.
private static java.lang.String	SQLERRMC_TOKEN_DELIMITER Token delimiter for SQLERRMC.
protected byte[]	sqlErrmcBytes_
protected int	sqlErrmcCcsid_
private static java.lang.String	sqlErrmcDelimiter__ Character sequence that separates the different messages in the errmc.
protected java.lang.String[]	sqlErrmcMessages_ Array of errmc strings for each message in the chain.
protected java.lang.String	sqlErrp_
protected byte[]	sqlErrpBytes_
protected java.lang.String	sqlState_
private java.lang.String[]	sqlStates_ SQL states for all the messages in the exception chain.
protected char[]	sqlWarn_
protected byte[]	sqlWarnBytes_

Constructor Summary

protected

Sqlca(Connection connection)

Method Summary

protected java.lang.String	bytes2String(byte[] bytes, int offset, int length)
private void	chainDeferredExceptionsToAgentOrAsConnectionWarnings(SqlException e)
boolean	containsSqlcax()
(package private) java.sql.DataTruncation	getDataTruncation() Get a java.sql.DataTruncation warning based on the information in this SQLCA.
int	getErrorCode() Get the error code based on the SQL code received from the server.
(package private) java.lang.String	getJDBCMessage(int messageNumber)
private java.lang.String	getMessage(int messageNumber)
long	getRowCount()
long	getRowsetRowCount()
int	getSqlCode()
int[]	getSqlErrd()
java.lang.String	getSqlErrmc()
java.lang.String	getSqlErrp()
java.lang.String	getSqlState()
(package private) java.lang.String	getSqlState(int messageNumber) Get the SQL state for a given error.
char[]	getSqlWarn()
private java.lang.String	getUnformattedMessage(int messageNumber) Get the unformatted message text (in case we cannot ask the server).
long	getUpdateCount()
boolean	includesSqlCode(int[] codes)
private void	initSqlErrmcMessages() Initialize and build the arrays sqlErrmcMessages_ and sqlStates_.
(package private) int	numberOfMessages() Returns the number of messages this SQLCA contains.
private void	processSqlErrmcTokens(byte[] tokenBytes)
void	resetRowsetSqlca(Connection connection, int sqlCode, java.lang.String sqlState, byte[] sqlErrpBytes)
(package private) void	returnTokensOnlyInMessageText(boolean returnTokensOnlyInMessageText)
void	setContainsSqlcax(boolean containsSqlcax)
void	setRowsetRowCount(long rowCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIGH_ORDER_ROW_COUNT

public static final int HIGH_ORDER_ROW_COUNT

See Also:

Constant Field Values

LOW_ORDER_ROW_COUNT

public static final int LOW_ORDER_ROW_COUNT

See Also:

Constant Field Values

LOW_ORDER_UPDATE_COUNT

public static final int LOW_ORDER_UPDATE_COUNT

See Also:

Constant Field Values

HIGH_ORDER_UPDATE_COUNT

public static final int HIGH_ORDER_UPDATE_COUNT

See Also:

Constant Field Values

SQL_ERR_LENGTH

public static final int SQL_ERR_LENGTH

See Also:

Constant Field Values

connection_

protected transient Connection connection_

exceptionThrownOnStoredProcInvocation_

SqlException exceptionThrownOnStoredProcInvocation_

messageTextRetrievedContainsTokensOnly_

boolean messageTextRetrievedContainsTokensOnly_

sqlCode_

protected int sqlCode_

sqlErrmc_

private java.lang.String sqlErrmc_

A string representation of sqlErrmcBytes_.

sqlErrmcMessages_

protected java.lang.String[] sqlErrmcMessages_

Array of errmc strings for each message in the chain.

sqlStates_

private java.lang.String[] sqlStates_

SQL states for all the messages in the exception chain.

sqlErrp_

protected java.lang.String sqlErrp_

sqlErrd_

protected int[] sqlErrd_

sqlWarn_

protected char[] sqlWarn_

sqlState_

protected java.lang.String sqlState_

sqlErrmcBytes_

protected byte[] sqlErrmcBytes_

sqlErrpBytes_

protected byte[] sqlErrpBytes_

sqlWarnBytes_

protected byte[] sqlWarnBytes_

sqlErrmcCcsid_

protected int sqlErrmcCcsid_

containsSqlcax_

protected boolean containsSqlcax_

rowsetRowCount_

protected long rowsetRowCount_

sqlErrmcDelimiter__

private static final java.lang.String sqlErrmcDelimiter__

Character sequence that separates the different messages in the errmc.

See Also:

SystemProcedures.SQLERRMC_MESSAGE_DELIMITER, Constant Field Values

SQLERRMC_TOKEN_DELIMITER

private static final java.lang.String SQLERRMC_TOKEN_DELIMITER

Token delimiter for SQLERRMC.

See Also:

Constant Field Values

returnTokensOnlyInMessageText_

private boolean returnTokensOnlyInMessageText_

agent_

private final transient Agent agent_

cachedMessages

private java.lang.String[] cachedMessages

Cached error messages (to prevent multiple invocations of the stored procedure to get the same message).

Constructor Detail

Sqlca

protected Sqlca(Connection connection)

Method Detail

returnTokensOnlyInMessageText

void returnTokensOnlyInMessageText(boolean returnTokensOnlyInMessageText)

numberOfMessages

int numberOfMessages()

Returns the number of messages this SQLCA contains.

Returns:

number of messages

getSqlCode

public int getSqlCode()

getErrorCode

public int getErrorCode()

Get the error code based on the SQL code received from the server.

The conversion from SQL code to error code happens like this:

• If the SQL code is 0, there is no error code because the Sqlca doesn't represent an error. Return 0.
• If the SQL code is positive, the Sqlca represents a warning, and the SQL code represents the actual error code. Return the SQL code.
• If the SQL code is negative, the Sqlca represents an error, and the error code is -(sqlCode+1).

See Also:

DRDAConnThread.getSqlCode(java.sql.SQLException)

getSqlErrmc

public java.lang.String getSqlErrmc()

initSqlErrmcMessages

private void initSqlErrmcMessages()

Initialize and build the arrays sqlErrmcMessages_ and sqlStates_.

getSqlErrp

public java.lang.String getSqlErrp()

getSqlErrd

public int[] getSqlErrd()

getSqlWarn

public char[] getSqlWarn()

getSqlState

public java.lang.String getSqlState()

getSqlState

java.lang.String getSqlState(int messageNumber)

Get the SQL state for a given error.

Parameters:

messageNumber - the error to retrieve SQL state for

Returns:

SQL state for the error

getMessage

private java.lang.String getMessage(int messageNumber)
                             throws SqlException

Throws:

SqlException

getJDBCMessage

java.lang.String getJDBCMessage(int messageNumber)

getUnformattedMessage

private java.lang.String getUnformattedMessage(int messageNumber)

Get the unformatted message text (in case we cannot ask the server).

Parameters:

messageNumber - which message number to get the text for

Returns:

string with details about the error

chainDeferredExceptionsToAgentOrAsConnectionWarnings

private void chainDeferredExceptionsToAgentOrAsConnectionWarnings(SqlException e)

includesSqlCode

public boolean includesSqlCode(int[] codes)

getDataTruncation

java.sql.DataTruncation getDataTruncation()

Get a java.sql.DataTruncation warning based on the information in this SQLCA.

Returns:

a java.sql.DataTruncation instance

processSqlErrmcTokens

private void processSqlErrmcTokens(byte[] tokenBytes)

bytes2String

protected java.lang.String bytes2String(byte[] bytes,
                                        int offset,
                                        int length)
                                 throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

getUpdateCount

public long getUpdateCount()

getRowCount

public long getRowCount()
                 throws DisconnectException

Throws:

DisconnectException

setContainsSqlcax

public void setContainsSqlcax(boolean containsSqlcax)

containsSqlcax

public boolean containsSqlcax()

resetRowsetSqlca

public void resetRowsetSqlca(Connection connection,
                             int sqlCode,
                             java.lang.String sqlState,
                             byte[] sqlErrpBytes)

setRowsetRowCount

public void setRowsetRowCount(long rowCount)

getRowsetRowCount

public long getRowsetRowCount()