- java.lang.Object
-
- com.microsoft.sqlserver.jdbc.SQLServerInfoMessage
-
- All Implemented Interfaces:
ISQLServerMessage
public final class SQLServerInfoMessage extends Object implements ISQLServerMessage
Holds information about SQL Server messages that is considered as Informational Messages (normally if SQL Server Severity is at 10)Instead of just holding the SQL Server message (like a normal SQLWarning, it also holds all the SQL Servers extended information, like: ErrorSeverity, ServerName, ProcName etc
This enables client to print out extra information about the message.
Like: In what procedure was the message produced.A SQLServerInfoMessage is produced when reading the TDS Stream and added to the Connection as a SQLServerWarning
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetErrorMessage()Returns error message as received from SQL ServerintgetErrorNumber()Returns error number as received from SQL ServerintgetErrorSeverity()Returns Severity of error (as int value) as received from SQL ServerintgetErrorState()Returns error state as received from SQL ServerlonggetLineNumber()Returns line number where the error occurred in Stored Procedure returned bygetProcedureName()as received from SQL ServerStringgetProcedureName()Returns name of the stored procedure where exception occurs as received from SQL ServerStringgetServerName()Returns name of the server where exception occurs as received from SQL ServerSQLServerErrorgetSQLServerMessage()Returns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.SQLExceptiontoSqlExceptionOrSqlWarning()Creates a SQLServerException or SQLServerWarning from this SQLServerMessageISQLServerMessagetoSQLServerError()Upgrade a Info message into a Error messageISQLServerMessagetoSQLServerError(int newErrorSeverity)Upgrade a Info message into a Error messageISQLServerMessagetoSQLServerError(int newErrorSeverity, int newErrorNumber)Upgrade a Info message into a Error message-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerMessage
isErrorMessage, isInfoMessage
-
-
-
-
Method Detail
-
getSQLServerMessage
public SQLServerError getSQLServerMessage()
Description copied from interface:ISQLServerMessageReturns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.- Specified by:
getSQLServerMessagein interfaceISQLServerMessage- Returns:
- SQLServerError
-
getErrorMessage
public String getErrorMessage()
Description copied from interface:ISQLServerMessageReturns error message as received from SQL Server- Specified by:
getErrorMessagein interfaceISQLServerMessage- Returns:
- Error Message
-
getErrorNumber
public int getErrorNumber()
Description copied from interface:ISQLServerMessageReturns error number as received from SQL Server- Specified by:
getErrorNumberin interfaceISQLServerMessage- Returns:
- Error Number
-
getErrorState
public int getErrorState()
Description copied from interface:ISQLServerMessageReturns error state as received from SQL Server- Specified by:
getErrorStatein interfaceISQLServerMessage- Returns:
- Error State
-
getErrorSeverity
public int getErrorSeverity()
Description copied from interface:ISQLServerMessageReturns Severity of error (as int value) as received from SQL Server- Specified by:
getErrorSeverityin interfaceISQLServerMessage- Returns:
- Error Severity
-
getServerName
public String getServerName()
Description copied from interface:ISQLServerMessageReturns name of the server where exception occurs as received from SQL Server- Specified by:
getServerNamein interfaceISQLServerMessage- Returns:
- Server Name
-
getProcedureName
public String getProcedureName()
Description copied from interface:ISQLServerMessageReturns name of the stored procedure where exception occurs as received from SQL Server- Specified by:
getProcedureNamein interfaceISQLServerMessage- Returns:
- Procedure Name
-
getLineNumber
public long getLineNumber()
Description copied from interface:ISQLServerMessageReturns line number where the error occurred in Stored Procedure returned bygetProcedureName()as received from SQL Server- Specified by:
getLineNumberin interfaceISQLServerMessage- Returns:
- Line Number
-
toSQLServerError
public ISQLServerMessage toSQLServerError()
Upgrade a Info message into a Error messageThis simply create a SQLServerError from this SQLServerInfoMessage, without changing the message content.
- Returns:
- ISQLServerMessage
-
toSQLServerError
public ISQLServerMessage toSQLServerError(int newErrorSeverity)
Upgrade a Info message into a Error messageThis simply create a SQLServerError from this SQLServerInfoMessage.
- Parameters:
newErrorSeverity- - The new ErrorSeverity- Returns:
- ISQLServerMessage
-
toSQLServerError
public ISQLServerMessage toSQLServerError(int newErrorSeverity, int newErrorNumber)
Upgrade a Info message into a Error messageThis simply create a SQLServerError from this SQLServerInfoMessage.
- Parameters:
newErrorSeverity- - If you want to change the ErrorSeverity (-1: leave unchanged)newErrorNumber- - If you want to change the ErrorNumber (-1: leave unchanged)- Returns:
- ISQLServerMessage
-
toSqlExceptionOrSqlWarning
public SQLException toSqlExceptionOrSqlWarning()
Description copied from interface:ISQLServerMessageCreates a SQLServerException or SQLServerWarning from this SQLServerMessage- Specified by:
toSqlExceptionOrSqlWarningin interfaceISQLServerMessage- Returns:
- SQLServerException if it's a SQLServerError object
- SQLServerWarning if it's a SQLServerInfoMessage object
-
-