Apache Derby Client JDBC Driver 10.17.1.0 · org.apache.derby.client.am.Sqlca

Field Summary

Modifier and Type	Field and Description
private final transient Agent	agent_
private String[]	cachedMessages Cached error messages (to prevent multiple invocations of the stored procedure to get the same message).
private transient ClientConnection	connection_
private boolean	containsSqlcax_
private static final String	elevenBlanks
pack-priv SqlException	exceptionThrownOnStoredProcInvocation_
private static final int	HIGH_ORDER_ROW_COUNT
private static final int	HIGH_ORDER_UPDATE_COUNT
private static final int	LOW_ORDER_ROW_COUNT
private static final int	LOW_ORDER_UPDATE_COUNT
pack-priv boolean	messageTextRetrievedContainsTokensOnly_
private boolean	returnTokensOnlyInMessageText_
private long	rowsetRowCount_
public static final int	SQL_ERR_LENGTH
protected int	sqlCode_
protected int[]	sqlErrd_
private String	sqlErrmc_ A string representation of `sqlErrmcBytes_`.
protected byte[]	sqlErrmcBytes_
private String[]	sqlErrmcMessages_ Array of errmc strings for each message in the chain.
private String	sqlErrp_
protected byte[]	sqlErrpBytes_
protected String	sqlState_
private String[]	sqlStates_ SQL states for all the messages in the exception chain.
private String	sqlWarn_
protected byte[]	sqlWarnBytes_

Constructor Summary

Access	Constructor and Description
protected	Sqlca(ClientConnection connection)

Method Summary

Modifier and Type	Method and Description
protected String	bytes2String(byte[] bytes, int offset, int length)
private void	chainDeferredExceptionsToAgentOrAsConnectionWarnings(SqlException e)
public boolean	containsSqlcax()
pack-priv String	formatSqlErrd()
public Object[]	getArgs(int messageNumber)
pack-priv DataTruncation	Returns: a `java.sql.DataTruncation` instance getDataTruncation() Get a `java.sql.DataTruncation` warning based on the information in this SQLCA.
public synchronized int	Returns: the error code getErrorCode() Get the error code based on the SQL code received from the server.
pack-priv synchronized String	getJDBCMessage(int messageNumber)
private String	getMessage(int messageNumber)
public long	getRowCount()
public long	getRowsetRowCount()
public synchronized int	getSqlCode()
private int[]	getSqlErrd()
public synchronized String	getSqlErrmc()
public synchronized String	getSqlErrp()
public synchronized String	getSqlState()
pack-priv synchronized String	Returns: SQL state for the error getSqlState(int the error to retrieve SQL state for messageNumber) Get the SQL state for a given error.
public synchronized String	getSqlWarn()
private String	Returns: string with details about the error getUnformattedMessage(int which message number to get the text for messageNumber) Get the unformatted message text (in case we cannot ask the server).
public long	getUpdateCount()
private void	initSqlErrmcMessages() Initialize and build the arrays `sqlErrmcMessages_` and `sqlStates_`.
pack-priv synchronized int	Returns: number of messages numberOfMessages() Returns the number of messages this SQLCA contains.
private void	processSqlErrmcTokens(byte[] tokenBytes)
public void	resetRowsetSqlca(ClientConnection connection, int sqlCode, String sqlState)
pack-priv void	returnTokensOnlyInMessageText(boolean returnTokensOnlyInMessageText)
public void	setContainsSqlcax(boolean containsSqlcax)
public void	setRowsetRowCount(long rowCount)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

agent_	back to summary
private final transient Agent agent_

cachedMessages	back to summary
private String[] cachedMessages Cached error messages (to prevent multiple invocations of the stored procedure to get the same message).

connection_	back to summary
private transient ClientConnection connection_

containsSqlcax_	back to summary
private boolean containsSqlcax_

elevenBlanks	back to summary
private static final String elevenBlanks

exceptionThrownOnStoredProcInvocation_	back to summary
pack-priv SqlException exceptionThrownOnStoredProcInvocation_

HIGH_ORDER_ROW_COUNT	back to summary
private static final int HIGH_ORDER_ROW_COUNT

HIGH_ORDER_UPDATE_COUNT	back to summary
private static final int HIGH_ORDER_UPDATE_COUNT

LOW_ORDER_ROW_COUNT	back to summary
private static final int LOW_ORDER_ROW_COUNT

LOW_ORDER_UPDATE_COUNT	back to summary
private static final int LOW_ORDER_UPDATE_COUNT

messageTextRetrievedContainsTokensOnly_	back to summary
pack-priv boolean messageTextRetrievedContainsTokensOnly_

returnTokensOnlyInMessageText_	back to summary
private boolean returnTokensOnlyInMessageText_

rowsetRowCount_	back to summary
private long rowsetRowCount_

SQL_ERR_LENGTH	back to summary
public static final int SQL_ERR_LENGTH

sqlCode_	back to summary
protected int sqlCode_

sqlErrd_	back to summary
protected int[] sqlErrd_

sqlErrmc_	back to summary
private String sqlErrmc_ A string representation of `sqlErrmcBytes_`.

sqlErrmcBytes_	back to summary
protected byte[] sqlErrmcBytes_

sqlErrmcMessages_	back to summary
private String[] sqlErrmcMessages_ Array of errmc strings for each message in the chain.

sqlErrp_	back to summary
private String sqlErrp_

sqlErrpBytes_	back to summary
protected byte[] sqlErrpBytes_

sqlState_	back to summary
protected String sqlState_

sqlStates_	back to summary
private String[] sqlStates_ SQL states for all the messages in the exception chain.

sqlWarn_	back to summary
private String sqlWarn_

sqlWarnBytes_	back to summary
protected byte[] sqlWarnBytes_

Constructor Detail

Sqlca	back to summary
protected Sqlca(ClientConnection connection)

Method Detail

bytes2String	back to summary
protected String bytes2String(byte[] bytes, int offset, int length)

chainDeferredExceptionsToAgentOrAsConnectionWarnings	back to summary
private void chainDeferredExceptionsToAgentOrAsConnectionWarnings(SqlException e)

containsSqlcax	back to summary
public boolean containsSqlcax()

formatSqlErrd	back to summary
pack-priv String formatSqlErrd()

getArgs	back to summary
public Object[] getArgs(int messageNumber)

getDataTruncation back to summary

getDataTruncation	back to summary
pack-priv DataTruncation getDataTruncation() Get a `java.sql.DataTruncation` warning based on the information in this SQLCA. Returns:DataTruncation a `java.sql.DataTruncation` instance

pack-priv DataTruncation getDataTruncation()

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

Returns:DataTruncation: a java.sql.DataTruncation instance

getErrorCode back to summary

getErrorCode	back to summary
public synchronized 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 org.apache.derby.impl.drda.DRDAConnThread#getSqlCode(java.sql.SQLException) Returns:int the error code

public synchronized 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 org.apache.derby.impl.drda.DRDAConnThread#getSqlCode(java.sql.SQLException)

Returns:int: the error code

getJDBCMessage	back to summary
pack-priv synchronized String getJDBCMessage(int messageNumber)

getMessage	back to summary
private String getMessage(int messageNumber) throws SqlException

getRowCount	back to summary
public long getRowCount() throws DisconnectException

getRowsetRowCount	back to summary
public long getRowsetRowCount()

getSqlCode	back to summary
public synchronized int getSqlCode()

getSqlErrd	back to summary
private int[] getSqlErrd()

getSqlErrmc	back to summary
public synchronized String getSqlErrmc()

getSqlErrp	back to summary
public synchronized String getSqlErrp()

getSqlState	back to summary
public synchronized String getSqlState()

getSqlState	back to summary
pack-priv synchronized String getSqlState(int messageNumber) Get the SQL state for a given error. Parameters messageNumber:int the error to retrieve SQL state for Returns:String SQL state for the error

getSqlState

back to summary

pack-priv synchronized String getSqlState(int messageNumber)

Get the SQL state for a given error.

Parameters

messageNumber:int: the error to retrieve SQL state for

Returns:String

SQL state for the error

getSqlWarn	back to summary
public synchronized String getSqlWarn()

getUnformattedMessage	back to summary
private String getUnformattedMessage(int messageNumber) Get the unformatted message text (in case we cannot ask the server). Parameters messageNumber:int which message number to get the text for Returns:String string with details about the error

getUnformattedMessage

back to summary

private String getUnformattedMessage(int messageNumber)

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

Parameters

messageNumber:int: which message number to get the text for

Returns:String

string with details about the error

getUpdateCount	back to summary
public long getUpdateCount()

initSqlErrmcMessages	back to summary
private void initSqlErrmcMessages() Initialize and build the arrays `sqlErrmcMessages_` and `sqlStates_`.

numberOfMessages

back to summary

pack-priv synchronized int numberOfMessages()

Returns the number of messages this SQLCA contains.

Returns:int: number of messages

processSqlErrmcTokens	back to summary
private void processSqlErrmcTokens(byte[] tokenBytes)

resetRowsetSqlca	back to summary
public void resetRowsetSqlca(ClientConnection connection, int sqlCode, String sqlState)

returnTokensOnlyInMessageText	back to summary
pack-priv void returnTokensOnlyInMessageText(boolean returnTokensOnlyInMessageText)

setContainsSqlcax	back to summary
public void setContainsSqlcax(boolean containsSqlcax)

setRowsetRowCount	back to summary
public void setRowsetRowCount(long rowCount)

public abstract Class Sqlca

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail