Package org.apache.hadoop.hdfs.tools.federation

Class RouterAdmin

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hdfs.tools.federation.RouterAdmin

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@Private
public class RouterAdmin
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

This class provides some Federation administrative access shell commands.

Constructor Summary

Constructors

Constructor	Description
RouterAdmin(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
boolean	addMount(java.lang.String[] parameters, int i)	Add a mount table entry or update if it exists.
boolean	addMount(AddMountAttributes addMountAttributes)	Add a mount table entry or update if it exists.
static boolean	dumpStateStore(org.apache.hadoop.conf.Configuration conf, java.io.PrintStream output)	Dumps the contents of the StateStore to stdout.
int	genericRefresh(java.lang.String[] argv, int i)
void	listMounts(java.lang.String[] argv, int i)	List mount points.
static void	main(java.lang.String[] argv)
static java.lang.String	normalizeFileSystemPath(java.lang.String str)	Normalize a path for that filesystem.
void	printUsage()	Print the usage message.
boolean	removeMount(java.lang.String path)	Remove mount point.
int	run(java.lang.String[] argv)
boolean	updateMount(java.lang.String[] parameters, int i)	Update a mount table entry.

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Constructor Detail

RouterAdmin

public RouterAdmin(org.apache.hadoop.conf.Configuration conf)

Method Detail

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Throws:

java.lang.Exception

printUsage

public void printUsage()

Print the usage message.

run

public int run(java.lang.String[] argv)
        throws java.lang.Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

java.lang.Exception

addMount

public boolean addMount(java.lang.String[] parameters,
                        int i)
                 throws java.io.IOException

Add a mount table entry or update if it exists.

Parameters:

parameters - Parameters for the mount point.

i - Index in the parameters.

Returns:

If it was successful.

Throws:

java.io.IOException - If it cannot add the mount point.

addMount

public boolean addMount(AddMountAttributes addMountAttributes)
                 throws java.io.IOException

Add a mount table entry or update if it exists.

Parameters:

addMountAttributes - attributes associated with add mount point request.

Returns:

If the mount point was added.

Throws:

java.io.IOException - Error adding the mount point.

updateMount

public boolean updateMount(java.lang.String[] parameters,
                           int i)
                    throws java.io.IOException

Update a mount table entry.

Parameters:

parameters - Parameters for the mount point.

i - Index in the parameters.

Returns:

If it updated the mount point successfully.

Throws:

java.io.IOException - If there is an error.

removeMount

public boolean removeMount(java.lang.String path)
                    throws java.io.IOException

Remove mount point.

Parameters:

path - Path to remove.

Returns:

If the mount point was removed successfully.

Throws:

java.io.IOException - If it cannot be removed.

listMounts

public void listMounts(java.lang.String[] argv,
                       int i)
                throws java.io.IOException

List mount points.

Parameters:

argv - Parameters of the path.

i - Index in the parameters.

Throws:

java.io.IOException - If it cannot be listed.

genericRefresh

public int genericRefresh(java.lang.String[] argv,
                          int i)
                   throws java.io.IOException

Throws:

java.io.IOException

dumpStateStore

public static boolean dumpStateStore(org.apache.hadoop.conf.Configuration conf,
                                     java.io.PrintStream output)
                              throws java.io.IOException

Dumps the contents of the StateStore to stdout.

Parameters:

conf - the configuration.

output - the print output stream.

Returns:

true if it was successful.

Throws:

java.io.IOException - if the State store is not available.

normalizeFileSystemPath

public static java.lang.String normalizeFileSystemPath(java.lang.String str)

Normalize a path for that filesystem.

Parameters:

str - Path to normalize. The path doesn't have scheme or authority.

Returns:

Normalized path.