Package org.apache.hadoop.hdfs.server.federation.store.records

Class MembershipState

java.lang.Object

org.apache.hadoop.hdfs.server.federation.store.records.BaseRecord

org.apache.hadoop.hdfs.server.federation.store.records.MembershipState

All Implemented Interfaces:

java.lang.Comparable<BaseRecord>, FederationNamenodeContext

Direct Known Subclasses:

MembershipStatePBImpl

public abstract class MembershipState
extends BaseRecord
implements FederationNamenodeContext

Data schema for storing NN registration information in the StateStoreService.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_MSG_NO_BP_SPECIFIED
static java.lang.String	ERROR_MSG_NO_NS_SPECIFIED
static java.lang.String	ERROR_MSG_NO_RPC_ADDR_SPECIFIED
static java.lang.String	ERROR_MSG_NO_WEB_ADDR_SPECIFIED
static java.util.Comparator<MembershipState>	NAME_COMPARATOR	Comparator based on the name.

Fields inherited from class org.apache.hadoop.hdfs.server.federation.store.records.BaseRecord

ERROR_MSG_CREATION_TIME_NEGATIVE, ERROR_MSG_MODIFICATION_TIME_NEGATIVE

Constructor Summary

Constructors

Constructor	Description
MembershipState()	Constructors.

Method Summary

Modifier and Type	Method	Description
boolean	checkExpired(long currentTime)	Called when the modification time and current time is available, checks for expirations.
int	compareNameTo(MembershipState other)	Sort by nameservice, namenode, and router.
int	compareTo(BaseRecord record)	First use the comparator of the BaseRecord to compare the date modified.
abstract java.lang.String	getBlockPoolId()
abstract java.lang.String	getClusterId()
long	getDeletionMs()	Get the deletion time for the expired record.
long	getExpirationMs()	Get the expiration time for the record.
abstract boolean	getIsSafeMode()
abstract long	getLastContact()
abstract java.lang.String	getLifelineAddress()	Get the Lifeline RPC server address of the namenode.
abstract java.lang.String	getNamenodeId()	Identifier for the namenode.
java.lang.String	getNamenodeKey()	Get the identifier of this namenode registration.
static java.lang.String	getNamenodeKey(java.lang.String nsId, java.lang.String nnId)	Generate the identifier for a Namenode in the HDFS federation.
abstract java.lang.String	getNameserviceId()	Identifier for the nameservice/namespace.
java.util.SortedMap<java.lang.String,java.lang.String>	getPrimaryKeys()	Map of primary key names to values for the record.
abstract java.lang.String	getRouterId()
abstract java.lang.String	getRpcAddress()	Get the RPC server address of the namenode.
abstract java.lang.String	getServiceAddress()	Get the Service RPC server address of the namenode.
abstract FederationNamenodeServiceState	getState()	The current state of the namenode (active, standby, etc).
abstract MembershipStats	getStats()
abstract java.lang.String	getWebAddress()	Get the HTTP(s) server address of the namenode.
abstract java.lang.String	getWebScheme()	Get the Scheme of web address of the namenode.
boolean	isAvailable()	Check if the namenode is available.
boolean	isExpired()	Check if this record is expired.
boolean	like(BaseRecord o)	Check if this record matches a partial record.
static MembershipState	newInstance()	Create a new membership instance.
static MembershipState	newInstance(java.lang.String router, java.lang.String nameservice, java.lang.String namenode, java.lang.String clusterId, java.lang.String blockPoolId, java.lang.String rpcAddress, java.lang.String serviceAddress, java.lang.String lifelineAddress, java.lang.String webScheme, java.lang.String webAddress, FederationNamenodeServiceState state, boolean safemode)	Create a new membership instance.
void	overrideState(FederationNamenodeServiceState newState)	Overrides the cached getBlockPoolId() with an update.
abstract void	setBlockPoolId(java.lang.String blockPoolId)
abstract void	setClusterId(java.lang.String clusterId)
static void	setDeletionMs(long time)	Set the deletion time for this class.
static void	setExpirationMs(long time)	Set the expiration time for this class.
abstract void	setIsSafeMode(boolean isSafeMode)
abstract void	setLastContact(long contact)
abstract void	setLifelineAddress(java.lang.String lifelineAddress)
abstract void	setNamenodeId(java.lang.String namenodeId)
abstract void	setNameserviceId(java.lang.String nameserviceId)
abstract void	setRouterId(java.lang.String routerId)
abstract void	setRpcAddress(java.lang.String rpcAddress)
abstract void	setServiceAddress(java.lang.String serviceAddress)
abstract void	setState(FederationNamenodeServiceState state)
abstract void	setStats(MembershipStats stats)
abstract void	setWebAddress(java.lang.String webAddress)
abstract void	setWebScheme(java.lang.String webScheme)
java.lang.String	toString()
void	validate()	Validates the entry.

Methods inherited from class org.apache.hadoop.hdfs.server.federation.store.records.BaseRecord

equals, generateMashupKey, getDateCreated, getDateModified, getPrimaryKey, hashCode, hasOtherFields, init, setDateCreated, setDateModified, shouldBeDeleted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hdfs.server.federation.resolver.FederationNamenodeContext

getDateModified

Field Detail

ERROR_MSG_NO_NS_SPECIFIED

public static final java.lang.String ERROR_MSG_NO_NS_SPECIFIED

See Also:

Constant Field Values

ERROR_MSG_NO_WEB_ADDR_SPECIFIED

public static final java.lang.String ERROR_MSG_NO_WEB_ADDR_SPECIFIED

See Also:

Constant Field Values

ERROR_MSG_NO_RPC_ADDR_SPECIFIED

public static final java.lang.String ERROR_MSG_NO_RPC_ADDR_SPECIFIED

See Also:

Constant Field Values

ERROR_MSG_NO_BP_SPECIFIED

public static final java.lang.String ERROR_MSG_NO_BP_SPECIFIED

See Also:

Constant Field Values

NAME_COMPARATOR

public static final java.util.Comparator<MembershipState> NAME_COMPARATOR

Comparator based on the name.

Constructor Detail

MembershipState

public MembershipState()

Constructors.

Method Detail

newInstance

public static MembershipState newInstance()

Create a new membership instance.

Returns:

Membership instance.

newInstance

public static MembershipState newInstance(java.lang.String router,
                                          java.lang.String nameservice,
                                          java.lang.String namenode,
                                          java.lang.String clusterId,
                                          java.lang.String blockPoolId,
                                          java.lang.String rpcAddress,
                                          java.lang.String serviceAddress,
                                          java.lang.String lifelineAddress,
                                          java.lang.String webScheme,
                                          java.lang.String webAddress,
                                          FederationNamenodeServiceState state,
                                          boolean safemode)

Create a new membership instance.

Parameters:

router - Identifier of the router.

nameservice - Identifier of the nameservice.

namenode - Identifier of the namenode.

clusterId - Identifier of the cluster.

blockPoolId - Identifier of the blockpool.

rpcAddress - RPC address.

serviceAddress - Service RPC address.

lifelineAddress - Lifeline RPC address.

webScheme - Scheme of Web Address, HTTP or HTTPS.

webAddress - HTTP(s) address.

state - State of the federation.

safemode - If the safe mode is enabled.

Returns:

Membership instance.

setRouterId

public abstract void setRouterId(java.lang.String routerId)

getRouterId

public abstract java.lang.String getRouterId()

setNameserviceId

public abstract void setNameserviceId(java.lang.String nameserviceId)

setNamenodeId

public abstract void setNamenodeId(java.lang.String namenodeId)

setWebAddress

public abstract void setWebAddress(java.lang.String webAddress)

setRpcAddress

public abstract void setRpcAddress(java.lang.String rpcAddress)

setServiceAddress

public abstract void setServiceAddress(java.lang.String serviceAddress)

setLifelineAddress

public abstract void setLifelineAddress(java.lang.String lifelineAddress)

setIsSafeMode

public abstract void setIsSafeMode(boolean isSafeMode)

setClusterId

public abstract void setClusterId(java.lang.String clusterId)

setBlockPoolId

public abstract void setBlockPoolId(java.lang.String blockPoolId)

setState

public abstract void setState(FederationNamenodeServiceState state)

setWebScheme

public abstract void setWebScheme(java.lang.String webScheme)

getNameserviceId

public abstract java.lang.String getNameserviceId()

Description copied from interface: FederationNamenodeContext

Identifier for the nameservice/namespace.

Specified by:

getNameserviceId in interface FederationNamenodeContext

Returns:

Namenode nameservice identifier.

getNamenodeId

public abstract java.lang.String getNamenodeId()

Description copied from interface: FederationNamenodeContext

Identifier for the namenode.

Specified by:

getNamenodeId in interface FederationNamenodeContext

Returns:

String

getClusterId

public abstract java.lang.String getClusterId()

getBlockPoolId

public abstract java.lang.String getBlockPoolId()

getRpcAddress

public abstract java.lang.String getRpcAddress()

Description copied from interface: FederationNamenodeContext

Get the RPC server address of the namenode.

Specified by:

getRpcAddress in interface FederationNamenodeContext

Returns:

RPC server address in the form of host:port.

getServiceAddress

public abstract java.lang.String getServiceAddress()

Description copied from interface: FederationNamenodeContext

Get the Service RPC server address of the namenode.

Specified by:

getServiceAddress in interface FederationNamenodeContext

Returns:

Service RPC server address in the form of host:port.

getLifelineAddress

public abstract java.lang.String getLifelineAddress()

Description copied from interface: FederationNamenodeContext

Get the Lifeline RPC server address of the namenode.

Specified by:

getLifelineAddress in interface FederationNamenodeContext

Returns:

Lifeline RPC server address in the form of host:port.

getWebAddress

public abstract java.lang.String getWebAddress()

Description copied from interface: FederationNamenodeContext

Get the HTTP(s) server address of the namenode.

Specified by:

getWebAddress in interface FederationNamenodeContext

Returns:

HTTP(s) address in the form of host:port.

getIsSafeMode

public abstract boolean getIsSafeMode()

getWebScheme

public abstract java.lang.String getWebScheme()

Description copied from interface: FederationNamenodeContext

Get the Scheme of web address of the namenode.

Specified by:

getWebScheme in interface FederationNamenodeContext

Returns:

Scheme of web address (HTTP/HTTPS).

getState

public abstract FederationNamenodeServiceState getState()

Description copied from interface: FederationNamenodeContext

The current state of the namenode (active, standby, etc).

Specified by:

getState in interface FederationNamenodeContext

Returns:

FederationNamenodeServiceState State of the namenode.

setStats

public abstract void setStats(MembershipStats stats)

getStats

public abstract MembershipStats getStats()

setLastContact

public abstract void setLastContact(long contact)

getLastContact

public abstract long getLastContact()

like

public boolean like(BaseRecord o)

Description copied from class: BaseRecord

Check if this record matches a partial record.

Overrides:

like in class BaseRecord

Parameters:

o - Partial record.

Returns:

If this record matches.

toString

public java.lang.String toString()

Overrides:

toString in class BaseRecord

getPrimaryKeys

public java.util.SortedMap<java.lang.String,java.lang.String> getPrimaryKeys()

Description copied from class: BaseRecord

Map of primary key names to values for the record. The primary key can be a combination of 1-n different State Store serialized values.

Specified by:

getPrimaryKeys in class BaseRecord

Returns:

Map of key/value pairs that constitute this object's primary key.

isAvailable

public boolean isAvailable()

Check if the namenode is available.

Returns:

If the namenode is available.

validate

public void validate()

Validates the entry. Throws an IllegalArgementException if the data record is missing required information.

Overrides:

validate in class BaseRecord

overrideState

public void overrideState(FederationNamenodeServiceState newState)

Overrides the cached getBlockPoolId() with an update. The state will be reset when the cache is flushed

Parameters:

newState - Service state of the namenode.

compareNameTo

public int compareNameTo(MembershipState other)

Sort by nameservice, namenode, and router.

Parameters:

other - Another membership to compare to.

Returns:

If this object goes before the parameter.

getNamenodeKey

public java.lang.String getNamenodeKey()

Get the identifier of this namenode registration.

Specified by:

getNamenodeKey in interface FederationNamenodeContext

Returns:

Identifier of the namenode.

getNamenodeKey

public static java.lang.String getNamenodeKey(java.lang.String nsId,
                                              java.lang.String nnId)

Generate the identifier for a Namenode in the HDFS federation.

Parameters:

nsId - Nameservice of the Namenode.

nnId - Namenode within the Nameservice (HA).

Returns:

Namenode identifier within the federation.

checkExpired

public boolean checkExpired(long currentTime)

Description copied from class: BaseRecord

Called when the modification time and current time is available, checks for expirations.

Overrides:

checkExpired in class BaseRecord

Parameters:

currentTime - The current timestamp in ms from the data store, to be compared against the modification and creation dates of the object.

Returns:

boolean True if the record has been updated and should be committed to the data store. Override for customized behavior.

getExpirationMs

public long getExpirationMs()

Description copied from class: BaseRecord

Get the expiration time for the record.

Specified by:

getExpirationMs in class BaseRecord

Returns:

Expiration time for the record.

setExpirationMs

public static void setExpirationMs(long time)

Set the expiration time for this class.

Parameters:

time - Expiration time in milliseconds.

isExpired

public boolean isExpired()

Description copied from class: BaseRecord

Check if this record is expired. The default is false. Override for customized behavior.

Overrides:

isExpired in class BaseRecord

Returns:

True if the record is expired.

getDeletionMs

public long getDeletionMs()

Description copied from class: BaseRecord

Get the deletion time for the expired record. The default is disabled. Override for customized behavior.

Overrides:

getDeletionMs in class BaseRecord

Returns:

Deletion time for the expired record.

setDeletionMs

public static void setDeletionMs(long time)

Set the deletion time for this class.

Parameters:

time - Deletion time in milliseconds.

compareTo

public int compareTo(BaseRecord record)

First use the comparator of the BaseRecord to compare the date modified. If they are equal, compare their primary keys to ensure that MembershipStates with the same date modified but reported by different routers will not be judged as equal.

Specified by:

compareTo in interface java.lang.Comparable<BaseRecord>

Overrides:

compareTo in class BaseRecord

Parameters:

record - the MembershipState object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.