Package org.apache.hadoop.hdfs.server.datanode

Class StorageLocation

java.lang.Object

org.apache.hadoop.hdfs.server.datanode.StorageLocation

All Implemented Interfaces:

java.lang.Comparable<StorageLocation>, Checkable<StorageLocation.CheckContext,VolumeCheckResult>

@Private
public class StorageLocation
extends java.lang.Object
implements Checkable<StorageLocation.CheckContext,VolumeCheckResult>, java.lang.Comparable<StorageLocation>

Encapsulates the URI and storage medium that together describe a storage directory. The default storage medium is assumed to be DISK, if none is specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StorageLocation.CheckContext	Class to hold the parameters for running a check(org.apache.hadoop.hdfs.server.datanode.StorageLocation.CheckContext).

Method Summary

Modifier and Type	Method	Description
VolumeCheckResult	check(StorageLocation.CheckContext context)	Query the health of this object.
int	compareTo(StorageLocation obj)
boolean	equals(java.lang.Object obj)
java.net.URI	getBpURI(java.lang.String bpid, java.lang.String currentStorageDir)
java.net.URI	getNormalizedUri()
org.apache.hadoop.fs.StorageType	getStorageType()
java.net.URI	getUri()
int	hashCode()
void	makeBlockPoolDir(java.lang.String blockPoolID, org.apache.hadoop.conf.Configuration conf)	Create physical directory for block pools on the data node.
boolean	matchesStorageDirectory(Storage.StorageDirectory sd)
boolean	matchesStorageDirectory(Storage.StorageDirectory sd, java.lang.String bpid)
static java.net.URI	normalizeFileURI(java.net.URI uri)
static StorageLocation	parse(java.lang.String rawLocation)	Attempt to parse a storage uri with storage class and URI.
static java.util.Map<java.net.URI,java.lang.Double>	parseCapacityRatio(java.lang.String capacityRatioConf)	Attempt to parse the storage capacity ratio and related volume directory out of the capacity ratio config string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

normalizeFileURI

public static java.net.URI normalizeFileURI(java.net.URI uri)

getStorageType

public org.apache.hadoop.fs.StorageType getStorageType()

getUri

public java.net.URI getUri()

getNormalizedUri

public java.net.URI getNormalizedUri()

matchesStorageDirectory

public boolean matchesStorageDirectory(Storage.StorageDirectory sd)
                                throws java.io.IOException

Throws:

java.io.IOException

matchesStorageDirectory

public boolean matchesStorageDirectory(Storage.StorageDirectory sd,
                                       java.lang.String bpid)
                                throws java.io.IOException

Throws:

java.io.IOException

parse

public static StorageLocation parse(java.lang.String rawLocation)
                             throws java.io.IOException,
                                    java.lang.SecurityException

Attempt to parse a storage uri with storage class and URI. The storage class component of the uri is case-insensitive.

Parameters:

rawLocation - Location string of the format [type]uri, where [type] is optional.

Returns:

A StorageLocation object if successfully parsed, null otherwise. Does not throw any exceptions.

Throws:

java.io.IOException

java.lang.SecurityException

parseCapacityRatio

public static java.util.Map<java.net.URI,java.lang.Double> parseCapacityRatio(java.lang.String capacityRatioConf)
                                                                             throws java.lang.SecurityException

Attempt to parse the storage capacity ratio and related volume directory out of the capacity ratio config string.

Parameters:

capacityRatioConf - Config string of the capacity ratio

Returns:

Map of URI of the volume and capacity ratio.

Throws:

java.lang.SecurityException - when format is incorrect or ratio is not between 0 - 1.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(StorageLocation obj)

Specified by:

compareTo in interface java.lang.Comparable<StorageLocation>

getBpURI

public java.net.URI getBpURI(java.lang.String bpid,
                             java.lang.String currentStorageDir)

makeBlockPoolDir

public void makeBlockPoolDir(java.lang.String blockPoolID,
                             org.apache.hadoop.conf.Configuration conf)
                      throws java.io.IOException

Create physical directory for block pools on the data node.

Parameters:

blockPoolID - the block pool id

conf - Configuration instance to use.

Throws:

java.io.IOException - on errors

check

public VolumeCheckResult check(StorageLocation.CheckContext context)
                        throws java.io.IOException

Description copied from interface: Checkable

Query the health of this object. This method may hang indefinitely depending on the status of the target resource.

Specified by:

check in interface Checkable<StorageLocation.CheckContext,VolumeCheckResult>

Parameters:

context - for the probe operation. May be null depending on the implementation.

Returns:

result of the check operation.

Throws:

java.io.IOException