Package org.apache.hadoop.ozone.om.fs

Interface OzoneManagerFS

All Superinterfaces:

IOzoneAcl

All Known Subinterfaces:

KeyManager

All Known Implementing Classes:

KeyManagerImpl

public interface OzoneManagerFS
extends IOzoneAcl

Ozone Manager FileSystem interface.

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.ozone.om.helpers.OzoneFileStatus	getFileStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args)	Get file status for a file or a directory.
org.apache.hadoop.ozone.om.helpers.OzoneFileStatus	getFileStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args, String clientAddress)	Get file status for a file or a directory.
List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus>	listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs, boolean recursive, String startKey, long numEntries)	List the status for a file or a directory and its contents.
List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus>	listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs, boolean recursive, String startKey, long numEntries, String clientAddress)	List the status for a file or a directory and its contents.
List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus>	listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs, boolean recursive, String startKey, long numEntries, String clientAddress, boolean allowPartialPrefixes)	List the status for a file or a directory and its contents.
org.apache.hadoop.ozone.om.helpers.OmKeyInfo	lookupFile(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args, String clientAddress)	Look up a file.

Methods inherited from interface org.apache.hadoop.ozone.om.IOzoneAcl

checkAccess, getAcl

Method Details

getFileStatus

org.apache.hadoop.ozone.om.helpers.OzoneFileStatus getFileStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args)
                                                          throws IOException

Get file status for a file or a directory.

Parameters:

args - the args of the key provided by client.

Returns:

file status.

Throws:

IOException - if file or bucket or volume does not exist

getFileStatus

org.apache.hadoop.ozone.om.helpers.OzoneFileStatus getFileStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args,
 String clientAddress)
                                                          throws IOException

Get file status for a file or a directory.

Parameters:

args - the args of the key provided by client.

clientAddress - a hint to key manager, order the datanode in returned pipeline by distance between client and datanode.

Returns:

file status.

Throws:

IOException - if file or bucket or volume does not exist

lookupFile

org.apache.hadoop.ozone.om.helpers.OmKeyInfo lookupFile(org.apache.hadoop.ozone.om.helpers.OmKeyArgs args,
 String clientAddress)
                                                 throws IOException

Look up a file. Return the info of the file to client side.

Parameters:

args - the args of the key provided by client.

clientAddress - a hint to key manager, order the datanode in returned pipeline by distance between client and datanode.

Returns:

a OmKeyInfo instance client uses to talk to container.

Throws:

IOException

listStatus

List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus> listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs,
 boolean recursive,
 String startKey,
 long numEntries)
                                                             throws IOException

List the status for a file or a directory and its contents.

Parameters:

keyArgs - the args of the key provided by client.

recursive - For a directory if true all the descendants of a particular directory are listed

startKey - Key from which listing needs to start. If startKey exists its status is included in the final list.

numEntries - Number of entries to list from the start key

Returns:

list of file status

Throws:

IOException - if file or bucket or volume does not exist

listStatus

List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus> listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs,
 boolean recursive,
 String startKey,
 long numEntries,
 String clientAddress)
                                                             throws IOException

List the status for a file or a directory and its contents.

Parameters:

keyArgs - the args of the key provided by client.

recursive - For a directory if true all the descendants of a particular directory are listed

startKey - Key from which listing needs to start. If startKey exists its status is included in the final list.

numEntries - Number of entries to list from the start key

clientAddress - a hint to key manager, order the datanode in returned pipeline by distance between client and datanode.

Returns:

list of file status

Throws:

IOException - if file or bucket or volume does not exist

listStatus

List<org.apache.hadoop.ozone.om.helpers.OzoneFileStatus> listStatus(org.apache.hadoop.ozone.om.helpers.OmKeyArgs keyArgs,
 boolean recursive,
 String startKey,
 long numEntries,
 String clientAddress,
 boolean allowPartialPrefixes)
                                                             throws IOException

List the status for a file or a directory and its contents.

Parameters:

keyArgs - the args of the key provided by client.

recursive - For a directory if true all the descendants of a particular directory are listed

startKey - Key from which listing needs to start. If startKey exists its status is included in the final list.

numEntries - Number of entries to list from the start key

clientAddress - a hint to key manager, order the datanode in returned pipeline by distance between client and datanode.

allowPartialPrefixes - if partial prefixes should be allowed, this is needed in context of ListKeys

Returns:

list of file status

Throws:

IOException - if file or bucket or volume does not exist