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

Modifier and Type	Field and Description
private final String	host
private static final String	HOST_PORT_SEPARATOR
private final Map<String, String>	hostProperties
public static final int	NO_PORT
private final DatabaseUrlContainer	originalUrl
private final String	password
private final int	port
private final String	user

Constructor Summary

Access	Constructor and Description
public	HostInfo() Constructs an empty `HostInfo` instance.
public	HostInfo(DatabaseUrlContainer a reference to the original database URL that produced this host info url, String the host ip or name host, int the port port, String the user name user, String the user's password password) Constructs a `HostInfo` instance initialized with the provided host, port and user info.
public	HostInfo(DatabaseUrlContainer a reference to the original database URL that produced this host info url, String the host ip or name host, int the port port, String the user name user, String this user's password password, Map<String, String> a connection arguments map. properties) Constructs a `HostInfo` instance initialized with the provided host, port, user, password and connection arguments.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if both objects have equal host and port pairs, `false` otherwise. equalHostPortPair(HostInfo the `HostInfo` to compare with. hi) Checks if this `HostInfo` has the same host and port pair as the given `HostInfo`.
public Properties	Returns: a `Properties` instance containing the full host information. exposeAsProperties() Exposes this host info as a single properties instance.
public String	Returns: the database name getDatabase() Shortcut to the database connection argument.
public String	Returns: the original database URL getDatabaseUrl() Implements com.mysql.cj.conf.DatabaseUrlContainer.getDatabaseUrl. Returns the original database URL that produced this host info.
public String	Returns: the host getHost() Returns the host.
public String	Returns: the host:port representation of this host getHostPortPair() Returns a host:port representation of this host.
public Map<String, String>	Returns: this host specific properties getHostProperties() Returns the properties specific to this host.
public String	Returns: the password getPassword() Returns the password.
public int	Returns: the port getPort() Returns the port.
public String	Returns: the connection argument for the given key getProperty(String key key) Returns the connection argument for the given key.
public String	Returns: the user name getUser() Returns the user name.
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

Field Detail

host	back to summary
private final String host

HOST_PORT_SEPARATOR	back to summary
private static final String HOST_PORT_SEPARATOR

hostProperties	back to summary
private final Map<String, String> hostProperties

NO_PORT	back to summary
public static final int NO_PORT

originalUrl	back to summary
private final DatabaseUrlContainer originalUrl

password	back to summary
private final String password

port	back to summary
private final int port

user	back to summary
private final String user

Constructor Detail

HostInfo	back to summary
public HostInfo() Constructs an empty `HostInfo` instance.

HostInfo back to summary

HostInfo	back to summary
public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password) Constructs a `HostInfo` instance initialized with the provided host, port and user info. Parameters url:DatabaseUrlContainer a reference to the original database URL that produced this host info host:String the host ip or name port:int the port user:String the user name password:String the user's password

public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password)

Constructs a HostInfo instance initialized with the provided host, port and user info.

Parameters

url:DatabaseUrlContainer: a reference to the original database URL that produced this host info
host:String: the host ip or name
port:int: the port
user:String: the user name
password:String: the user's password

HostInfo back to summary

HostInfo	back to summary
public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password, Map<String, String> properties) Constructs a `HostInfo` instance initialized with the provided host, port, user, password and connection arguments. Parameters url:DatabaseUrlContainer a reference to the original database URL that produced this host info host:String the host ip or name port:int the port user:String the user name password:String this user's password properties:Map<String, String> a connection arguments map.

public HostInfo(DatabaseUrlContainer url, String host, int port, String user, String password, Map<String, String> properties)

Constructs a HostInfo instance initialized with the provided host, port, user, password and connection arguments.

Parameters

url:DatabaseUrlContainer: a reference to the original database URL that produced this host info
host:String: the host ip or name
port:int: the port
user:String: the user name
password:String: this user's password
properties:Map<String, String>: a connection arguments map.

Method Detail

equalHostPortPair back to summary

equalHostPortPair	back to summary
public boolean equalHostPortPair(HostInfo hi) Checks if this `HostInfo` has the same host and port pair as the given `HostInfo`. Parameters hi:HostInfo the `HostInfo` to compare with. Returns:boolean `true` if both objects have equal host and port pairs, `false` otherwise.

public boolean equalHostPortPair(HostInfo hi)

Checks if this HostInfo has the same host and port pair as the given HostInfo.

Parameters

hi:HostInfo: the HostInfo to compare with.

Returns:boolean

true if both objects have equal host and port pairs, false otherwise.

exposeAsProperties back to summary

exposeAsProperties	back to summary
public Properties exposeAsProperties() Exposes this host info as a single properties instance. The values for host, port, user and password are added to the properties map with their standard keys. Returns:Properties a `Properties` instance containing the full host information.

public Properties exposeAsProperties()

Exposes this host info as a single properties instance. The values for host, port, user and password are added to the properties map with their standard keys.

Returns:Properties: a Properties instance containing the full host information.

getDatabase	back to summary
public String getDatabase() Shortcut to the database connection argument. Returns:String the database name

getDatabase

back to summary

public String getDatabase()

Shortcut to the database connection argument.

Returns:String: the database name

getDatabaseUrl	back to summary
public String getDatabaseUrl() Implements com.mysql.cj.conf.DatabaseUrlContainer.getDatabaseUrl. Returns the original database URL that produced this host info. 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 host info.

Returns:String

the original database URL

Annotations

@Override

getHost	back to summary
public String getHost() Returns the host. Returns:String the host

getHost

back to summary

public String getHost()

Returns the host.

Returns:String: the host

getHostPortPair	back to summary
public String getHostPortPair() Returns a host:port representation of this host. Returns:String the host:port representation of this host

getHostPortPair

back to summary

public String getHostPortPair()

Returns a host:port representation of this host.

Returns:String: the host:port representation of this host

getHostProperties	back to summary
public Map<String, String> getHostProperties() Returns the properties specific to this host. Returns:Map<String, String> this host specific properties

getHostProperties

back to summary

public Map<String, String> getHostProperties()

Returns the properties specific to this host.

Returns:Map<String, String>: this host specific properties

getPassword	back to summary
public String getPassword() Returns the password. Returns:String the password

getPassword

back to summary

public String getPassword()

Returns the password.

Returns:String: the password

getPort	back to summary
public int getPort() Returns the port. Returns:int the port

getPort

back to summary

public int getPort()

Returns the port.

Returns:int: the port

getProperty	back to summary
public String getProperty(String key) Returns the connection argument for the given key. Parameters key:String key Returns:String the connection argument for the given key

getProperty

back to summary

public String getProperty(String key)

Returns the connection argument for the given key.

Parameters

key:String: key

Returns:String

the connection argument for the given key

getUser	back to summary
public String getUser() Returns the user name. Returns:String the user name

getUser

back to summary

public String getUser()

Returns the user name.

Returns:String: the user name

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

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 HostInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail