MySQL Connector/J 9.2.0 · com.mysql.cj.conf.ConnectionUrlParser

Modifier and Type	Class and Description
public static class	ConnectionUrlParser.Pair< left part type T, right part type U> This class is a simple container for two elements.

Modifier and Type	Field and Description
private static final String	ADDRESS_EQUALS_HOST_INFO_PREFIX
private static final Pattern	ADDRESS_EQUALS_HOST_PTRN
private String	authority
private final String	baseConnectionString
private static final Pattern	CONNECTION_STRING_PTRN
private static final String	DUMMY_SCHEMA
private static final Pattern	GENERIC_HOST_PTRN
private static final Pattern	HOST_LIST_PTRN
private static final String	HOSTS_LIST_CLOSING_MARKERS
private static final String	HOSTS_LIST_OPENING_MARKERS
private static final String	HOSTS_SEPARATOR
private static final String	KEY_VALUE_HOST_INFO_CLOSING_MARKER
private static final String	KEY_VALUE_HOST_INFO_OPENING_MARKER
private static final Pattern	KEY_VALUE_HOST_PTRN
private List<HostInfo>	parsedHosts
private Map<String, String>	parsedProperties
private String	path
private static final Pattern	PROPERTIES_PTRN
private String	query
private String	scheme
private static final Pattern	SCHEME_PTRN
private static final String	USER_HOST_SEPARATOR
private static final String	USER_PASS_SEPARATOR

Access	Constructor and Description
private	ConnectionUrlParser(String the connection string to parse connString) Constructs a connection string parser for the given connection string.

Method Summary

Modifier and Type	Method and Description
private HostInfo	Returns: the `HostInfo` instance containing the parsed information or `null` if the host part is not empty buildHostInfoForEmptyHost(String the user to include in the final `HostInfo` user, String the password to include in the final `HostInfo` password, String the string containing the host information part hostInfo) Builds an `HostInfo` instance for empty host authority segments.
private HostInfo	Returns: the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information buildHostInfoResortingToAddressEqualsSyntaxParser(String the user to include in the resulting `HostInfo` user, String the password to include in the resulting `HostInfo` password, String the string containing the host information part hostInfo) Parses the host information using the alternate syntax "address=(key1=value1)(key2=value2)...".
private HostInfo	Returns: the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information buildHostInfoResortingToGenericSyntaxParser(String the user to include in the resulting `HostInfo` user, String the password to include in the resulting `HostInfo` password, String the string containing the host information part hostInfo) Parses the host information using the generic syntax "host:port".
private HostInfo	Returns: the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information buildHostInfoResortingToKeyValueSyntaxParser(String the user to include in the resulting `HostInfo` user, String the password to include in the resulting `HostInfo` password, String the string containing the host information part hostInfo) Parses the host information using the alternate syntax "(key1=value1, key2=value2, ...)".
private List<HostInfo>	Returns: a list with all `HostInfo` instances containing the parsed information or `null` if unable to parse the host information buildHostInfoResortingToSubHostsListParser(String the user to include in all the resulting `HostInfo` user, String the password to include in all the resulting `HostInfo` password, String the string containing the host information part hostInfo) Parses the host information using the alternate sub hosts lists syntax "[host1, host2, ...]".
private HostInfo	Returns: the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information buildHostInfoResortingToUriParser(String the user to include in the final `HostInfo` user, String the password to include in the final `HostInfo` password, String the string containing the host information part hostInfo) Parses the host information resorting to a URI object.
private static String	Returns: the decoded string decode(String the string to decode text) URL-decode the given string.
private static String	Returns: the decoded string decodeSkippingPlusSign(String the string to decode text) URL-decode the given string skipping all occurrences of the plus sign.
public String	Returns: the authority section getAuthority() Returns the authority section.
public String	Returns: the original database URL getDatabaseUrl() Implements com.mysql.cj.conf.DatabaseUrlContainer.getDatabaseUrl. Returns the original database URL that produced this connection string parser.
public List<HostInfo>	Returns: the hosts information getHosts() Returns the hosts information.
public String	Returns: the path section getPath() Returns the path section.
public Map<String, String>	Returns: the properties map getProperties() Returns the properties map contained in this connection string.
public String	Returns: the query section getQuery() Returns the query section.
public String	Returns: the scheme section getScheme() Returns the scheme section.
public static boolean	Returns: true if supported isConnectionStringSupported(String connection string connString) Checks if the scheme part of given connection string matches one of the `Type`s supported by Connector/J.
private void	parseAuthoritySection() Parses the authority section (user and/or host identification) of the connection string URI.
private void	parseAuthoritySegment(String the string containing the authority segment authSegment) Parses the given sub authority segment, which can take one of the following syntaxes: _user_:_password_@_host_:_port_ _user_:_password_@(key1=value1,key2=value2,...) _user_:_password_@address=(key1=value1)(key2=value2)... _user_:_password_@[_any_of_the_above_1_,_any_of_the_above_2_,...]
public static ConnectionUrlParser	Returns: an instance of `ConnectionUrlParser` parseConnectionString(String The connection string to parse. connString) Static factory method for constructing instances of this class.
private void	parseConnectionString() Splits the connection string in its main sections.
public static ConnectionUrlParser.Pair<String, Integer>	Returns: a `Pair` containing the host and port information or null if the host information can't be parsed parseHostPortPair(String the host:pair to parse hostInfo) Parses a host:port pair and returns the two elements in a `Pair`
private void	parseQuerySection() Parses the connection properties section and stores the extracted key/value pairs into a local map.
public static ConnectionUrlParser.Pair<String, String>	Returns: a `Pair` containing the user and password information or null if the user information can't be parsed parseUserInfo(String the string containing the user information userInfo) Parses the given user information which is formed by the parts [user][:password].
private Map<String, String>	Returns: a key/value map containing the matched values processKeyValuePattern(Pattern the regular expression pattern to match against to pattern, String the input string input) Takes a two-matching-groups (respectively named "key" and "value") pattern which is successively tested against the given string and produces a key/value map with the matched values.
private ConnectionUrlParser.Pair<String, String>	Returns: a `Pair` containing the user information in the left side and the host information in the right splitByUserInfoAndHostInfo(String the string containing the authority segment, i.e., the user and host information parts authSegment) Splits the given authority segment in the user information part and the host part.
public String	Returns: a string representation of this object toString() Overrides java.lang.Object.toString. Returns a string representation of this object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

ADDRESS_EQUALS_HOST_INFO_PREFIX	back to summary
private static final String ADDRESS_EQUALS_HOST_INFO_PREFIX

ADDRESS_EQUALS_HOST_PTRN	back to summary
private static final Pattern ADDRESS_EQUALS_HOST_PTRN

authority	back to summary
private String authority

baseConnectionString	back to summary
private final String baseConnectionString

CONNECTION_STRING_PTRN	back to summary
private static final Pattern CONNECTION_STRING_PTRN

DUMMY_SCHEMA	back to summary
private static final String DUMMY_SCHEMA

GENERIC_HOST_PTRN	back to summary
private static final Pattern GENERIC_HOST_PTRN

HOST_LIST_PTRN	back to summary
private static final Pattern HOST_LIST_PTRN

HOSTS_LIST_CLOSING_MARKERS	back to summary
private static final String HOSTS_LIST_CLOSING_MARKERS

HOSTS_LIST_OPENING_MARKERS	back to summary
private static final String HOSTS_LIST_OPENING_MARKERS

HOSTS_SEPARATOR	back to summary
private static final String HOSTS_SEPARATOR

KEY_VALUE_HOST_INFO_CLOSING_MARKER	back to summary
private static final String KEY_VALUE_HOST_INFO_CLOSING_MARKER

KEY_VALUE_HOST_INFO_OPENING_MARKER	back to summary
private static final String KEY_VALUE_HOST_INFO_OPENING_MARKER

KEY_VALUE_HOST_PTRN	back to summary
private static final Pattern KEY_VALUE_HOST_PTRN

parsedHosts	back to summary
private List<HostInfo> parsedHosts

parsedProperties	back to summary
private Map<String, String> parsedProperties

path	back to summary
private String path

PROPERTIES_PTRN	back to summary
private static final Pattern PROPERTIES_PTRN

query	back to summary
private String query

scheme	back to summary
private String scheme

SCHEME_PTRN	back to summary
private static final Pattern SCHEME_PTRN

USER_HOST_SEPARATOR	back to summary
private static final String USER_HOST_SEPARATOR

USER_PASS_SEPARATOR	back to summary
private static final String USER_PASS_SEPARATOR

ConnectionUrlParser	back to summary
private ConnectionUrlParser(String connString) Constructs a connection string parser for the given connection string. Parameters connString:String the connection string to parse

Method Detail

buildHostInfoForEmptyHost back to summary

buildHostInfoForEmptyHost	back to summary
private HostInfo buildHostInfoForEmptyHost(String user, String password, String hostInfo) Builds an `HostInfo` instance for empty host authority segments. Parameters user:String the user to include in the final `HostInfo` password:String the password to include in the final `HostInfo` hostInfo:String the string containing the host information part Returns:HostInfo the `HostInfo` instance containing the parsed information or `null` if the host part is not empty

private HostInfo buildHostInfoForEmptyHost(String user, String password, String hostInfo)

Builds an HostInfo instance for empty host authority segments.

Parameters

user:String: the user to include in the final HostInfo
password:String: the password to include in the final HostInfo
hostInfo:String: the string containing the host information part

Returns:HostInfo

the HostInfo instance containing the parsed information or null if the host part is not empty

buildHostInfoResortingToAddressEqualsSyntaxParser back to summary

buildHostInfoResortingToAddressEqualsSyntaxParser	back to summary
private HostInfo buildHostInfoResortingToAddressEqualsSyntaxParser(String user, String password, String hostInfo) Parses the host information using the alternate syntax "address=(key1=value1)(key2=value2)...". Parameters user:String the user to include in the resulting `HostInfo` password:String the password to include in the resulting `HostInfo` hostInfo:String the string containing the host information part Returns:HostInfo the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information

private HostInfo buildHostInfoResortingToAddressEqualsSyntaxParser(String user, String password, String hostInfo)

Parses the host information using the alternate syntax "address=(key1=value1)(key2=value2)...".

Parameters

user:String: the user to include in the resulting HostInfo
password:String: the password to include in the resulting HostInfo
hostInfo:String: the string containing the host information part

Returns:HostInfo

the HostInfo instance containing the parsed information or null if unable to parse the host information

buildHostInfoResortingToGenericSyntaxParser back to summary

buildHostInfoResortingToGenericSyntaxParser	back to summary
private HostInfo buildHostInfoResortingToGenericSyntaxParser(String user, String password, String hostInfo) Parses the host information using the generic syntax "host:port". Parameters user:String the user to include in the resulting `HostInfo` password:String the password to include in the resulting `HostInfo` hostInfo:String the string containing the host information part Returns:HostInfo the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information

private HostInfo buildHostInfoResortingToGenericSyntaxParser(String user, String password, String hostInfo)

Parses the host information using the generic syntax "host:port".

Parameters

user:String: the user to include in the resulting HostInfo
password:String: the password to include in the resulting HostInfo
hostInfo:String: the string containing the host information part

Returns:HostInfo

the HostInfo instance containing the parsed information or null if unable to parse the host information

buildHostInfoResortingToKeyValueSyntaxParser back to summary

buildHostInfoResortingToKeyValueSyntaxParser	back to summary
private HostInfo buildHostInfoResortingToKeyValueSyntaxParser(String user, String password, String hostInfo) Parses the host information using the alternate syntax "(key1=value1, key2=value2, ...)". Parameters user:String the user to include in the resulting `HostInfo` password:String the password to include in the resulting `HostInfo` hostInfo:String the string containing the host information part Returns:HostInfo the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information

private HostInfo buildHostInfoResortingToKeyValueSyntaxParser(String user, String password, String hostInfo)

Parses the host information using the alternate syntax "(key1=value1, key2=value2, ...)".

Parameters

user:String: the user to include in the resulting HostInfo
password:String: the password to include in the resulting HostInfo
hostInfo:String: the string containing the host information part

Returns:HostInfo

the HostInfo instance containing the parsed information or null if unable to parse the host information

buildHostInfoResortingToSubHostsListParser back to summary

buildHostInfoResortingToSubHostsListParser	back to summary
private List<HostInfo> buildHostInfoResortingToSubHostsListParser(String user, String password, String hostInfo) Parses the host information using the alternate sub hosts lists syntax "[host1, host2, ...]". Parameters user:String the user to include in all the resulting `HostInfo` password:String the password to include in all the resulting `HostInfo` hostInfo:String the string containing the host information part Returns:List<HostInfo> a list with all `HostInfo` instances containing the parsed information or `null` if unable to parse the host information

private List<HostInfo> buildHostInfoResortingToSubHostsListParser(String user, String password, String hostInfo)

Parses the host information using the alternate sub hosts lists syntax "[host1, host2, ...]".

Parameters

user:String: the user to include in all the resulting HostInfo
password:String: the password to include in all the resulting HostInfo
hostInfo:String: the string containing the host information part

Returns:List<HostInfo>

a list with all HostInfo instances containing the parsed information or null if unable to parse the host information

buildHostInfoResortingToUriParser back to summary

buildHostInfoResortingToUriParser	back to summary
private HostInfo buildHostInfoResortingToUriParser(String user, String password, String hostInfo) Parses the host information resorting to a URI object. This process handles most single-host well formed addresses. Parameters user:String the user to include in the final `HostInfo` password:String the password to include in the final `HostInfo` hostInfo:String the string containing the host information part Returns:HostInfo the `HostInfo` instance containing the parsed information or `null` if unable to parse the host information

private HostInfo buildHostInfoResortingToUriParser(String user, String password, String hostInfo)

Parses the host information resorting to a URI object. This process handles most single-host well formed addresses.

Parameters

user:String: the user to include in the final HostInfo
password:String: the password to include in the final HostInfo
hostInfo:String: the string containing the host information part

Returns:HostInfo

the HostInfo instance containing the parsed information or null if unable to parse the host information

decode	back to summary
private static String decode(String text) URL-decode the given string. Parameters text:String the string to decode Returns:String the decoded string

decode

back to summary

private static String decode(String text)

URL-decode the given string.

Parameters

text:String: the string to decode

Returns:String

the decoded string

decodeSkippingPlusSign	back to summary
private static String decodeSkippingPlusSign(String text) URL-decode the given string skipping all occurrences of the plus sign. Parameters text:String the string to decode Returns:String the decoded string

decodeSkippingPlusSign

back to summary

private static String decodeSkippingPlusSign(String text)

URL-decode the given string skipping all occurrences of the plus sign.

Parameters

text:String: the string to decode

Returns:String

the decoded string

getAuthority	back to summary
public String getAuthority() Returns the authority section. Returns:String the authority section

getAuthority

back to summary

public String getAuthority()

Returns the authority section.

Returns:String: the authority section

getDatabaseUrl	back to summary
public String getDatabaseUrl() Implements com.mysql.cj.conf.DatabaseUrlContainer.getDatabaseUrl. Returns the original database URL that produced this connection string parser. Returns:String the original database URL Annotations @Override

getDatabaseUrl

back to summary

public String getDatabaseUrl()

Implements com.mysql.cj.conf.DatabaseUrlContainer.getDatabaseUrl.

Returns the original database URL that produced this connection string parser.

Returns:String

the original database URL

Annotations

@Override

getHosts	back to summary
public List<HostInfo> getHosts() Returns the hosts information. Returns:List<HostInfo> the hosts information

getHosts

back to summary

public List<HostInfo> getHosts()

Returns the hosts information.

Returns:List<HostInfo>: the hosts information

getPath	back to summary
public String getPath() Returns the path section. Returns:String the path section

getPath

back to summary

public String getPath()

Returns the path section.

Returns:String: the path section

getProperties	back to summary
public Map<String, String> getProperties() Returns the properties map contained in this connection string. Returns:Map<String, String> the properties map

getProperties

back to summary

public Map<String, String> getProperties()

Returns the properties map contained in this connection string.

Returns:Map<String, String>: the properties map

getQuery	back to summary
public String getQuery() Returns the query section. Returns:String the query section

getQuery

back to summary

public String getQuery()

Returns the query section.

Returns:String: the query section

getScheme	back to summary
public String getScheme() Returns the scheme section. Returns:String the scheme section

getScheme

back to summary

public String getScheme()

Returns the scheme section.

Returns:String: the scheme section

isConnectionStringSupported back to summary

isConnectionStringSupported	back to summary
public static boolean isConnectionStringSupported(String connString) Checks if the scheme part of given connection string matches one of the `Type`s supported by Connector/J. Throws `WrongArgumentException` if connString is null. Parameters connString:String connection string Returns:boolean true if supported

public static boolean isConnectionStringSupported(String connString)

Checks if the scheme part of given connection string matches one of the Types supported by Connector/J. Throws WrongArgumentException if connString is null.

Parameters

connString:String: connection string

Returns:boolean

true if supported

parseAuthoritySection	back to summary
private void parseAuthoritySection() Parses the authority section (user and/or host identification) of the connection string URI.

parseAuthoritySegment	back to summary
private void parseAuthoritySegment(String authSegment) Parses the given sub authority segment, which can take one of the following syntaxes: _user_:_password_@_host_:_port_ _user_:_password_@(key1=value1,key2=value2,...) _user_:_password_@address=(key1=value1)(key2=value2)... _user_:_password_@[_any_of_the_above_1_,_any_of_the_above_2_,...] Most of the above placeholders can be omitted, representing a null, empty, or default value. The placeholder _host_, can be a host name, IPv4 or IPv6. This parser doesn't check IP syntax. IPv6 addresses are enclosed by square brackets ([::1]). The placeholder _any_of_the_above_?_ can be any of the above except for the user information part (_user_:_password_@). When the symbol ":" is not used, it means an null/empty password or a default (HostInfo.NO_PORT) port, respectively. When the symbol "@" is not used, it means that the authority part doesn't contain user information (depending on the scheme type can still be provided via key=value pairs). Parameters authSegment:String the string containing the authority segment

parseAuthoritySegment

back to summary

private void parseAuthoritySegment(String authSegment)

Parses the given sub authority segment, which can take one of the following syntaxes:

_user_:_password_@_host_:_port_
_user_:_password_@(key1=value1,key2=value2,...)
_user_:_password_@address=(key1=value1)(key2=value2)...
_user_:_password_@[_any_of_the_above_1_,_any_of_the_above_2_,...]

Most of the above placeholders can be omitted, representing a null, empty, or default value. The placeholder _host_, can be a host name, IPv4 or IPv6. This parser doesn't check IP syntax. IPv6 addresses are enclosed by square brackets ([::1]). The placeholder _any_of_the_above_?_ can be any of the above except for the user information part (_user_:_password_@). When the symbol ":" is not used, it means an null/empty password or a default (HostInfo.NO_PORT) port, respectively. When the symbol "@" is not used, it means that the authority part doesn't contain user information (depending on the scheme type can still be provided via key=value pairs).

Parameters

authSegment:String: the string containing the authority segment

parseConnectionString back to summary

parseConnectionString	back to summary
public static ConnectionUrlParser parseConnectionString(String connString) Static factory method for constructing instances of this class. Parameters connString:String The connection string to parse. Returns:ConnectionUrlParser an instance of `ConnectionUrlParser`

public static ConnectionUrlParser parseConnectionString(String connString)

Static factory method for constructing instances of this class.

Parameters

connString:String: The connection string to parse.

Returns:ConnectionUrlParser

an instance of ConnectionUrlParser

parseConnectionString	back to summary
private void parseConnectionString() Splits the connection string in its main sections.

parseHostPortPair back to summary

parseHostPortPair	back to summary
public static ConnectionUrlParser.Pair<String, Integer> parseHostPortPair(String hostInfo) Parses a host:port pair and returns the two elements in a `Pair` Parameters hostInfo:String the host:pair to parse Returns:ConnectionUrlParser.Pair<String, Integer> a `Pair` containing the host and port information or null if the host information can't be parsed

public static ConnectionUrlParser.Pair<String, Integer> parseHostPortPair(String hostInfo)

Parses a host:port pair and returns the two elements in a Pair

Parameters

hostInfo:String: the host:pair to parse

Returns:ConnectionUrlParser.Pair<String, Integer>

a Pair containing the host and port information or null if the host information can't be parsed

parseQuerySection	back to summary
private void parseQuerySection() Parses the connection properties section and stores the extracted key/value pairs into a local map.

parseUserInfo back to summary

public static ConnectionUrlParser.Pair<String, String> parseUserInfo(String userInfo)

Parses the given user information which is formed by the parts [user][:password].

Parameters

userInfo:String: the string containing the user information

Returns:ConnectionUrlParser.Pair<String, String>

a Pair containing the user and password information or null if the user information can't be parsed

processKeyValuePattern

back to summary

private Map<String, String> processKeyValuePattern(Pattern pattern, String input)

Takes a two-matching-groups (respectively named "key" and "value") pattern which is successively tested against the given string and produces a key/value map with the matched values. The given pattern must ensure that there are no leftovers between successive tests, i.e., the end of the previous match must coincide with the beginning of the next.

Parameters

pattern:Pattern: the regular expression pattern to match against to
input:String: the input string

Returns:Map<String, String>

a key/value map containing the matched values

splitByUserInfoAndHostInfo back to summary

private ConnectionUrlParser.Pair<String, String> splitByUserInfoAndHostInfo(String authSegment)

Splits the given authority segment in the user information part and the host part.

Parameters

authSegment:String: the string containing the authority segment, i.e., the user and host information parts

Returns:ConnectionUrlParser.Pair<String, String>

a Pair containing the user information in the left side and the host information in the right

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this object.

Returns:String

a string representation of this object

Annotations

@Override

public Class ConnectionUrlParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ConnectionUrlParser.Pair<T, U>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail