Package org.apache.hadoop.fs.azure

Class NativeAzureFileSystem.FolderRenamePending

java.lang.Object

org.apache.hadoop.fs.azure.NativeAzureFileSystem.FolderRenamePending

Enclosing class:

NativeAzureFileSystem

public static class NativeAzureFileSystem.FolderRenamePending
extends java.lang.Object

A description of a folder rename operation, including the source and destination keys, and descriptions of the files in the source folder.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SUFFIX

Constructor Summary

Constructors

Constructor	Description
FolderRenamePending(java.lang.String srcKey, java.lang.String dstKey, SelfRenewingLease lease, NativeAzureFileSystem fs)
FolderRenamePending(org.apache.hadoop.fs.Path redoFile, NativeAzureFileSystem fs)

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Clean up after execution of rename.
void	execute()	Execute a folder rename.
java.lang.String	getDstKey()
org.apache.hadoop.fs.azure.FileMetadata[]	getFiles()
SelfRenewingLease	getFolderLease()
org.apache.hadoop.fs.azure.FileMetadata	getSourceMetadata()
java.lang.String	getSrcKey()
java.lang.String	makeRenamePendingFileContents()	Return the contents of the JSON file to represent the operations to be performed for a folder rename.
void	redo()	Recover from a folder rename failure by redoing the intended work, as recorded in the -RenamePending.json file.
void	writeFile(NativeAzureFileSystem fs)	Write to disk the information needed to redo folder rename, in JSON format.

Methods inherited from class java.lang.Object

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

Field Detail

SUFFIX

public static final java.lang.String SUFFIX

See Also:

Constant Field Values

Constructor Detail

FolderRenamePending

public FolderRenamePending(java.lang.String srcKey,
                           java.lang.String dstKey,
                           SelfRenewingLease lease,
                           NativeAzureFileSystem fs)
                    throws java.io.IOException

Throws:

java.io.IOException

FolderRenamePending

public FolderRenamePending(org.apache.hadoop.fs.Path redoFile,
                           NativeAzureFileSystem fs)
                    throws java.lang.IllegalArgumentException,
                           java.io.IOException

Throws:

java.lang.IllegalArgumentException

java.io.IOException

Method Detail

getFiles

public org.apache.hadoop.fs.azure.FileMetadata[] getFiles()

getFolderLease

public SelfRenewingLease getFolderLease()

writeFile

public void writeFile(NativeAzureFileSystem fs)
               throws java.io.IOException

Write to disk the information needed to redo folder rename, in JSON format. The file name will be wasb://<sourceFolderPrefix>/folderName-RenamePending.json The file format will be:

 {
   FormatVersion: "1.0",
   OperationTime: "<YYYY-MM-DD HH:MM:SS.MMM>",
   OldFolderName: "<key>",
   NewFolderName: "<key>",
   FileList: [ <string> , <string> , ... ]
 }

 Here's a sample:
 {
  FormatVersion: "1.0",
  OperationUTCTime: "2014-07-01 23:50:35.572",
  OldFolderName: "user/ehans/folderToRename",
  NewFolderName: "user/ehans/renamedFolder",
  FileList: [
    "innerFile",
    "innerFile2"
  ]
 } 

Parameters:

fs - file system on which a file is written.

Throws:

java.io.IOException - Thrown when fail to write file.

makeRenamePendingFileContents

public java.lang.String makeRenamePendingFileContents()

Return the contents of the JSON file to represent the operations to be performed for a folder rename.

Returns:

JSON string which represents the operation.

getSrcKey

public java.lang.String getSrcKey()

getDstKey

public java.lang.String getDstKey()

getSourceMetadata

public org.apache.hadoop.fs.azure.FileMetadata getSourceMetadata()
                                                          throws java.io.IOException

Throws:

java.io.IOException

execute

public void execute()
             throws java.io.IOException

Execute a folder rename. This is the execution path followed when everything is working normally. See redo() for the alternate execution path for the case where we're recovering from a folder rename failure.

Throws:

java.io.IOException - Thrown when fail to renaming.

cleanup

public void cleanup()
             throws java.io.IOException

Clean up after execution of rename.

Throws:

java.io.IOException - Thrown when fail to clean up.

redo

public void redo()
          throws java.io.IOException

Recover from a folder rename failure by redoing the intended work, as recorded in the -RenamePending.json file.

Throws:

java.io.IOException - Thrown when fail to redo.