UrlParser (oceanbase-client 2.4.11 API)

java.lang.Object
- com.oceanbase.jdbc.UrlParser

所有已实现的接口:

Cloneable
```
public class UrlParser
extends Object
implements Cloneable
```
parse and verification of URL.
basic syntax :
jdbc:oceanbase:[replication:|failover|loadbalance:|aurora:]//<hostDescription>[,<hostDescription>]/[database>] [?<key1>=<value1>[&<key2>=<value2>]]
hostDescription:
- simple :
<host>:<portnumber>
(for example localhost:3306)

- complex :
address=[(type=(master|slave))][(port=<portnumber>)](host=<host>)

type is by default master
port is by default 3306

host can be dns name, ipv4 or ipv6.
in case of ipv6 and simple host description, the ip must be written inside bracket.
exemple : jdbc:oceanbase://[2001:0660:7401:0200:0000:0000:0edf:bdd7]:3306

Some examples :
jdbc:oceanbase://localhost:3306/database?user=greg&password=pass
jdbc:oceanbase://address=(type=master)(host=master1),address=(port=3307)(type=slave)(host=slave1)/database?user=greg&password=pass

字段概要

字段
限定符和类型字段和说明

static String DBNAME_PROPERTY_KEY

字段
限定符和类型	字段和说明
`static String`	`DBNAME_PROPERTY_KEY`

构造器概要

构造器
构造器和说明

UrlParser(String database, List<HostAddress> addresses, Options options, HaMode haMode)
Constructor.

构造器
构造器和说明
`UrlParser(String database, List<HostAddress> addresses, Options options, HaMode haMode)` Constructor.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static boolean`	`acceptsUrl(String url)` Tell if mariadb driver accept url string.
`UrlParser`	`auroraPipelineQuirks()` Permit to set parameters not forced. if options useBatchMultiSend and usePipelineAuth are not explicitly set in connection string, value will default to true or false according if aurora detection.
`Object`	`clone()`
`boolean`	`equals(Object parser)`
`String`	`getConnectedUsername()`
`CredentialPlugin`	`getCredentialPlugin()`
`String`	`getDatabase()`
`String`	`getExtendDescription()`
`HaMode`	`getHaMode()`
`List<HostAddress>`	`getHostAddresses()`
`String`	`getInitialUrl()`
`ConfigParser.OcpApi`	`getOcpApi()`
`Options`	`getOptions()`
`String`	`getPassword()`
`static String`	`getPropertyDbName(Properties props)`
`String`	`getTnsServiceName()`
`String`	`getUsername()`
`int`	`hashCode()`
`boolean`	`isAurora()` Detection of Aurora.
`boolean`	`isMultiMaster()`
`static UrlParser`	`parse(String url)`
`static UrlParser`	`parse(String url, Properties prop)` Parse url connection string with additional properties.
`void`	`parseUrl(String url)` Parse url connection string.
`void`	`setConnectedUsername(String connectedUsername)`
`void`	`setDatabase(String database)`
`void`	`setOcpApi(String urlPart)`
`void`	`setPassword(String password)`
`protected void`	`setProperties(String urlParameters)`
`void`	`setUsername(String username)`
`String`	`toString()` ToString implementation.

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

- 字段详细资料
  - DBNAME_PROPERTY_KEY
```
public static final String DBNAME_PROPERTY_KEY
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - UrlParser
```
public UrlParser(String database,
                 List<HostAddress> addresses,
                 Options options,
                 HaMode haMode)
          throws SQLException
```
    Constructor.
    
    参数:
    
    database - database
    
    addresses - list of hosts
    
    options - connection option
    
    haMode - High availability mode
    
    抛出:
    
    SQLException - if credential plugin cannot be loaded
- 方法详细资料
  - getPropertyDbName
```
public static String getPropertyDbName(Properties props)
```
  - acceptsUrl
```
public static boolean acceptsUrl(String url)
```
    Tell if mariadb driver accept url string. (Correspond to interface java.jdbc.Driver.acceptsURL() method)
    
    参数:
    
    url - url String
    
    返回:
    
    true if url string correspond.
  - parse
```
public static UrlParser parse(String url)
                       throws SQLException
```
    抛出:
    
    SQLException
  - parse
```
public static UrlParser parse(String url,
                              Properties prop)
                       throws SQLException
```
    Parse url connection string with additional properties.
    
    参数:
    
    url - connection string
    
    prop - properties
    
    返回:
    
    UrlParser instance
    
    抛出:
    
    SQLException - if parsing exception occur
  - auroraPipelineQuirks
```
public UrlParser auroraPipelineQuirks()
```
    Permit to set parameters not forced. if options useBatchMultiSend and usePipelineAuth are not explicitly set in connection string, value will default to true or false according if aurora detection.
    
    返回:
    
    UrlParser for easy testing
  - isAurora
```
public boolean isAurora()
```
    Detection of Aurora.
    Aurora rely on MySQL, then cannot be identified by protocol. But Aurora doesn't permit some behaviour normally working with MySQL : pipelining. So Driver must identified if server is Aurora to disable pipeline options that are enable by default.
    
    返回:
    
    true if aurora.
  - parseUrl
```
public void parseUrl(String url)
              throws SQLException
```
    Parse url connection string.
    
    参数:
    
    url - connection string
    
    抛出:
    
    SQLException - if url format is incorrect
  - getUsername
```
public String getUsername()
```
  - setUsername
```
public void setUsername(String username)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
  - getDatabase
```
public String getDatabase()
```
  - setDatabase
```
public void setDatabase(String database)
```
  - getHostAddresses
```
public List<HostAddress> getHostAddresses()
```
  - getOptions
```
public Options getOptions()
```
  - setProperties
```
protected void setProperties(String urlParameters)
```
  - getCredentialPlugin
```
public CredentialPlugin getCredentialPlugin()
```
  - toString
```
public String toString()
```
    ToString implementation.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    String value
  - getInitialUrl
```
public String getInitialUrl()
```
  - getHaMode
```
public HaMode getHaMode()
```
  - getTnsServiceName
```
public String getTnsServiceName()
```
  - equals
```
public boolean equals(Object parser)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - isMultiMaster
```
public boolean isMultiMaster()
```
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 Object
    
    抛出:
    
    CloneNotSupportedException
  - getExtendDescription
```
public String getExtendDescription()
```
  - getOcpApi
```
public ConfigParser.OcpApi getOcpApi()
```
  - setOcpApi
```
public void setOcpApi(String urlPart)
```
  - getConnectedUsername
```
public String getConnectedUsername()
```
  - setConnectedUsername
```
public void setConnectedUsername(String connectedUsername)
```

类 UrlParser

字段概要

构造器概要

方法概要

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

字段详细资料

DBNAME_PROPERTY_KEY

构造器详细资料

UrlParser

方法详细资料

getPropertyDbName

acceptsUrl

parse

parse

auroraPipelineQuirks

isAurora

parseUrl

getUsername

setUsername

getPassword

setPassword

getDatabase

setDatabase

getHostAddresses

getOptions

setProperties

getCredentialPlugin

toString

getInitialUrl

getHaMode

getTnsServiceName

equals

hashCode

isMultiMaster

clone

getExtendDescription

getOcpApi

setOcpApi

getConnectedUsername

setConnectedUsername