org.gridgain.grid.kernal.ggfs.hadoop

Interface GridGgfsHadoop

All Known Subinterfaces:

GridGgfsHadoopEx

All Known Implementing Classes:

GridGgfsHadoopInProc, GridGgfsHadoopOutProc, GridGgfsHadoopWrapper

public interface GridGgfsHadoop

Facade for communication with grid.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<org.gridgain.grid.ggfs.GridGgfsBlockLocation>	affinity(org.gridgain.grid.ggfs.GridGgfsPath path, long start, long len) Command to get affinity for given path, offset and length.
GridGgfsHadoopStreamDelegate	append(org.gridgain.grid.ggfs.GridGgfsPath path, boolean create, Map<String,String> props) Open file for output appending data to the end of a file.
void	close(boolean force) Close connection.
org.gridgain.grid.ggfs.GridGgfsPathSummary	contentSummary(org.gridgain.grid.ggfs.GridGgfsPath path) Gets path summary.
GridGgfsHadoopStreamDelegate	create(org.gridgain.grid.ggfs.GridGgfsPath path, boolean overwrite, boolean colocate, int replication, long blockSize, Map<String,String> props) Command to create file and open it for output.
Boolean	delete(org.gridgain.grid.ggfs.GridGgfsPath path, boolean recursive) Command to delete given path.
GridGgfsStatus	fsStatus() Performs status request.
GridGgfsHandshakeResponse	handshake(String logDir) Perform handshake.
org.gridgain.grid.ggfs.GridGgfsFile	info(org.gridgain.grid.ggfs.GridGgfsPath path) Command to retrieve file info for some GGFS path.
Collection<org.gridgain.grid.ggfs.GridGgfsFile>	listFiles(org.gridgain.grid.ggfs.GridGgfsPath path) Command to get list of files in directory.
Collection<org.gridgain.grid.ggfs.GridGgfsPath>	listPaths(org.gridgain.grid.ggfs.GridGgfsPath path) Command to get directory listing.
Boolean	mkdirs(org.gridgain.grid.ggfs.GridGgfsPath path, Map<String,String> props) Command to create directories.
GridGgfsHadoopStreamDelegate	open(org.gridgain.grid.ggfs.GridGgfsPath path) Command to open file for reading.
GridGgfsHadoopStreamDelegate	open(org.gridgain.grid.ggfs.GridGgfsPath path, int seqReadsBeforePrefetch) Command to open file for reading.
Boolean	rename(org.gridgain.grid.ggfs.GridGgfsPath src, org.gridgain.grid.ggfs.GridGgfsPath dest) Command to rename given path.
Boolean	setTimes(org.gridgain.grid.ggfs.GridGgfsPath path, long accessTime, long modificationTime) Sets last access time and last modification time for a file.
org.gridgain.grid.ggfs.GridGgfsFile	update(org.gridgain.grid.ggfs.GridGgfsPath path, Map<String,String> props) Command to update file properties.

Method Detail

handshake

GridGgfsHandshakeResponse handshake(String logDir)
                                    throws org.gridgain.grid.GridException,
                                           IOException

Perform handshake.

Parameters:

logDir - Log directory.

Returns:

Future with handshake result.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

close

void close(boolean force)

Close connection.

Parameters:

force - Force flag.

info

org.gridgain.grid.ggfs.GridGgfsFile info(org.gridgain.grid.ggfs.GridGgfsPath path)
                                         throws org.gridgain.grid.GridException,
                                                IOException

Command to retrieve file info for some GGFS path.

Parameters:

path - Path to get file info for.

Returns:

Future for info operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

update

org.gridgain.grid.ggfs.GridGgfsFile update(org.gridgain.grid.ggfs.GridGgfsPath path,
                                         Map<String,String> props)
                                           throws org.gridgain.grid.GridException,
                                                  IOException

Command to update file properties.

Parameters:

path - GGFS path to update properties.

props - Properties to update.

Returns:

Future for update operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

setTimes

Boolean setTimes(org.gridgain.grid.ggfs.GridGgfsPath path,
               long accessTime,
               long modificationTime)
                 throws org.gridgain.grid.GridException,
                        IOException

Sets last access time and last modification time for a file.

Parameters:

path - Path to update times.

accessTime - Last access time to set.

modificationTime - Last modification time to set.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

rename

Boolean rename(org.gridgain.grid.ggfs.GridGgfsPath src,
             org.gridgain.grid.ggfs.GridGgfsPath dest)
               throws org.gridgain.grid.GridException,
                      IOException

Command to rename given path.

Parameters:

src - Source path.

dest - Destination path.

Returns:

Future for rename operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

delete

Boolean delete(org.gridgain.grid.ggfs.GridGgfsPath path,
             boolean recursive)
               throws org.gridgain.grid.GridException,
                      IOException

Command to delete given path.

Parameters:

path - Path to delete.

recursive - True if deletion is recursive.

Returns:

Future for delete operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

affinity

Collection<org.gridgain.grid.ggfs.GridGgfsBlockLocation> affinity(org.gridgain.grid.ggfs.GridGgfsPath path,
                                                                long start,
                                                                long len)
                                                                  throws org.gridgain.grid.GridException,
                                                                         IOException

Command to get affinity for given path, offset and length.

Parameters:

path - Path to get affinity for.

start - Start position (offset).

len - Data length.

Returns:

Future for affinity command.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

contentSummary

org.gridgain.grid.ggfs.GridGgfsPathSummary contentSummary(org.gridgain.grid.ggfs.GridGgfsPath path)
                                                          throws org.gridgain.grid.GridException,
                                                                 IOException

Gets path summary.

Parameters:

path - Path to get summary for.

Returns:

Future that will be completed when summary is received.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

mkdirs

Boolean mkdirs(org.gridgain.grid.ggfs.GridGgfsPath path,
             Map<String,String> props)
               throws org.gridgain.grid.GridException,
                      IOException

Command to create directories.

Parameters:

path - Path to create.

Returns:

Future for mkdirs operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

listFiles

Collection<org.gridgain.grid.ggfs.GridGgfsFile> listFiles(org.gridgain.grid.ggfs.GridGgfsPath path)
                                                          throws org.gridgain.grid.GridException,
                                                                 IOException

Command to get list of files in directory.

Parameters:

path - Path to list.

Returns:

Future for listFiles operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

listPaths

Collection<org.gridgain.grid.ggfs.GridGgfsPath> listPaths(org.gridgain.grid.ggfs.GridGgfsPath path)
                                                          throws org.gridgain.grid.GridException,
                                                                 IOException

Command to get directory listing.

Parameters:

path - Path to list.

Returns:

Future for listPaths operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

fsStatus

GridGgfsStatus fsStatus()
                        throws org.gridgain.grid.GridException,
                               IOException

Performs status request.

Returns:

Status response.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

open

GridGgfsHadoopStreamDelegate open(org.gridgain.grid.ggfs.GridGgfsPath path)
                                  throws org.gridgain.grid.GridException,
                                         IOException

Command to open file for reading.

Parameters:

path - File path to open.

Returns:

Future for open operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

open

GridGgfsHadoopStreamDelegate open(org.gridgain.grid.ggfs.GridGgfsPath path,
                                int seqReadsBeforePrefetch)
                                  throws org.gridgain.grid.GridException,
                                         IOException

Command to open file for reading.

Parameters:

path - File path to open.

Returns:

Future for open operation.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

create

GridGgfsHadoopStreamDelegate create(org.gridgain.grid.ggfs.GridGgfsPath path,
                                  boolean overwrite,
                                  boolean colocate,
                                  int replication,
                                  long blockSize,
                                  @Nullable
                                  Map<String,String> props)
                                    throws org.gridgain.grid.GridException,
                                           IOException

Command to create file and open it for output.

Parameters:

path - Path to file.

overwrite - If true then old file contents will be lost.

colocate - If true and called on data node, file will be written on that node.

replication - Replication factor.

props - File properties for creation.

Returns:

Stream descriptor.

Throws:

org.gridgain.grid.GridException - If failed.

IOException

append

GridGgfsHadoopStreamDelegate append(org.gridgain.grid.ggfs.GridGgfsPath path,
                                  boolean create,
                                  @Nullable
                                  Map<String,String> props)
                                    throws org.gridgain.grid.GridException,
                                           IOException

Open file for output appending data to the end of a file.

Parameters:

path - Path to file.

create - If true, file will be created if does not exist.

props - File properties.

Returns:

Stream descriptor.

Throws:

org.gridgain.grid.GridException - If failed.

IOException