public Class CommunicationsException

Class Inheritance

extends SQLRecoverableException
implements StreamingNotifiable

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.sql.SQLException
java.sql.SQLRecoverableException
com.mysql.cj.jdbc.exceptions.CommunicationsException

All Implemented Interfaces

com.mysql.cj.exceptions.StreamingNotifiable

Known Direct Subclasses

com.mysql.cj.jdbc.exceptions.ConnectionFeatureNotAvailableException

Imports

java.sql.SQLRecoverableException, com.mysql.cj.Messages, com.mysql.cj.exceptions.ExceptionFactory, .MysqlErrorNumbers, .StreamingNotifiable, com.mysql.cj.jdbc.JdbcConnection, com.mysql.cj.protocol.PacketReceivedTimeHolder, .PacketSentTimeHolder

An exception to represent communications errors with the database. Attempts to provide 'friendlier' error messages to end-users, including the last time a packet was sent to the database, what the client-timeout is set to, and whether the idle time has been exceeded.

Field Summary

Modifier and Type	Field and Description
private String	exceptionMessage
private static final long	serialVersionUID Hides java.sql.SQLRecoverableException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	CommunicationsException(JdbcConnection conn, PacketSentTimeHolder packetSentTimeHolder, PacketReceivedTimeHolder packetReceivedTimeHolder, Exception underlyingException)
public	CommunicationsException(String message, Throwable underlyingException)

Method Summary

Modifier and Type	Method and Description
public String	getMessage() Overrides java.lang.Throwable.getMessage. Returns the detail message string of this throwable.
public String	getSQLState() Overrides java.sql.SQLException.getSQLState. Retrieves the SQLState for this `SQLException` object.
public void	setWasStreamingResults() Implements com.mysql.cj.exceptions.StreamingNotifiable.setWasStreamingResults.

Field Detail

exceptionMessage	back to summary
private String exceptionMessage

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.sql.SQLRecoverableException.serialVersionUID.

Constructor Detail

CommunicationsException	back to summary
public CommunicationsException(JdbcConnection conn, PacketSentTimeHolder packetSentTimeHolder, PacketReceivedTimeHolder packetReceivedTimeHolder, Exception underlyingException)

CommunicationsException	back to summary
public CommunicationsException(String message, Throwable underlyingException)

Method Detail

getMessage back to summary

getMessage	back to summary
public String getMessage() Overrides java.lang.Throwable.getMessage. Doc from java.lang.Throwable.getMessage. Returns the detail message string of this throwable. Returns:String the detail message string of this `Throwable` instance (which may be `null`). Annotations @Override

public String getMessage()

Overrides java.lang.Throwable.getMessage.

Doc from java.lang.Throwable.getMessage.

Returns the detail message string of this throwable.

Returns:String

the detail message string of this Throwable instance (which may be null).

Annotations

@Override

getSQLState back to summary

getSQLState	back to summary
public String getSQLState() Overrides java.sql.SQLException.getSQLState. Doc from java.sql.SQLException.getSQLState. Retrieves the SQLState for this `SQLException` object. Returns:String the SQLState value Annotations @Override

public String getSQLState()

Overrides java.sql.SQLException.getSQLState.

Doc from java.sql.SQLException.getSQLState.

Retrieves the SQLState for this SQLException object.

Returns:String

the SQLState value

Annotations

@Override

setWasStreamingResults	back to summary
public void setWasStreamingResults() Implements com.mysql.cj.exceptions.StreamingNotifiable.setWasStreamingResults. Annotations @Override

setWasStreamingResults

back to summary

public void setWasStreamingResults()

Implements com.mysql.cj.exceptions.StreamingNotifiable.setWasStreamingResults.

Annotations

@Override