software.aws.rds.jdbc.postgresql.ca

Class HostInfo

java.lang.Object

software.aws.rds.jdbc.postgresql.ca.HostInfo

public class HostInfo
extends Object

A class that contains details about a host and it's connection properties.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_PORT

Constructor Summary

Constructors

Constructor and Description
HostInfo(String endpoint, @Nullable String instanceIdentifier, int port, boolean isWriter) Constructor for HostInfo

Method Summary

Modifier and Type	Method and Description
boolean	equalsHostPortPair(@Nullable HostInfo other) Checks if the host-port-pair of this HostInfo object is the same as another HostInfo object.
String	getHost() Retrieves the instance host
String	getHostPortPair() Retrieves the host and port
@Nullable String	getInstanceIdentifier() Accessor method for instanceIdentifier
int	getPort() Retrieves the instance port
@Nullable String	getUrl() Accessor method to retrieve the url of the host connection
@Nullable String	getUrl(@Nullable Properties props) Accessor method to retrieve the url of the host connection
@Nullable String	getUrl(@Nullable String dbname) Accessor method to retrieve the url of the host connection
boolean	isWriter() Accessor method for isWriter
HostSpec	toHostSpec() Creates a HostSpec object from the current HostInfo object
String	toString() Retrieves a textual representation of this HostInfo object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_PORT

public static final int NO_PORT

See Also:

Constant Field Values

Constructor Detail

HostInfo

public HostInfo(String endpoint,
                @Nullable String instanceIdentifier,
                int port,
                boolean isWriter)

Constructor for HostInfo

Parameters:

endpoint - The instance endpoint (complete DNS, no port, no protocol)

instanceIdentifier - The instance identifier of this connection

port - The port for this connection

isWriter - True if this host is a writer

Method Detail

getUrl

public @Nullable String getUrl(@Nullable String dbname)

Accessor method to retrieve the url of the host connection

Parameters:

dbname - The database name used in the connection

Returns:

A string that contains the connection url

getUrl

public @Nullable String getUrl()

Accessor method to retrieve the url of the host connection

Returns:

A string that contains the connection url

getUrl

public @Nullable String getUrl(@Nullable Properties props)

Accessor method to retrieve the url of the host connection

Parameters:

props - The Properties to use

Returns:

A string that contains the connection url

getHost

public String getHost()

Retrieves the instance host

Returns:

the instance host (complete DNS, no port, no protocol)

getPort

public int getPort()

Retrieves the instance port

Returns:

the port number.

getInstanceIdentifier

public @Nullable String getInstanceIdentifier()

Accessor method for instanceIdentifier

Returns:

The identifier for an instance in the host cluster

isWriter

public boolean isWriter()

Accessor method for isWriter

Returns:

True if the host is a writer

getHostPortPair

public String getHostPortPair()

Retrieves the host and port

Returns:

A string containing the host and port separated by a ":"

equalsHostPortPair

public boolean equalsHostPortPair(@Nullable HostInfo other)

Checks if the host-port-pair of this HostInfo object is the same as another HostInfo object.

Parameters:

other - The other HostInfo object, to compare to this HostInfo object

Returns:

True if the host-port-pair is equal

toHostSpec

public HostSpec toHostSpec()

Creates a HostSpec object from the current HostInfo object

Returns:

HostSpec object containing the host and port of this instance

toString

public String toString()

Retrieves a textual representation of this HostInfo object

Overrides:

toString in class Object

Returns:

a string representation of this object.