Class BaseContext

java.lang.Object
org.mariadb.jdbc.client.context.BaseContext
All Implemented Interfaces:
Context
Direct Known Subclasses:
RedoContext
public class BaseContext extends Object implements Context
Context (current connection state) of a connection

  • Field Details

    • serverCapabilities

      private final long serverCapabilities

    • clientCapabilities

      private final long clientCapabilities

    • seed

      private final byte[] seed

    • version

      private final ServerVersion version

    • eofDeprecated

      private final boolean eofDeprecated

    • skipMeta

      private final boolean skipMeta

    • columnDecoderFunction

      private final Function<ReadableByteBuf, ColumnDecoder> columnDecoderFunction

    • conf

      private final Configuration conf

    • exceptionFactory

      private final ExceptionFactory exceptionFactory

    • canUseTransactionIsolation

      private final boolean canUseTransactionIsolation

    • loopbackAddress

      private final Boolean loopbackAddress

    • prepareCache

      private final PrepareCache prepareCache
      LRU prepare cache object

    • hostAddress

      private final HostAddress hostAddress

    • serverStatus

      protected int serverStatus
      Server status context

    • autoIncrement

      private Long autoIncrement

    • maxscaleVersion

      private String maxscaleVersion

    • threadId

      private long threadId

    • charset

      private String charset

    • initialized

      private boolean initialized

    • connectionCloser

      private final Runnable connectionCloser

    • database

      private String database
      Server current database

    • transactionIsolationLevel

      private Integer transactionIsolationLevel
      Server current transaction isolation level

    • warning

      private int warning
      Server current warning count

    • stateFlag

      private int stateFlag
      Connection state use flag

    • serverReadOnly

      private boolean serverReadOnly
      Read-only state currently applied on the server session

    • redirectUrl

      private String redirectUrl

    • connectionTimeZone

      private TimeZone connectionTimeZone

  • Constructor Details

    • BaseContext

      public BaseContext(HostAddress hostAddress, InitialHandshakePacket handshake, long clientCapabilities, Configuration conf, ExceptionFactory exceptionFactory, PrepareCache prepareCache, Boolean loopbackAddress, Runnable connectionCloser)
      Constructor of connection context
      Parameters:
      hostAddress - host address
      handshake - server handshake
      clientCapabilities - client capabilities
      conf - connection configuration
      exceptionFactory - connection exception factory
      prepareCache - LRU prepare cache
      loopbackAddress - is local address

  • Method Details

    • isLoopbackAddress

      public Boolean isLoopbackAddress()
      Description copied from interface: Context
      return if host is a local address
      Specified by:
      isLoopbackAddress in interface Context
      Returns:
      true if host is local

    • getThreadId

      public long getThreadId()
      Description copied from interface: Context
      return current thread id
      Specified by:
      getThreadId in interface Context
      Returns:
      current server thread id

    • setThreadId

      public void setThreadId(long connectionId)
      Description copied from interface: Context
      Indicate server connection Id (not truncated)
      Specified by:
      setThreadId in interface Context
      Parameters:
      connectionId - connection id

    • getSeed

      public byte[] getSeed()
      Description copied from interface: Context
      Get connection initial seed
      Specified by:
      getSeed in interface Context
      Returns:
      initial seed

    • hasServerCapability

      public boolean hasServerCapability(long flag)
      Description copied from interface: Context
      has server capability
      Specified by:
      hasServerCapability in interface Context
      Parameters:
      flag - capability to check
      Returns:
      true if server has capability

    • hasClientCapability

      public boolean hasClientCapability(long flag)
      Description copied from interface: Context
      has client capability
      Specified by:
      hasClientCapability in interface Context
      Parameters:
      flag - capability to check
      Returns:
      true if client has capability

    • permitPipeline

      public boolean permitPipeline()
      Description copied from interface: Context
      Does server and client permit pipeline
      Specified by:
      permitPipeline in interface Context
      Returns:
      true if permitted

    • getServerStatus

      public int getServerStatus()
      Description copied from interface: Context
      Get server connection state
      Specified by:
      getServerStatus in interface Context
      Returns:
      server status

    • setServerStatus

      public void setServerStatus(int serverStatus)
      Description copied from interface: Context
      Set server connection state
      Specified by:
      setServerStatus in interface Context
      Parameters:
      serverStatus - server status

    • getDatabase

      public String getDatabase()
      Description copied from interface: Context
      Get current connection database
      Specified by:
      getDatabase in interface Context
      Returns:
      database

    • setMaxscaleVersion

      public void setMaxscaleVersion(String maxscaleVersion)
      Description copied from interface: Context
      Set Maxscale version.
      Specified by:
      setMaxscaleVersion in interface Context
      Parameters:
      maxscaleVersion - maxscale version

    • setDatabase

      public void setDatabase(String database)
      Description copied from interface: Context
      set current database context
      Specified by:
      setDatabase in interface Context
      Parameters:
      database - database

    • getMaxscaleVersion

      public String getMaxscaleVersion()
      Description copied from interface: Context
      Retrieve maxscaleVersion or null if not the case
      Specified by:
      getMaxscaleVersion in interface Context
      Returns:
      maxscale version

    • getVersion

      public ServerVersion getVersion()
      Description copied from interface: Context
      Retrieve server version information
      Specified by:
      getVersion in interface Context
      Returns:
      server version

    • isEofDeprecated

      public boolean isEofDeprecated()
      Description copied from interface: Context
      does protocol remove EOF in exchanges
      Specified by:
      isEofDeprecated in interface Context
      Returns:
      if EOF packet are deprecated

    • getColumnDecoderFunction

      public Function<ReadableByteBuf, ColumnDecoder> getColumnDecoderFunction()
      Description copied from interface: Context
      Column decoder function
      Specified by:
      getColumnDecoderFunction in interface Context
      Returns:
      Column decoder function

    • canSkipMeta

      public boolean canSkipMeta()
      Description copied from interface: Context
      Can server skip prepared statement metadata
      Specified by:
      canSkipMeta in interface Context
      Returns:
      true if possible

    • getWarning

      public int getWarning()
      Description copied from interface: Context
      has server warnings
      Specified by:
      getWarning in interface Context
      Returns:
      has warnings

    • setWarning

      public void setWarning(int warning)
      Description copied from interface: Context
      set server state warning number
      Specified by:
      setWarning in interface Context
      Parameters:
      warning - warning number

    • getExceptionFactory

      public ExceptionFactory getExceptionFactory()
      Description copied from interface: Context
      Get connection exception factory
      Specified by:
      getExceptionFactory in interface Context
      Returns:
      exception factory

    • getConf

      public Configuration getConf()
      Description copied from interface: Context
      Get connection configuration
      Specified by:
      getConf in interface Context
      Returns:
      configuration

    • getTransactionIsolationLevel

      public Integer getTransactionIsolationLevel()
      Description copied from interface: Context
      Get connection transaction isolation level
      Specified by:
      getTransactionIsolationLevel in interface Context
      Returns:
      connection transaction isolation level

    • setTransactionIsolationLevel

      public void setTransactionIsolationLevel(Integer transactionIsolationLevel)
      Description copied from interface: Context
      Set current connection transaction isolation level
      Specified by:
      setTransactionIsolationLevel in interface Context
      Parameters:
      transactionIsolationLevel - new connection transaction isolation level

    • getPrepareCacheCmd

      public Prepare getPrepareCacheCmd(String sql, BasePreparedStatement preparedStatement)
      Description copied from interface: Context
      Return cached prepare if key match
      Specified by:
      getPrepareCacheCmd in interface Context
      Parameters:
      sql - sql command
      preparedStatement - current statement
      Returns:
      Prepare if found, null if not

    • putPrepareCacheCmd

      public Prepare putPrepareCacheCmd(String sql, Prepare result, BasePreparedStatement preparedStatement)
      Description copied from interface: Context
      Put prepare result in cache
      Specified by:
      putPrepareCacheCmd in interface Context
      Parameters:
      sql - sql command
      result - prepare result
      preparedStatement - current statement
      Returns:
      Prepare if was already cached

    • resetPrepareCache

      public void resetPrepareCache()
      Description copied from interface: Context
      Reset prepare cache (after a failover)
      Specified by:
      resetPrepareCache in interface Context

    • getStateFlag

      public int getStateFlag()
      Description copied from interface: Context
      return connection current state change flag
      Specified by:
      getStateFlag in interface Context
      Returns:
      connection current state change flag

    • resetStateFlag

      public void resetStateFlag()
      Description copied from interface: Context
      reset connection state change flag
      Specified by:
      resetStateFlag in interface Context

    • addStateFlag

      public void addStateFlag(int state)
      Description copied from interface: Context
      Indicate connection state (for pooling)
      Specified by:
      addStateFlag in interface Context
      Parameters:
      state - indicate that some connection state has changed

    • isServerReadOnly

      public boolean isServerReadOnly()
      Description copied from interface: Context
      Read-only state currently applied on the server session, i.e. whether the last effective SET SESSION TRANSACTION READ ONLY / READ WRITE left the session read-only. Used with the readOnlyPropagatesToServer option to avoid issuing redundant statements and to replay the state on failover.
      Specified by:
      isServerReadOnly in interface Context
      Returns:
      true if the server session is currently in read-only mode

    • setServerReadOnly

      public void setServerReadOnly(boolean serverReadOnly)
      Description copied from interface: Context
      Record the read-only state currently applied on the server session.
      Specified by:
      setServerReadOnly in interface Context
      Parameters:
      serverReadOnly - true if the server session is read-only

    • setTreadsConnected

      public void setTreadsConnected(long threadsConnected)
      Description copied from interface: Context
      Indicate the number of connection on this server
      Specified by:
      setTreadsConnected in interface Context
      Parameters:
      threadsConnected - number of connected threads

    • getAutoIncrement

      public Long getAutoIncrement()
      Description copied from interface: Context
      Get server current auto_increment value
      Specified by:
      getAutoIncrement in interface Context
      Returns:
      server auto increment

    • setAutoIncrement

      public void setAutoIncrement(long autoIncrement)
      Description copied from interface: Context
      Set server autoincrement value
      Specified by:
      setAutoIncrement in interface Context
      Parameters:
      autoIncrement - current server autoincrement value

    • getCharset

      public String getCharset()
      Description copied from interface: Context
      Retrieve current charset if session state get it
      Specified by:
      getCharset in interface Context
      Returns:
      current charset

    • setCharset

      public void setCharset(String charset) throws SQLNonTransientConnectionException
      Description copied from interface: Context
      Indicate server charset change. Throws when the new charset isn't compatible with the driver's UTF-8 assumption (only utf8 / utf8mb3 / utf8mb4 are accepted post-init).
      Specified by:
      setCharset in interface Context
      Parameters:
      charset - server charset
      Throws:
      SQLNonTransientConnectionException

    • setCharsetResults

      public void setCharsetResults(String charset) throws SQLNonTransientConnectionException
      Description copied from interface: Context
      Indicate server character_set_results change. Throws when the new charset isn't compatible with the driver's UTF-8 result decoding (only utf8 / utf8mb3 / utf8mb4, or no conversion, are accepted post-init).
      Specified by:
      setCharsetResults in interface Context
      Parameters:
      charset - results charset, empty when results are sent without conversion
      Throws:
      SQLNonTransientConnectionException

    • rejectNonUtf8

      private void rejectNonUtf8(String what, String charset) throws SQLNonTransientConnectionException
      Throws:
      SQLNonTransientConnectionException

    • setInitialized

      public void setInitialized()
      Description copied from interface: Context
      Indicate that connection is initialized and ready to handle commands. Used to avoid accepting server
      Specified by:
      setInitialized in interface Context

    • getRedirectUrl

      public String getRedirectUrl()
      Description copied from interface: Context
      get redirect Url if server indicate reconnection url
      Specified by:
      getRedirectUrl in interface Context
      Returns:
      null if no redirection required, value if so

    • canUseTransactionIsolation

      public boolean canUseTransactionIsolation()
      Description copied from interface: Context
      Can rely on transaction_isolation or keep using deprecated tx_isolation variable
      Specified by:
      canUseTransactionIsolation in interface Context
      Returns:
      true if you can use transaction_isolation

    • setRedirectUrl

      public void setRedirectUrl(String redirectUrl)
      Description copied from interface: Context
      Set server redirection url
      Specified by:
      setRedirectUrl in interface Context
      Parameters:
      redirectUrl - redirect url

    • getConnectionTimeZone

      public TimeZone getConnectionTimeZone()
      Description copied from interface: Context
      Get current connection timezone
      Specified by:
      getConnectionTimeZone in interface Context
      Returns:
      connection timezone

    • setConnectionTimeZone

      public void setConnectionTimeZone(TimeZone connectionTimeZone)
      Description copied from interface: Context
      Set current connection timezone
      Specified by:
      setConnectionTimeZone in interface Context
      Parameters:
      connectionTimeZone - connection timezone

    • getDefaultCalendar

      public Calendar getDefaultCalendar()
      Description copied from interface: Context
      Get calendar depending on configuration
      Specified by:
      getDefaultCalendar in interface Context
      Returns:
      calendar