Interface IAdvancedFSOps
- All Known Implementing Classes:
AdvancedFSOps
public interface IAdvancedFSOps
-
Method Summary
Modifier and TypeMethodDescriptionvoidcopyDirectory(File fromDir, File toDir) Copy a directory.voidcreateSymlink(File link, File target) Create a symbolic link pointing at target.voiddeleteIfExists(File path) Delete a file or a directory and all of the children.voiddeleteIfExists(File path, String user, String logPrefix) Delete a file or a directory and all of the children.booleandoRequiredTopoFilesExist(Map<String, Object> conf, String topologyId) Sanity check if everything the topology needs is there for it to run.voidDump a string to a file.booleanfileExists(File path) Check if a file exists or not.booleanfileExists(Path path) Check if a file exists or not.voidforceMkdir(File path) Makes a directory, including any necessary but nonexistent parent directories.voidforceMkdir(Path path) Makes a directory, including any necessary but nonexistent parent directories.getOutputStream(File file) Get an output stream to write to a given file.Get a writer for the given location.voidmoveDirectoryPreferAtomic(File fromDir, File toDir) Move fromDir to toDir, and try to make it an atomic move if possible.voidMoves a file to a given destination.newDirectoryStream(Path dir) List the contents of a directory.newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) List the contents of a directory.voidSet directory permissions to (OWNER)RWX (GROUP)R-X (OTHER)--- On some systems that do not support this, it may become a noop.voidsetupBlobPermissions(File path, String user) Setup permissions properly for an internal blob store path.voidsetupStormCodeDir(String user, File path) Setup the permissions for the storm code dir.voidsetupWorkerArtifactsDir(String user, File path) Setup the permissions for the worker artifacts dirs.byte[]Read the contents of a file into a byte array.slurpString(File location) Read the contents of a file into a String.booleanCheck whether supports atomic directory move.
-
Method Details
-
restrictDirectoryPermissions
Set directory permissions to (OWNER)RWX (GROUP)R-X (OTHER)--- On some systems that do not support this, it may become a noop.- Parameters:
dir- the directory to change permissions on- Throws:
IOException- on any error
-
moveDirectoryPreferAtomic
Move fromDir to toDir, and try to make it an atomic move if possible.- Parameters:
fromDir- what to movetoDir- where to move it from- Throws:
IOException- on any error
-
moveFile
Moves a file to a given destination.- Parameters:
fromFile- file to movetoFile- where to move it- Throws:
IOException- on any error
-
supportsAtomicDirectoryMove
boolean supportsAtomicDirectoryMove()Check whether supports atomic directory move.- Returns:
- true if an atomic directory move works, else false
-
copyDirectory
Copy a directory.- Parameters:
fromDir- from wheretoDir- to where- Throws:
IOException- on any error
-
setupBlobPermissions
Setup permissions properly for an internal blob store path.- Parameters:
path- the path to set the permissions onuser- the user to change the permissions for- Throws:
IOException- on any error
-
deleteIfExists
Delete a file or a directory and all of the children. If it exists.- Parameters:
path- what to deleteuser- who to delete it as if doing it as someone else is supportedlogPrefix- if an external process needs to be launched to delete the object what prefix to include in the logs- Throws:
IOException- on any error.
-
deleteIfExists
Delete a file or a directory and all of the children. If it exists.- Parameters:
path- what to delete- Throws:
IOException- on any error.
-
setupStormCodeDir
Setup the permissions for the storm code dir.- Parameters:
user- the owner of the topologypath- the directory to set the permissions on- Throws:
IOException- on any error
-
setupWorkerArtifactsDir
Setup the permissions for the worker artifacts dirs.- Parameters:
user- the owner of the topologypath- the directory to set the permissions on- Throws:
IOException- on any error
-
doRequiredTopoFilesExist
Sanity check if everything the topology needs is there for it to run.- Parameters:
conf- the config of the supervisortopologyId- the ID of the topology- Returns:
- true if everything is there, else false
- Throws:
IOException- on any error
-
forceMkdir
Makes a directory, including any necessary but nonexistent parent directories.- Parameters:
path- the directory to create- Throws:
IOException- on any error
-
forceMkdir
Makes a directory, including any necessary but nonexistent parent directories.- Parameters:
path- the directory to create- Throws:
IOException- on any error
-
newDirectoryStream
DirectoryStream<Path> newDirectoryStream(Path dir, DirectoryStream.Filter<? super Path> filter) throws IOException List the contents of a directory.- Parameters:
dir- the driectory to list the contents offilter- a filter to decide if it should be included or not- Returns:
- A stream of directory entries
- Throws:
IOException- on any error
-
newDirectoryStream
List the contents of a directory.- Parameters:
dir- the driectory to list the contents of- Returns:
- A stream of directory entries
- Throws:
IOException- on any error
-
fileExists
Check if a file exists or not.- Parameters:
path- the path to check- Returns:
- true if it exists else false
- Throws:
IOException- on any error.
-
fileExists
Check if a file exists or not.- Parameters:
path- the path to check- Returns:
- true if it exists else false
- Throws:
IOException- on any error.
-
getWriter
Get a writer for the given location.- Parameters:
file- the file to write to- Returns:
- the Writer to use.
- Throws:
IOException- on any error
-
getOutputStream
Get an output stream to write to a given file.- Parameters:
file- the file to write to- Returns:
- an OutputStream for that file
- Throws:
IOException- on any error
-
dump
Dump a string to a file.- Parameters:
location- where to write todata- the data to write- Throws:
IOException- on any error
-
slurpString
Read the contents of a file into a String.- Parameters:
location- the file to read- Returns:
- the contents of the file
- Throws:
IOException- on any error
-
slurp
Read the contents of a file into a byte array.- Parameters:
location- the file to read- Returns:
- the contents of the file
- Throws:
IOException- on any error
-
createSymlink
Create a symbolic link pointing at target.- Parameters:
link- the link to createtarget- where it should point to- Throws:
IOException- on any error.
-