AbstractMastersListener (oceanbase-client 2.4.11 API)

java.lang.Object
- com.oceanbase.jdbc.internal.failover.AbstractMastersListener

所有已实现的接口:

Listener

直接已知子类:

AbstractMastersSlavesListener, MastersFailoverListener
```
public abstract class AbstractMastersListener
extends Object
implements Listener
```

字段概要

字段
限定符和类型	字段和说明
`protected AtomicInteger`	`currentConnectionAttempts`
`protected Protocol`	`currentProtocol`
`protected boolean`	`currentReadOnlyAsked`
`protected AtomicBoolean`	`explicitClosed`
`protected GlobalStateInfo`	`globalInfo`
`protected long`	`lastQueryNanos`
`protected long`	`lastRetry`
`protected static Logger`	`lockLogger`
`protected FailoverProxy`	`proxy`
`UrlParser`	`urlParser`

构造器概要

构造器
限定符构造器和说明

protected AbstractMastersListener(UrlParser urlParser, GlobalStateInfo globalInfo)

构造器
限定符	构造器和说明
`protected`	`AbstractMastersListener(UrlParser urlParser, GlobalStateInfo globalInfo)`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`abortConnection(Protocol protocol)` Utility to force close existing connection.
`void`	`addToBlacklist(HostAddress hostAddress)` After a failover, put the hostAddress in a static list so the other connection will not take this host in account for a time.
`void`	`addToPickedList(HostAddress hostAddress)`
`boolean`	`canRetryFailLoop()`
`abstract boolean`	`checkMasterStatus(SearchFilter searchFilter)`
`static void`	`clearBlacklist()` Clear blacklist data.
`void`	`closeConnection(Protocol protocol)` Utility to close existing connection.
`ConcurrentMap<HostAddress,HostStateInfo>`	`getBlacklist()`
`Set<HostAddress>`	`getBlacklistKeys()`
`String`	`getCatalog()`
`LoadBalanceInfo`	`getCurrentLoadBalanceInfo()`
`Protocol`	`getCurrentProtocol()`
`SearchFilter`	`getFilterForFailedHost()`
`long`	`getLastQueryNanos()`
`int`	`getMajorServerVersion()`
`long`	`getMasterHostFailNanos()`
`Set<HostAddress>`	`getPickedlist()`
`FailoverProxy`	`getProxy()`
`int`	`getRetriesAllDown()`
`int`	`getRetryAllDowns()`
`int`	`getTimeout()`
`UrlParser`	`getUrlParser()`
`abstract void`	`handleFailLoop()`
`HandleErrorResult`	`handleFailover(SQLException qe, Method method, Object[] args, Protocol protocol, boolean isClosed)` Call when a failover is detected on master connection.
`boolean`	`hasHostFail()`
`void`	`initializeConnection()` Initialize Listener.
`boolean`	`inTransaction()`
`Object`	`invoke(Method method, Object[] args)`
`Object`	`invoke(Method method, Object[] args, Protocol specificProtocol)`
`boolean`	`isAutoReconnect()`
`boolean`	`isClosed()`
`boolean`	`isExplicitClosed()`
`boolean`	`isMasterConnection()`
`boolean`	`isMasterHostFail()`
`boolean`	`isQueryRelaunchable(Method method, Object[] args)` Check if query can be re-executed.
`boolean`	`isReadOnly()`
`boolean`	`isServerMariaDb()`
`boolean`	`isValid(int timeout)`
`boolean`	`noBackslashEscapes()`
`protected boolean`	`pingMasterProtocol(Protocol protocol)`
`protected void`	`preAutoReconnect()`
`abstract void`	`preClose()`
`abstract void`	`preExecute()`
`abstract HandleErrorResult`	`primaryFail(Method method, Object[] args, boolean killCmd, boolean isClosed)`
`void`	`prolog(long maxRows, OceanBaseConnection connection, OceanBaseStatement statement)`
`abstract void`	`reconnect()`
`abstract void`	`reconnectFailedConnection(SearchFilter filter)`
`HandleErrorResult`	`relaunchOperation(Method method, Object[] args)` After a failover that has bean done, relaunch the operation that was in progress.
`void`	`removeFromBlacklist(HostAddress hostAddress)` After a successfull connection, permit to remove a hostAddress from blacklist.
`void`	`removeFromPickedList(HostAddress hostAddress)`
`protected void`	`removeListenerFromSchedulers()`
`void`	`resetHostStateInfo(HostAddress hostAddress)`
`void`	`resetMasterFailoverData()`
`void`	`resetOldsBlackListHosts()` Permit to remove Host to blacklist after loadBalanceBlacklistTimeout seconds.
`boolean`	`sessionStateAware()`
`void`	`setCurrentLoadBalanceInfo(LoadBalanceInfo loadBalanceInfo)`
`boolean`	`setMasterHostFail()` Set master fail variables.
`void`	`setProxy(FailoverProxy proxy)`
`void`	`setRetryAllDowns(int retryAllDowns)`
`protected void`	`setSessionReadOnly(boolean readOnly, Protocol protocol)`
`abstract void`	`switchReadOnlyConnection(Boolean readonly)`
`void`	`syncConnection(Protocol from, Protocol to)` When switching between 2 connections, report existing connection parameter to the new used connection.
`void`	`throwFailoverMessage(HostAddress failHostAddress, boolean wasMaster, SQLException queryException, boolean reconnected)` Throw a human readable message after a failoverException.
`boolean`	`versionGreaterOrEqual(int major, int minor, int patch)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.oceanbase.jdbc.internal.failover.Listener
foundActiveMaster, getServerThreadId, isMasterConnected, preAbort, rePrepareOnSlave, reset

- 字段详细资料
  - urlParser
```
public final UrlParser urlParser
```
  - currentConnectionAttempts
```
protected final AtomicInteger currentConnectionAttempts
```
  - explicitClosed
```
protected final AtomicBoolean explicitClosed
```
  - globalInfo
```
protected final GlobalStateInfo globalInfo
```
  - currentReadOnlyAsked
```
protected volatile boolean currentReadOnlyAsked
```
  - currentProtocol
```
protected Protocol currentProtocol
```
  - proxy
```
protected FailoverProxy proxy
```
  - lastRetry
```
protected long lastRetry
```
  - lastQueryNanos
```
protected long lastQueryNanos
```
  - lockLogger
```
protected static final Logger lockLogger
```
- 构造器详细资料
  - AbstractMastersListener
```
protected AbstractMastersListener(UrlParser urlParser,
                                  GlobalStateInfo globalInfo)
```
- 方法详细资料
  - setCurrentLoadBalanceInfo
```
public void setCurrentLoadBalanceInfo(LoadBalanceInfo loadBalanceInfo)
```
    指定者:
    
    setCurrentLoadBalanceInfo 在接口中 Listener
  - getCurrentLoadBalanceInfo
```
public LoadBalanceInfo getCurrentLoadBalanceInfo()
```
    指定者:
    
    getCurrentLoadBalanceInfo 在接口中 Listener
  - setRetryAllDowns
```
public void setRetryAllDowns(int retryAllDowns)
```
    指定者:
    
    setRetryAllDowns 在接口中 Listener
  - getRetryAllDowns
```
public int getRetryAllDowns()
```
    指定者:
    
    getRetryAllDowns 在接口中 Listener
  - clearBlacklist
```
public static void clearBlacklist()
```
    Clear blacklist data.
  - initializeConnection
```
public void initializeConnection()
                          throws SQLException
```
    Initialize Listener. This listener will be added to the connection validation loop according to option value so the connection will be verified periodically. (Important for aurora, for other, connection pool often have this functionality)
    
    指定者:
    
    initializeConnection 在接口中 Listener
    
    抛出:
    
    SQLException - if any exception occur.
  - removeListenerFromSchedulers
```
protected void removeListenerFromSchedulers()
```
  - preAutoReconnect
```
protected void preAutoReconnect()
                         throws SQLException
```
    抛出:
    
    SQLException
  - getProxy
```
public FailoverProxy getProxy()
```
    指定者:
    
    getProxy 在接口中 Listener
  - setProxy
```
public void setProxy(FailoverProxy proxy)
```
    指定者:
    
    setProxy 在接口中 Listener
  - getPickedlist
```
public Set<HostAddress> getPickedlist()
```
  - addToPickedList
```
public void addToPickedList(HostAddress hostAddress)
```
    指定者:
    
    addToPickedList 在接口中 Listener
    
    参数:
    
    hostAddress - the HostAddress has failed to connect but not triggered the blacklist AppendStrategy
  - removeFromPickedList
```
public void removeFromPickedList(HostAddress hostAddress)
```
    指定者:
    
    removeFromPickedList 在接口中 Listener
  - getBlacklistKeys
```
public Set<HostAddress> getBlacklistKeys()
```
    指定者:
    
    getBlacklistKeys 在接口中 Listener
  - getBlacklist
```
public ConcurrentMap<HostAddress,HostStateInfo> getBlacklist()
```
    指定者:
    
    getBlacklist 在接口中 Listener
  - handleFailover
```
public HandleErrorResult handleFailover(SQLException qe,
                                        Method method,
                                        Object[] args,
                                        Protocol protocol,
                                        boolean isClosed)
                                 throws SQLException
```
    Call when a failover is detected on master connection. Will :
    1. set fail variable
    2. try to reconnect
    3. relaunch query if possible
    指定者:
    
    handleFailover 在接口中 Listener
    
    参数:
    
    method - called method
    
    args - methods parameters
    
    protocol - current protocol
    
    返回:
    
    a HandleErrorResult object to indicate if query has been relaunched, and the exception if not
    
    抛出:
    
    SQLException - when method and parameters does not exist.
  - addToBlacklist
```
public void addToBlacklist(HostAddress hostAddress)
```
    After a failover, put the hostAddress in a static list so the other connection will not take this host in account for a time.
    
    指定者:
    
    addToBlacklist 在接口中 Listener
    
    参数:
    
    hostAddress - the HostAddress to add to blacklist
  - removeFromBlacklist
```
public void removeFromBlacklist(HostAddress hostAddress)
```
    After a successfull connection, permit to remove a hostAddress from blacklist.
    
    指定者:
    
    removeFromBlacklist 在接口中 Listener
    
    参数:
    
    hostAddress - the host address which is going to be removed from blacklist
  - resetHostStateInfo
```
public void resetHostStateInfo(HostAddress hostAddress)
```
    指定者:
    
    resetHostStateInfo 在接口中 Listener
  - resetOldsBlackListHosts
```
public void resetOldsBlackListHosts()
```
    Permit to remove Host to blacklist after loadBalanceBlacklistTimeout seconds.
    
    指定者:
    
    resetOldsBlackListHosts 在接口中 Listener
  - resetMasterFailoverData
```
public void resetMasterFailoverData()
```
  - setSessionReadOnly
```
protected void setSessionReadOnly(boolean readOnly,
                                  Protocol protocol)
                           throws SQLException
```
    抛出:
    
    SQLException
  - handleFailLoop
```
public abstract void handleFailLoop()
```
  - getCurrentProtocol
```
public Protocol getCurrentProtocol()
```
    指定者:
    
    getCurrentProtocol 在接口中 Listener
  - getMasterHostFailNanos
```
public long getMasterHostFailNanos()
```
  - setMasterHostFail
```
public boolean setMasterHostFail()
```
    Set master fail variables.
    
    指定者:
    
    setMasterHostFail 在接口中 Listener
    
    返回:
    
    true if was already failed
  - isMasterHostFail
```
public boolean isMasterHostFail()
```
    指定者:
    
    isMasterHostFail 在接口中 Listener
  - hasHostFail
```
public boolean hasHostFail()
```
    指定者:
    
    hasHostFail 在接口中 Listener
  - getFilterForFailedHost
```
public SearchFilter getFilterForFailedHost()
```
    指定者:
    
    getFilterForFailedHost 在接口中 Listener
  - relaunchOperation
```
public HandleErrorResult relaunchOperation(Method method,
                                           Object[] args)
                                    throws SQLException
```
    After a failover that has bean done, relaunch the operation that was in progress. In case of special operation that crash server, doesn't relaunched it;
    
    参数:
    
    method - the method accessed
    
    args - the parameters
    
    返回:
    
    An object that indicate the result or that the exception as to be thrown
    
    抛出:
    
    SQLException - if there is any error relaunching initial method
  - isQueryRelaunchable
```
public boolean isQueryRelaunchable(Method method,
                                   Object[] args)
```
    Check if query can be re-executed.
    
    参数:
    
    method - invoke method
    
    args - invoke arguments
    
    返回:
    
    true if can be re-executed
  - invoke
```
public Object invoke(Method method,
                     Object[] args,
                     Protocol specificProtocol)
              throws Throwable
```
    指定者:
    
    invoke 在接口中 Listener
    
    抛出:
    
    Throwable
  - invoke
```
public Object invoke(Method method,
                     Object[] args)
              throws Throwable
```
    指定者:
    
    invoke 在接口中 Listener
    
    抛出:
    
    Throwable
  - syncConnection
```
public void syncConnection(Protocol from,
                           Protocol to)
                    throws SQLException
```
    When switching between 2 connections, report existing connection parameter to the new used connection.
    
    指定者:
    
    syncConnection 在接口中 Listener
    
    参数:
    
    from - used connection
    
    to - will-be-current connection
    
    抛出:
    
    SQLException - if catalog cannot be set
  - versionGreaterOrEqual
```
public boolean versionGreaterOrEqual(int major,
                                     int minor,
                                     int patch)
```
    指定者:
    
    versionGreaterOrEqual 在接口中 Listener
  - isServerMariaDb
```
public boolean isServerMariaDb()
```
    指定者:
    
    isServerMariaDb 在接口中 Listener
  - sessionStateAware
```
public boolean sessionStateAware()
```
    指定者:
    
    sessionStateAware 在接口中 Listener
  - noBackslashEscapes
```
public boolean noBackslashEscapes()
```
    指定者:
    
    noBackslashEscapes 在接口中 Listener
  - getMajorServerVersion
```
public int getMajorServerVersion()
```
    指定者:
    
    getMajorServerVersion 在接口中 Listener
  - isClosed
```
public boolean isClosed()
```
    指定者:
    
    isClosed 在接口中 Listener
  - isValid
```
public boolean isValid(int timeout)
                throws SQLException
```
    指定者:
    
    isValid 在接口中 Listener
    
    抛出:
    
    SQLException
  - isReadOnly
```
public boolean isReadOnly()
```
    指定者:
    
    isReadOnly 在接口中 Listener
  - inTransaction
```
public boolean inTransaction()
```
    指定者:
    
    inTransaction 在接口中 Listener
  - isMasterConnection
```
public boolean isMasterConnection()
```
    指定者:
    
    isMasterConnection 在接口中 Listener
  - isExplicitClosed
```
public boolean isExplicitClosed()
```
    指定者:
    
    isExplicitClosed 在接口中 Listener
  - getRetriesAllDown
```
public int getRetriesAllDown()
```
    指定者:
    
    getRetriesAllDown 在接口中 Listener
  - isAutoReconnect
```
public boolean isAutoReconnect()
```
    指定者:
    
    isAutoReconnect 在接口中 Listener
  - getUrlParser
```
public UrlParser getUrlParser()
```
    指定者:
    
    getUrlParser 在接口中 Listener
  - preExecute
```
public abstract void preExecute()
                         throws SQLException
```
    指定者:
    
    preExecute 在接口中 Listener
    
    抛出:
    
    SQLException
  - preClose
```
public abstract void preClose()
```
    指定者:
    
    preClose 在接口中 Listener
  - reconnectFailedConnection
```
public abstract void reconnectFailedConnection(SearchFilter filter)
                                        throws SQLException
```
    指定者:
    
    reconnectFailedConnection 在接口中 Listener
    
    抛出:
    
    SQLException
  - switchReadOnlyConnection
```
public abstract void switchReadOnlyConnection(Boolean readonly)
                                       throws SQLException
```
    指定者:
    
    switchReadOnlyConnection 在接口中 Listener
    
    抛出:
    
    SQLException
  - primaryFail
```
public abstract HandleErrorResult primaryFail(Method method,
                                              Object[] args,
                                              boolean killCmd,
                                              boolean isClosed)
                                       throws SQLException
```
    指定者:
    
    primaryFail 在接口中 Listener
    
    抛出:
    
    SQLException
  - throwFailoverMessage
```
public void throwFailoverMessage(HostAddress failHostAddress,
                                 boolean wasMaster,
                                 SQLException queryException,
                                 boolean reconnected)
                          throws SQLException
```
    Throw a human readable message after a failoverException.
    
    指定者:
    
    throwFailoverMessage 在接口中 Listener
    
    参数:
    
    failHostAddress - failedHostAddress
    
    wasMaster - was failed connection master
    
    queryException - internal error
    
    reconnected - connection status
    
    抛出:
    
    SQLException - error with failover information
  - canRetryFailLoop
```
public boolean canRetryFailLoop()
```
    指定者:
    
    canRetryFailLoop 在接口中 Listener
  - prolog
```
public void prolog(long maxRows,
                   OceanBaseConnection connection,
                   OceanBaseStatement statement)
            throws SQLException
```
    指定者:
    
    prolog 在接口中 Listener
    
    抛出:
    
    SQLException
  - getCatalog
```
public String getCatalog()
                  throws SQLException
```
    指定者:
    
    getCatalog 在接口中 Listener
    
    抛出:
    
    SQLException
  - getTimeout
```
public int getTimeout()
               throws SocketException
```
    指定者:
    
    getTimeout 在接口中 Listener
    
    抛出:
    
    SocketException
  - reconnect
```
public abstract void reconnect()
                        throws SQLException
```
    指定者:
    
    reconnect 在接口中 Listener
    
    抛出:
    
    SQLException
  - checkMasterStatus
```
public abstract boolean checkMasterStatus(SearchFilter searchFilter)
```
    指定者:
    
    checkMasterStatus 在接口中 Listener
  - getLastQueryNanos
```
public long getLastQueryNanos()
```
    指定者:
    
    getLastQueryNanos 在接口中 Listener
  - pingMasterProtocol
```
protected boolean pingMasterProtocol(Protocol protocol)
```
  - closeConnection
```
public void closeConnection(Protocol protocol)
```
    Utility to close existing connection.
    
    参数:
    
    protocol - connection to close.
  - abortConnection
```
public void abortConnection(Protocol protocol)
```
    Utility to force close existing connection.
    
    参数:
    
    protocol - connection to close.

类 AbstractMastersListener

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 com.oceanbase.jdbc.internal.failover.Listener

字段详细资料

urlParser

currentConnectionAttempts

explicitClosed

globalInfo

currentReadOnlyAsked

currentProtocol

proxy

lastRetry

lastQueryNanos

lockLogger

构造器详细资料

AbstractMastersListener

方法详细资料

setCurrentLoadBalanceInfo

getCurrentLoadBalanceInfo

setRetryAllDowns

getRetryAllDowns

clearBlacklist

initializeConnection

removeListenerFromSchedulers

preAutoReconnect

getProxy

setProxy

getPickedlist

addToPickedList

removeFromPickedList

getBlacklistKeys

getBlacklist

handleFailover

addToBlacklist

removeFromBlacklist

resetHostStateInfo

resetOldsBlackListHosts

resetMasterFailoverData

setSessionReadOnly

handleFailLoop

getCurrentProtocol

getMasterHostFailNanos

setMasterHostFail

isMasterHostFail

hasHostFail

getFilterForFailedHost

relaunchOperation

isQueryRelaunchable

invoke

invoke

syncConnection

versionGreaterOrEqual

isServerMariaDb

sessionStateAware

noBackslashEscapes

getMajorServerVersion

isClosed

isValid

isReadOnly

inTransaction

isMasterConnection

isExplicitClosed

getRetriesAllDown

isAutoReconnect

getUrlParser

preExecute

preClose

reconnectFailedConnection

switchReadOnlyConnection

primaryFail

throwFailoverMessage

canRetryFailLoop

prolog

getCatalog

getTimeout

reconnect

checkMasterStatus