Listener (oceanbase-client 2.4.0 API)

All Known Implementing Classes:

AbstractMastersListener, AbstractMastersSlavesListener, AuroraListener, MastersFailoverListener, MastersSlavesListener
```
public interface Listener
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addToBlacklist(HostAddress hostAddress)`
`void`	`addToPickedList(HostAddress hostAddress)`
`boolean`	`canRetryFailLoop()`
`boolean`	`checkMasterStatus(SearchFilter searchFilter)`
`void`	`foundActiveMaster(Protocol protocol)`
`ConcurrentMap<HostAddress,HostStateInfo>`	`getBlacklist()`
`Set<HostAddress>`	`getBlacklistKeys()`
`String`	`getCatalog()`
`LoadBalanceInfo`	`getCurrentLoadBalanceInfo()`
`Protocol`	`getCurrentProtocol()`
`SearchFilter`	`getFilterForFailedHost()`
`long`	`getLastQueryNanos()`
`int`	`getMajorServerVersion()`
`FailoverProxy`	`getProxy()`
`int`	`getRetriesAllDown()`
`int`	`getRetryAllDowns()`
`long`	`getServerThreadId()`
`int`	`getTimeout()`
`UrlParser`	`getUrlParser()`
`HandleErrorResult`	`handleFailover(SQLException qe, Method method, Object[] args, Protocol protocol, boolean wasClosed)`
`boolean`	`hasHostFail()`
`void`	`initializeConnection()`
`boolean`	`inTransaction()`
`Object`	`invoke(Method method, Object[] args)`
`Object`	`invoke(Method method, Object[] args, Protocol specificProtocol)`
`boolean`	`isAutoReconnect()`
`boolean`	`isClosed()`
`boolean`	`isExplicitClosed()`
`boolean`	`isMasterConnected()`
`boolean`	`isMasterConnection()`
`boolean`	`isMasterHostFail()`
`boolean`	`isReadOnly()`
`boolean`	`isServerMariaDb()`
`boolean`	`isValid(int timeout)`
`boolean`	`noBackslashEscapes()`
`void`	`preAbort()`
`void`	`preClose()`
`void`	`preExecute()`
`HandleErrorResult`	`primaryFail(Method method, Object[] args, boolean killCmd, boolean wasClosed)`
`void`	`prolog(long maxRows, OceanBaseConnection connection, OceanBaseStatement statement)`
`void`	`reconnect()`
`void`	`reconnectFailedConnection(SearchFilter filter)`
`void`	`removeFromBlacklist(HostAddress hostAddress)`
`void`	`removeFromPickedList(HostAddress hostAddress)`
`void`	`rePrepareOnSlave(ServerPrepareResult oldServerPrepareResult, boolean mustExecuteOnMaster)`
`void`	`reset()`
`void`	`resetHostStateInfo(HostAddress hostAddress)`
`void`	`resetOldsBlackListHosts()`
`boolean`	`sessionStateAware()`
`void`	`setCurrentLoadBalanceInfo(LoadBalanceInfo loadBalanceInfo)`
`boolean`	`setMasterHostFail()`
`void`	`setProxy(FailoverProxy proxy)`
`void`	`setRetryAllDowns(int retryAllDowns)`
`void`	`switchReadOnlyConnection(Boolean readonly)`
`void`	`syncConnection(Protocol from, Protocol to)`
`void`	`throwFailoverMessage(HostAddress failHostAddress, boolean wasMaster, SQLException queryException, boolean reconnected)`
`boolean`	`versionGreaterOrEqual(int major, int minor, int patch)`

Method Detail

getProxy
```
FailoverProxy getProxy()
```

setProxy
```
void setProxy(FailoverProxy proxy)
```

initializeConnection

void initializeConnection()
                   throws SQLException

Throws:: SQLException

preExecute

void preExecute()
         throws SQLException

Throws:: SQLException

preClose
```
void preClose()
```

preAbort
```
void preAbort()
```

getServerThreadId
```
long getServerThreadId()
```

reconnectFailedConnection

void reconnectFailedConnection(SearchFilter filter)
                        throws SQLException

Throws:: SQLException

switchReadOnlyConnection

void switchReadOnlyConnection(Boolean readonly)
                       throws SQLException

Throws:: SQLException

primaryFail

HandleErrorResult primaryFail(Method method,
                              Object[] args,
                              boolean killCmd,
                              boolean wasClosed)
                       throws SQLException

Throws:: SQLException

invoke

Object invoke(Method method,
              Object[] args,
              Protocol specificProtocol)
       throws Throwable

Throws:: Throwable

invoke

Object invoke(Method method,
              Object[] args)
       throws Throwable

Throws:: Throwable

handleFailover

HandleErrorResult handleFailover(SQLException qe,
                                 Method method,
                                 Object[] args,
                                 Protocol protocol,
                                 boolean wasClosed)
                          throws Throwable

Throws:: Throwable

foundActiveMaster

void foundActiveMaster(Protocol protocol)
                throws SQLException

Throws:: SQLException

getBlacklistKeys
```
Set<HostAddress> getBlacklistKeys()
```

addToPickedList

void addToPickedList(HostAddress hostAddress)

removeFromPickedList

void removeFromPickedList(HostAddress hostAddress)

addToBlacklist

void addToBlacklist(HostAddress hostAddress)

removeFromBlacklist

void removeFromBlacklist(HostAddress hostAddress)

syncConnection

void syncConnection(Protocol from,
                    Protocol to)
             throws SQLException

Throws:: SQLException

getUrlParser
```
UrlParser getUrlParser()
```

throwFailoverMessage

void throwFailoverMessage(HostAddress failHostAddress,
                          boolean wasMaster,
                          SQLException queryException,
                          boolean reconnected)
                   throws SQLException

Throws:: SQLException

isAutoReconnect
```
boolean isAutoReconnect()
```

getRetriesAllDown
```
int getRetriesAllDown()
```

isExplicitClosed
```
boolean isExplicitClosed()
```

reconnect

void reconnect()
        throws SQLException

Throws:: SQLException

isReadOnly
```
boolean isReadOnly()
```

inTransaction
```
boolean inTransaction()
```

getMajorServerVersion
```
int getMajorServerVersion()
```

isMasterConnection
```
boolean isMasterConnection()
```

isClosed
```
boolean isClosed()
```

versionGreaterOrEqual

boolean versionGreaterOrEqual(int major,
                              int minor,
                              int patch)

isServerMariaDb
```
boolean isServerMariaDb()
```

sessionStateAware
```
boolean sessionStateAware()
```

noBackslashEscapes
```
boolean noBackslashEscapes()
```

isValid

boolean isValid(int timeout)
         throws SQLException

Throws:: SQLException

prolog

void prolog(long maxRows,
            OceanBaseConnection connection,
            OceanBaseStatement statement)
     throws SQLException

Throws:: SQLException

getCatalog

String getCatalog()
           throws SQLException

Throws:: SQLException

getTimeout

int getTimeout()
        throws SocketException

Throws:: SocketException

getCurrentProtocol
```
Protocol getCurrentProtocol()
```

hasHostFail
```
boolean hasHostFail()
```

canRetryFailLoop
```
boolean canRetryFailLoop()
```

getFilterForFailedHost
```
SearchFilter getFilterForFailedHost()
```

isMasterConnected
```
boolean isMasterConnected()
```

setMasterHostFail
```
boolean setMasterHostFail()
```

isMasterHostFail
```
boolean isMasterHostFail()
```

getLastQueryNanos
```
long getLastQueryNanos()
```

checkMasterStatus

boolean checkMasterStatus(SearchFilter searchFilter)

rePrepareOnSlave

void rePrepareOnSlave(ServerPrepareResult oldServerPrepareResult,
                      boolean mustExecuteOnMaster)
               throws SQLException

Throws:: SQLException

reset
```
void reset()
    throws SQLException
```
Throws:

SQLException

setCurrentLoadBalanceInfo

void setCurrentLoadBalanceInfo(LoadBalanceInfo loadBalanceInfo)

getCurrentLoadBalanceInfo

LoadBalanceInfo getCurrentLoadBalanceInfo()

resetOldsBlackListHosts
```
void resetOldsBlackListHosts()
```

getBlacklist

ConcurrentMap<HostAddress,HostStateInfo> getBlacklist()

resetHostStateInfo

void resetHostStateInfo(HostAddress hostAddress)

setRetryAllDowns

void setRetryAllDowns(int retryAllDowns)

getRetryAllDowns
```
int getRetryAllDowns()
```

Interface Listener

Method Summary

Method Detail

getProxy

setProxy

initializeConnection

preExecute

preClose

preAbort

getServerThreadId

reconnectFailedConnection

switchReadOnlyConnection

primaryFail

invoke

invoke

handleFailover

foundActiveMaster

getBlacklistKeys

addToPickedList

removeFromPickedList

addToBlacklist

removeFromBlacklist

syncConnection

getUrlParser

throwFailoverMessage

isAutoReconnect

getRetriesAllDown

isExplicitClosed

reconnect

isReadOnly

inTransaction

getMajorServerVersion

isMasterConnection

isClosed

versionGreaterOrEqual

isServerMariaDb

sessionStateAware

noBackslashEscapes

isValid

prolog

getCatalog

getTimeout

getCurrentProtocol

hasHostFail

canRetryFailLoop

getFilterForFailedHost

isMasterConnected

setMasterHostFail

isMasterHostFail

getLastQueryNanos

checkMasterStatus

rePrepareOnSlave

reset

setCurrentLoadBalanceInfo

getCurrentLoadBalanceInfo

resetOldsBlackListHosts

getBlacklist

resetHostStateInfo

setRetryAllDowns

getRetryAllDowns