org.springframework.data.gemfire.support

Class ConnectionEndpoint

java.lang.Object

org.springframework.data.gemfire.support.ConnectionEndpoint

All Implemented Interfaces:

Cloneable, Comparable<ConnectionEndpoint>

public class ConnectionEndpoint
extends Object
implements Cloneable, Comparable<ConnectionEndpoint>

The ConnectionEndpoint class models a GemFire connection endpoint in the format of hostname[portnumber], where hostname is the network name or IP address of the host.

Since:

1.6.3

Author:

John Blum, Jacob Barret

See Also:

Cloneable, Comparable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_HOST
protected static int	DEFAULT_PORT
protected static String	GEMFIRE_HOST_PORT_SEPARATOR
protected static String	STANDARD_HOST_PORT_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ConnectionEndpoint(String host, int port) Constructs a ConnectionEndpoint initialized with the specific host and port.

Method Summary

Modifier and Type	Method and Description
protected Object	clone()
int	compareTo(ConnectionEndpoint connectionEndpoint)
boolean	equals(Object obj)
static ConnectionEndpoint	from(InetSocketAddress socketAddress) Factory method used to convert the given InetSocketAddress into a ConnectionEndpoint.
static ConnectionEndpoint	from(int port) Factory method used to construct a new ConnectionEndpoint with the given port listening on the default host.
static ConnectionEndpoint	from(String host, int port) Factory method used to construct a new ConnectionEndpoint for the given host and port.
String	getHost() Gets the host in this ConnectionEndpoint.
int	getPort() Gets the port number in this ConnectionEndpoint.
int	hashCode()
static ConnectionEndpoint	parse(String hostPort) Parses the host and port String value into a valid ConnectionEndpoint.
static ConnectionEndpoint	parse(String hostPort, int defaultPort) Factory method used to parse the host and port value into a valid ConnectionEndpoint.
InetSocketAddress	toInetSocketAddress() Converts this ConnectionEndpoint into an InetSocketAddress representation.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_PORT

protected static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_HOST

protected static final String DEFAULT_HOST

See Also:

Constant Field Values

GEMFIRE_HOST_PORT_SEPARATOR

protected static final String GEMFIRE_HOST_PORT_SEPARATOR

See Also:

Constant Field Values

STANDARD_HOST_PORT_SEPARATOR

protected static final String STANDARD_HOST_PORT_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ConnectionEndpoint

public ConnectionEndpoint(String host,
                          int port)

Constructs a ConnectionEndpoint initialized with the specific host and port.

Parameters:

host - the hostname or IP address of the ConnectionEndpoint. If the host is unspecified, then ConnectionEndpoint.DEFAULT_HOST will be used.

port - the (service) port number in this ConnectionEndpoint.

Throws:

IllegalArgumentException - if the port number is less than 0.

See Also:

DEFAULT_HOST

Method Detail

from

@NonNull
public static ConnectionEndpoint from(int port)

Factory method used to construct a new ConnectionEndpoint with the given port listening on the default host.

Parameters:

port - port of the ConnectionEndpoint.

Returns:

a new ConnectionEndpoint with the given port listening on the default host.

See Also:

from(String, int)

from

@NonNull
public static ConnectionEndpoint from(String host,
                                               int port)

Factory method used to construct a new ConnectionEndpoint for the given host and port.

Parameters:

host - host of the ConnectionEndpoint.

port - port of the ConnectionEndpoint.

Returns:

a new ConnectionEndpoint with the given host and port.

from

@NonNull
public static ConnectionEndpoint from(@NonNull
                                               InetSocketAddress socketAddress)

Factory method used to convert the given InetSocketAddress into a ConnectionEndpoint.

Parameters:

socketAddress - InetSocketAddress used to construct, configure and initialize the ConnectionEndpoint.

Returns:

a ConnectionEndpoint representing the InetSocketAddress.

See Also:

InetSocketAddress

parse

public static ConnectionEndpoint parse(String hostPort)

Parses the host and port String value into a valid ConnectionEndpoint.

Parameters:

hostPort - a String value containing the host and port formatted as 'host[port]'.

Returns:

a valid ConnectionEndpoint initialized with the host and port, or with DEFAULT_PORT if port was unspecified.

See Also:

parse(String, int), DEFAULT_PORT

parse

public static ConnectionEndpoint parse(String hostPort,
                                       int defaultPort)

Factory method used to parse the host and port value into a valid ConnectionEndpoint.

Parameters:

hostPort - String containing the host and port formatted as host[port] or host:port.

defaultPort - Integer indicating the default port to use if the port is unspecified in the host and port value.

Returns:

a valid ConnectionEndpoint initialized with the host and port, or with the default port if port was unspecified.

See Also:

ConnectionEndpoint(String, int)

getHost

public String getHost()

Gets the host in this ConnectionEndpoint.

Returns:

a String value indicating the hostname or IP address in this ConnectionEndpoint.

getPort

public int getPort()

Gets the port number in this ConnectionEndpoint.

Returns:

an Integer value indicating the (service) port number in this ConnectionEndpoint.

toInetSocketAddress

public InetSocketAddress toInetSocketAddress()

Converts this ConnectionEndpoint into an InetSocketAddress representation.

Returns:

an InetSocketAddress representation of this ConnectionEndpoint.

See Also:

InetSocketAddress, getHost(), getPort()

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

compareTo

public int compareTo(ConnectionEndpoint connectionEndpoint)

Specified by:

compareTo in interface Comparable<ConnectionEndpoint>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object