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

Class RouterState

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Comparable<BaseRecord>

Direct Known Subclasses:

RouterStatePBImpl

public abstract class RouterState
extends BaseRecord

Entry to log the state of a Router in the StateStoreService.

Field Summary

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
RouterState()	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	compareTo(BaseRecord other)
abstract java.lang.String	getAddress()
abstract java.lang.String	getAdminAddress()
abstract java.lang.String	getCompileInfo()
abstract long	getDateStarted()
long	getDeletionMs()	Get the deletion time for the expired record.
long	getExpirationMs()	Get the expiration time for the record.
java.util.SortedMap<java.lang.String,java.lang.String>	getPrimaryKeys()	Map of primary key names to values for the record.
java.lang.String	getRouterId()	Get the identifier for the Router.
abstract StateStoreVersion	getStateStoreVersion()
abstract RouterServiceState	getStatus()
abstract java.lang.String	getVersion()
boolean	isExpired()	Check if this record is expired.
boolean	like(BaseRecord o)	Check if this record matches a partial record.
static RouterState	newInstance()
static RouterState	newInstance(java.lang.String addr, long startTime, RouterServiceState status)
abstract void	setAddress(java.lang.String address)
abstract void	setAdminAddress(java.lang.String adminAddress)
abstract void	setCompileInfo(java.lang.String info)
abstract void	setDateStarted(long dateStarted)
static void	setDeletionMs(long time)
static void	setExpirationMs(long time)
abstract void	setStateStoreVersion(StateStoreVersion version)
abstract void	setStatus(RouterServiceState newStatus)
abstract void	setVersion(java.lang.String version)
java.lang.String	toString()
void	validate()	Validates the record.

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

Constructor Detail

RouterState

public RouterState()

Constructors.

Method Detail

newInstance

public static RouterState newInstance()

newInstance

public static RouterState newInstance(java.lang.String addr,
                                      long startTime,
                                      RouterServiceState status)

setAddress

public abstract void setAddress(java.lang.String address)

setDateStarted

public abstract void setDateStarted(long dateStarted)

getAddress

public abstract java.lang.String getAddress()

getStateStoreVersion

public abstract StateStoreVersion getStateStoreVersion()
                                                throws java.io.IOException

Throws:

java.io.IOException

setStateStoreVersion

public abstract void setStateStoreVersion(StateStoreVersion version)

getStatus

public abstract RouterServiceState getStatus()

setStatus

public abstract void setStatus(RouterServiceState newStatus)

getVersion

public abstract java.lang.String getVersion()

setVersion

public abstract void setVersion(java.lang.String version)

getCompileInfo

public abstract java.lang.String getCompileInfo()

setCompileInfo

public abstract void setCompileInfo(java.lang.String info)

getDateStarted

public abstract long getDateStarted()

setAdminAddress

public abstract void setAdminAddress(java.lang.String adminAddress)

getAdminAddress

public abstract java.lang.String getAdminAddress()

getRouterId

public java.lang.String getRouterId()

Get the identifier for the Router. It uses the address.

Returns:

Identifier for the Router.

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.

validate

public void validate()

Description copied from class: BaseRecord

Validates the record. Called when the record is created, populated from the state store, and before committing to the state store. If validate failed, there throws an exception.

Overrides:

validate in class BaseRecord

compareTo

public int compareTo(BaseRecord other)

Specified by:

compareTo in interface java.lang.Comparable<BaseRecord>

Overrides:

compareTo in class BaseRecord

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)

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)