Apache Derby Shared Code 10.17.1.0 · org.apache.derby.shared.common.error.MessageUtils

Modifier and Type	Field and Description
public static final int	DB2_JCC_MAX_EXCEPTION_PARAM_LENGTH Pointer to the application requester for the session being serviced.
private static final Locale	EN
public static final String	SQLERRMC_MESSAGE_DELIMITER
private static String	SQLERRMC_PREFORMATTED_MESSAGE_DELIMITER `SQLERRMC_PREFORMATTED_MESSAGE_DELIMITER`, When full message text is sent for severe errors.
public static String	SQLERRMC_TOKEN_DELIMITER Delimiters for SQLERRMC values.

Access	Constructor and Description
public	MessageUtils()

Method Summary

Modifier and Type	Method and Description
private String	Returns: the SQLERRMC string with all fields of the warning buildDataTruncationSqlerrmc(DataTruncation the `DataTruncation` instance to serialize dt) Build the SQLERRMC for a `java.sql.DataTruncation` warning.
private String	Returns: preformated message text with messages separted by SQLERRMC_PREFORMATED_MESSAGE_DELIMITER buildPreformattedSqlerrmc(SQLException SQLException for which to build SQLERRMC se) Build preformatted SQLException text for severe exceptions or SQLExceptions that are not Derby exceptions.
public static String	encodeExceptionAsSqlerrmc(SQLException se)
public static String	encodeMessageAndArgumentsAsSqlerrmc(String messageId, Object[] args)
public static String	formatMessage(ResourceBundle bundle, String messageId, Object[] arguments, boolean lastChance)
public static Object[]	getArgs(String sqlState, String sqlerrmc)
public static void	getLocalizedMessage(int sqlcode, not used. sqlcode, short sqlerrmc length errmcLen, String sql error message tokens, variable part of error message (ie., arguments) plus messageId, separated by separator. sqlerrmc, String not used sqlerrp, int not used errd0, int not used errd1, int not used errd2, int not used errd3, int not used errd4, int not used errd5, String not used warn, String 5-char sql state sqlState, String not used file, String client locale in string localeStr, String[] OUTPUT parameter, localized error message msg, int[] OUTPUT parameter, return code -- 0 for success rc) Method used by Derby Network Server to get localized message
public static String	Returns: the localized message getLocalizedMessage(Locale locale locale, String message id messageId, Object[] message arguments args) Method used by Derby Network Server to get localized message
public static int	Returns: the resulting hash hashString50(String The key to hash key) Hash function to split messages into 50 files based upon the message identifier or SQLState.
protected int	supportedMessageParamLength()

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

Field Detail

DB2_JCC_MAX_EXCEPTION_PARAM_LENGTH	back to summary
public static final int DB2_JCC_MAX_EXCEPTION_PARAM_LENGTH Pointer to the application requester for the session being serviced.

EN	back to summary
private static final Locale EN

SQLERRMC_MESSAGE_DELIMITER	back to summary
public static final String SQLERRMC_MESSAGE_DELIMITER

SQLERRMC_PREFORMATTED_MESSAGE_DELIMITER	back to summary
private static String SQLERRMC_PREFORMATTED_MESSAGE_DELIMITER `SQLERRMC_PREFORMATTED_MESSAGE_DELIMITER`, When full message text is sent for severe errors. This value separates the messages.

SQLERRMC_TOKEN_DELIMITER back to summary

SQLERRMC_TOKEN_DELIMITER	back to summary
public static String SQLERRMC_TOKEN_DELIMITER Delimiters for SQLERRMC values. The token delimiter value will be used to parse the MessageId from the SQLERRMC in MessageService.getLocalizedMessage and the MessageId will be used to retrive the localized message. If this delimiter value is changed please make sure to make appropriate changes in MessageService.getLocalizedMessage that gets called from SystemProcedures.SQLCAMESSAGE `SQLERRMC_TOKEN_DELIMITER` separates message argument tokens

public static String SQLERRMC_TOKEN_DELIMITER

Delimiters for SQLERRMC values. The token delimiter value will be used to parse the MessageId from the SQLERRMC in MessageService.getLocalizedMessage and the MessageId will be used to retrive the localized message. If this delimiter value is changed please make sure to make appropriate changes in MessageService.getLocalizedMessage that gets called from SystemProcedures.SQLCAMESSAGE SQLERRMC_TOKEN_DELIMITER separates message argument tokens

Constructor Detail

MessageUtils	back to summary
public MessageUtils()

Method Detail

buildDataTruncationSqlerrmc back to summary

buildDataTruncationSqlerrmc	back to summary
private String buildDataTruncationSqlerrmc(DataTruncation dt) Build the SQLERRMC for a `java.sql.DataTruncation` warning. Serialize all the fields of the `DataTruncation` instance in the order in which they appear in the parameter list of the constructor. Parameters dt:DataTruncation the `DataTruncation` instance to serialize Returns:String the SQLERRMC string with all fields of the warning

private String buildDataTruncationSqlerrmc(DataTruncation dt)

Build the SQLERRMC for a java.sql.DataTruncation warning. Serialize all the fields of the DataTruncation instance in the order in which they appear in the parameter list of the constructor.

Parameters

dt:DataTruncation: the DataTruncation instance to serialize

Returns:String

the SQLERRMC string with all fields of the warning

buildPreformattedSqlerrmc	back to summary
private String buildPreformattedSqlerrmc(SQLException se) Build preformatted SQLException text for severe exceptions or SQLExceptions that are not Derby exceptions. Just send the message text localized to the server locale. Parameters se:SQLException SQLException for which to build SQLERRMC Returns:String preformated message text with messages separted by SQLERRMC_PREFORMATED_MESSAGE_DELIMITER

buildPreformattedSqlerrmc

back to summary

private String buildPreformattedSqlerrmc(SQLException se)

Build preformatted SQLException text for severe exceptions or SQLExceptions that are not Derby exceptions. Just send the message text localized to the server locale.

Parameters

se:SQLException: SQLException for which to build SQLERRMC

Returns:String

preformated message text with messages separted by SQLERRMC_PREFORMATED_MESSAGE_DELIMITER

encodeExceptionAsSqlerrmc	back to summary
public static String encodeExceptionAsSqlerrmc(SQLException se)

encodeMessageAndArgumentsAsSqlerrmc	back to summary
public static String encodeMessageAndArgumentsAsSqlerrmc(String messageId, Object[] args)

formatMessage	back to summary
public static String formatMessage(ResourceBundle bundle, String messageId, Object[] arguments, boolean lastChance)

getArgs	back to summary
public static Object[] getArgs(String sqlState, String sqlerrmc)

getLocalizedMessage	back to summary
public static void getLocalizedMessage(int sqlcode, short errmcLen, String sqlerrmc, String sqlerrp, int errd0, int errd1, int errd2, int errd3, int errd4, int errd5, String warn, String sqlState, String file, String localeStr, String[] msg, int[] rc) Method used by Derby Network Server to get localized message Parameters sqlcode:int sqlcode, not used. errmcLen:short sqlerrmc length sqlerrmc:String sql error message tokens, variable part of error message (ie., arguments) plus messageId, separated by separator. sqlerrp:String not used errd0:int not used errd1:int not used errd2:int not used errd3:int not used errd4:int not used errd5:int not used warn:String not used sqlState:String 5-char sql state file:String not used localeStr:String client locale in string msg:String[] OUTPUT parameter, localized error message rc:int[] OUTPUT parameter, return code -- 0 for success

getLocalizedMessage

back to summary

public static void getLocalizedMessage(int sqlcode, short errmcLen, String sqlerrmc, String sqlerrp, int errd0, int errd1, int errd2, int errd3, int errd4, int errd5, String warn, String sqlState, String file, String localeStr, String[] msg, int[] rc)

Method used by Derby Network Server to get localized message

Parameters

sqlcode:int: sqlcode, not used.
errmcLen:short: sqlerrmc length
sqlerrmc:String: sql error message tokens, variable part of error message (ie., arguments) plus messageId, separated by separator.
sqlerrp:String: not used
errd0:int: not used
errd1:int: not used
errd2:int: not used
errd3:int: not used
errd4:int: not used
errd5:int: not used
warn:String: not used
sqlState:String: 5-char sql state
file:String: not used
localeStr:String: client locale in string
msg:String[]: OUTPUT parameter, localized error message
rc:int[]: OUTPUT parameter, return code -- 0 for success

getLocalizedMessage	back to summary
public static String getLocalizedMessage(Locale locale, String messageId, Object[] args) Method used by Derby Network Server to get localized message Parameters locale:Locale locale messageId:String message id args:Object[] message arguments Returns:String the localized message

getLocalizedMessage

back to summary

public static String getLocalizedMessage(Locale locale, String messageId, Object[] args)

Method used by Derby Network Server to get localized message

Parameters

locale:Locale: locale
messageId:String: message id
args:Object[]: message arguments

Returns:String

the localized message

hashString50	back to summary
public static int hashString50(String key) Hash function to split messages into 50 files based upon the message identifier or SQLState. We don't use String.hashCode() as it varies between releases and doesn't provide an even distribution across the 50 files. Parameters key:String The key to hash Returns:int the resulting hash

hashString50

back to summary

public static int hashString50(String key)

Hash function to split messages into 50 files based upon the message identifier or SQLState. We don't use String.hashCode() as it varies between releases and doesn't provide an even distribution across the 50 files.

Parameters

key:String: The key to hash

Returns:int

the resulting hash

supportedMessageParamLength	back to summary
protected int supportedMessageParamLength()

public Class MessageUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail