Package org.apache.hadoop.hbase

Class ServerName

java.lang.Object

org.apache.hadoop.hbase.ServerName

All Implemented Interfaces:

Serializable, Comparable<ServerName>

Direct Known Subclasses:

StartcodeAgnosticServerName

@Public
public class ServerName
extends Object
implements Comparable<ServerName>, Serializable

Name of a particular incarnation of an HBase Server. A ServerName is used uniquely identifying a server instance in a cluster and is made of the combination of hostname, port, and startcode. The startcode distinguishes restarted servers on same hostname and port (startcode is usually timestamp of server startup). The toString() format of ServerName is safe to use in the filesystem and as znode name up in ZooKeeper. Its format is: <hostname> 'SERVERNAME_SEPARATOR' <port> 'SERVERNAME_SEPARATOR' <startcode>. For example, if hostname is www.example.org, port is 1234, and the startcode for the regionserver is 1212121212, then the toString() would be www.example.org,1234,1212121212.

You can obtain a versioned serialized form of this class by calling getVersionedBytes(). To deserialize, call parseVersionedServerName(byte[]).

Use getAddress() to obtain the Server hostname + port (Endpoint/Socket Address).

Immutable.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Address	address
private byte[]	bytes	Cached versioned bytes of this ServerName instance.
static final List<ServerName>	EMPTY_SERVER_LIST
private static final org.apache.hbase.thirdparty.com.google.common.collect.Interner<ServerName>	INTERN_POOL	Intern ServerNames.
static final int	NON_STARTCODE	What to use if no startcode supplied.
private static final long	serialVersionUID
private final String	serverName
static final Pattern	SERVERNAME_PATTERN
static final String	SERVERNAME_SEPARATOR	This character is used as separator between server hostname, port and startcode.
private final long	startCode
static final String	UNKNOWN_SERVERNAME	What to use if server name is unknown.
private static final short	VERSION	Version for this class.
(package private) static final byte[]	VERSION_BYTES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServerName(String hostname, int port, long startCode)
private	ServerName(String hostAndPort, long startCode)
private	ServerName(Address address, long startCode)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ServerName other)
boolean	equals(Object o)
Address	getAddress()
String	getHostAndPort()	Deprecated. Since 2.0.
String	getHostname()
String	getHostnameLowerCase()
(package private) static String	getHostNameMinusDomain(String hostname)	Deprecated. Since 2.0.
int	getPort()
String	getServerName()
(package private) static String	getServerName(String hostName, int port, long startCode)	Deprecated. Since 2.0.
static String	getServerName(String hostAndPort, long startcode)	Deprecated. Since 2.0.
static String	getServerNameLessStartCode(String inServerName)	Deprecated. Since 2.0.
static long	getServerStartcodeFromServerName(String serverName)	Deprecated. Since 2.0.
long	getStartcode()	Deprecated. Since 2.5.0, will be removed in 4.0.0.
long	getStartCode()	Return the start code.
byte[]	getVersionedBytes()	Return getServerName() as bytes with a short-sized prefix with the VERSION of this class.
int	hashCode()
static boolean	isFullServerName(String str)	Returns true if the String follows the pattern of toString(), false otherwise.
static boolean	isSameAddress(ServerName left, ServerName right)	Compare two addresses
static String	parseHostname(String serverName)	Deprecated. Since 2.0.
static int	parsePort(String serverName)	Deprecated. Since 2.0.
static ServerName	parseServerName(String str)	Parse a ServerName from a string
static long	parseStartcode(String serverName)	Deprecated. Since 2.0.
static ServerName	parseVersionedServerName(byte[] versionedBytes)	Use this method instantiating a ServerName from bytes gotten from a call to getVersionedBytes().
String	toShortString()	Return a SHORT version of toString(), one that has the host only, minus the domain, and the port only -- no start code; the String is for us internally mostly tying threads to their server.
String	toString()
static ServerName	valueOf(String serverName)	Retrieve an instance of ServerName.
static ServerName	valueOf(String hostname, int port, long startCode)	Retrieve an instance of ServerName.
static ServerName	valueOf(String hostAndPort, long startCode)	Retrieve an instance of ServerName.
static ServerName	valueOf(Address address, long startCode)	Retrieve an instance of ServerName.

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

VERSION

private static final short VERSION

Version for this class. Its a short rather than a byte so I can for sure distinguish between this version of this class and the version previous to this which did not have a version.

See Also:

• Constant Field Values

VERSION_BYTES

static final byte[] VERSION_BYTES

NON_STARTCODE

public static final int NON_STARTCODE

What to use if no startcode supplied.

See Also:

• Constant Field Values

SERVERNAME_SEPARATOR

public static final String SERVERNAME_SEPARATOR

This character is used as separator between server hostname, port and startcode.

See Also:

• Constant Field Values

SERVERNAME_PATTERN

public static final Pattern SERVERNAME_PATTERN

UNKNOWN_SERVERNAME

public static final String UNKNOWN_SERVERNAME

What to use if server name is unknown.

See Also:

• Constant Field Values

serverName

private final String serverName

startCode

private final long startCode

address

private transient Address address

bytes

private byte[] bytes

Cached versioned bytes of this ServerName instance.

See Also:

• getVersionedBytes()

EMPTY_SERVER_LIST

public static final List<ServerName> EMPTY_SERVER_LIST

INTERN_POOL

private static final org.apache.hbase.thirdparty.com.google.common.collect.Interner<ServerName> INTERN_POOL

Intern ServerNames. The Set of ServerNames is mostly-fixed changing slowly as Servers restart. Rather than create a new instance everytime, try and return existing instance if there is one.

Constructor Details

ServerName

protected ServerName(String hostname,
 int port,
 long startCode)

ServerName

private ServerName(Address address,
 long startCode)

ServerName

private ServerName(String hostAndPort,
 long startCode)

Method Details

getHostNameMinusDomain

@Deprecated
static String getHostNameMinusDomain(String hostname)

Deprecated.

Since 2.0. This is for internal use only.

Parameters:

hostname - the hostname string to get the actual hostname from

Returns:

hostname minus the domain, if there is one (will do pass-through on ip addresses)

parseHostname

@Deprecated
public static String parseHostname(String serverName)

Deprecated.

Since 2.0. Use valueOf(String)

parsePort

@Deprecated
public static int parsePort(String serverName)

Deprecated.

Since 2.0. Use valueOf(String)

parseStartcode

@Deprecated
public static long parseStartcode(String serverName)

Deprecated.

Since 2.0. Use valueOf(String)

valueOf

public static ServerName valueOf(String hostname,
 int port,
 long startCode)

Retrieve an instance of ServerName. Callers should use the equals method to compare returned instances, though we may return a shared immutable object as an internal optimization.

valueOf

public static ServerName valueOf(String serverName)

Retrieve an instance of ServerName. Callers should use the equals method to compare returned instances, though we may return a shared immutable object as an internal optimization.

valueOf

public static ServerName valueOf(String hostAndPort,
 long startCode)

Retrieve an instance of ServerName. Callers should use the equals method to compare returned instances, though we may return a shared immutable object as an internal optimization.

valueOf

public static ServerName valueOf(Address address,
 long startCode)

Retrieve an instance of ServerName. Callers should use the equals(Object) method to compare returned instances, though we may return a shared immutable object as an internal optimization.

Parameters:

address - the Address to use for getting the ServerName

startCode - the startcode to use for getting the ServerName

Returns:

the constructed ServerName

See Also:

• valueOf(String, int, long)

toString

public String toString()

Overrides:

toString in class Object

toShortString

public String toShortString()

Return a SHORT version of toString(), one that has the host only, minus the domain, and the port only -- no start code; the String is for us internally mostly tying threads to their server. Not for external use. It is lossy and will not work in in compares, etc.

getVersionedBytes

public byte[] getVersionedBytes()

Return getServerName() as bytes with a short-sized prefix with the VERSION of this class.

getServerName

public String getServerName()

getHostname

public String getHostname()

getHostnameLowerCase

public String getHostnameLowerCase()

getPort

public int getPort()

getStartcode

@Deprecated
public long getStartcode()

Deprecated.

Since 2.5.0, will be removed in 4.0.0. Use getStartCode() instead.

Return the start code.

getStartCode

public long getStartCode()

Return the start code.

getServerName

@Deprecated
static String getServerName(String hostName,
 int port,
 long startCode)

Deprecated.

Since 2.0. Use valueOf(String, int, long) instead.

For internal use only.

Parameters:

hostName - the name of the host to use

port - the port on the host to use

startCode - the startcode to use for formatting

Returns:

Server name made of the concatenation of hostname, port and startcode formatted as <hostname> ',' <port> ',' <startcode>

getServerName

@Deprecated
public static String getServerName(String hostAndPort,
 long startcode)

Deprecated.

Since 2.0. Use valueOf(String, long) instead.

Parameters:

hostAndPort - String in form of <hostname> ':' <port>

startcode - the startcode to use

Returns:

Server name made of the concatenation of hostname, port and startcode formatted as <hostname> ',' <port> ',' <startcode>

getHostAndPort

@Deprecated
public String getHostAndPort()

Deprecated.

Since 2.0. Use getAddress() instead.

Returns:

Hostname and port formatted as described at Addressing.createHostAndPortStr(String, int)

getAddress

public Address getAddress()

getServerStartcodeFromServerName

@Deprecated
public static long getServerStartcodeFromServerName(String serverName)

Deprecated.

Since 2.0. Use instance of ServerName to pull out start code.

Parameters:

serverName - ServerName in form specified by getServerName()

Returns:

The server start code parsed from servername

getServerNameLessStartCode

@Deprecated
public static String getServerNameLessStartCode(String inServerName)

Deprecated.

Since 2.0. Use getAddress()

Utility method to excise the start code from a server name

Parameters:

inServerName - full server name

Returns:

server name less its start code

compareTo

public int compareTo(ServerName other)

Specified by:

compareTo in interface Comparable<ServerName>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isSameAddress

public static boolean isSameAddress(ServerName left,
 ServerName right)

Compare two addresses

Parameters:

left - the first server address to compare

right - the second server address to compare

Returns:

true if left and right have the same hostname and port.

parseVersionedServerName

public static ServerName parseVersionedServerName(byte[] versionedBytes)

Use this method instantiating a ServerName from bytes gotten from a call to getVersionedBytes(). Will take care of the case where bytes were written by an earlier version of hbase.

Parameters:

versionedBytes - Pass bytes gotten from a call to getVersionedBytes()

Returns:

A ServerName instance.

See Also:

• getVersionedBytes()

parseServerName

public static ServerName parseServerName(String str)

Parse a ServerName from a string

Parameters:

str - Either an instance of toString() or a "'<hostname>' ':' '<port>'".

Returns:

A ServerName instance.

isFullServerName

public static boolean isFullServerName(String str)

Returns true if the String follows the pattern of toString(), false otherwise.