Package dev.galasa.zosfile

Interface IZosUNIXFile

public interface IZosUNIXFile

Representation of a UNIX file or directory.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IZosUNIXFile.UNIXFileDataType	Enumeration of data type for store and retrieve of data set content: IZosUNIXFile.UNIXFileDataType.TEXT IZosUNIXFile.UNIXFileDataType.BINARY
static enum	IZosUNIXFile.UNIXFileType	Enumeration of zOS UNIX file types: IZosUNIXFile.UNIXFileType.FILE IZosUNIXFile.UNIXFileType.CHARACTER IZosUNIXFile.UNIXFileType.DIRECTORY IZosUNIXFile.UNIXFileType.EXTLINK IZosUNIXFile.UNIXFileType.SYMBLINK IZosUNIXFile.UNIXFileType.FIFO IZosUNIXFile.UNIXFileType.SOCKET IZosUNIXFile.UNIXFileType.UNKNOWN

Method Summary

Modifier and Type	Method	Description
IZosUNIXFile	create()	Create the zOS UNIX file or directory
IZosUNIXFile	create(Set<PosixFilePermission> accessPermissions)	Create the zOS UNIX file or directory with the supplied Access Permissions
boolean	delete()	Delete the zOS UNIX file or directory from the zOS image.
boolean	directoryDeleteNonEmpty()	Recursively delete the zOS UNIX directory and its contents from the zOS image
SortedMap<String,IZosUNIXFile>	directoryList()	Returns sorted SortedMap the zOS UNIX files and directories in this zOS UNIX directory
SortedMap<String,IZosUNIXFile>	directoryListRecursive()	Returns recursive sorted SortedMap the zOS UNIX files and directories in this zOS UNIX directory
boolean	exists()	Return true if the zOS UNIX exists on the zOS image
String	getAttributesAsString()	Return the attributes of the zOS UNIX file or directory as a String
IZosUNIXFile.UNIXFileDataType	getDataType()	Return the data type (IZosUNIXFile.UNIXFileDataType) for store and retrieve of the zOS UNIX file content
String	getDirectoryPath()	Return the full directory path for the zOS UNIX file or directory
String	getFileName()	Return the file name of the zOS UNIX file, or null if this object represents a directory
Set<PosixFilePermission>	getFilePermissions()
IZosUNIXFile.UNIXFileType	getFileType()	Return the zOS UNIX file type (IZosUNIXFile.UNIXFileType)
String	getGroup()
String	getLastModified()
int	getSize()
String	getUnixPath()	Return the path of the zOS UNIX file or directory
String	getUser()
boolean	isDirectory()	Return true if this object represents a zOS UNIX directory
static String	posixFilePermissionsToOctal(Set<PosixFilePermission> accessPermissions)	Convert Set<PosixFilePermission> to Numeric Notation (e.g.
static String	posixFilePermissionsToSymbolicNotation(Set<PosixFilePermission> accessPermissions)	Convert Setinvalid input: '<'PosixFilePermission> to Symbolic Notation (e.g.
byte[]	retrieveAsBinary()	Retrieve content of the zOS UNIX file from the zOS image in Binary mode
String	retrieveAsText()	Retrieve the content of the zOS UNIX file from the zOS image in Text mode
void	retrieveAttributes()	Retrieve the attributes of an existing data set to make the values available in the getter methods
void	saveToResultsArchive(String rasPath)	Recursively store the content of the zOS UNIX file or directory to the Results Archive Store
void	setAccessPermissions(Set<PosixFilePermission> accessPermissions, boolean recursive)	Change the Access Permissions of the zOS UNIX file
void	setDataType(IZosUNIXFile.UNIXFileDataType dataType)	Set the data type (IZosUNIXFile.UNIXFileDataType) for store and retrieve of the zOS UNIX file content
void	setShouldArchive(boolean shouldArchive)	Set flag to control if the content of the zOS UNIX path should be stored to the test output.
void	setShouldCleanup(boolean shouldCleanup)	Set flag to control if the zOS UNIX path should be automatically deleted from zOS at test end.
boolean	shouldArchive()	Return flag that controls if the content of the zOS UNIX path should be stored to the test output
boolean	shouldCleanup()	Return flag that controls if the zOS UNIX path should be automatically deleted from zOS at test end
void	storeBinary(@javax.validation.constraints.NotNull byte[] content)	Write content to the zOS UNIX file on the zOS image in Binary mode
void	storeText(String content)	Write the content to the zOS UNIX file on the zOS image in Text mode

Method Details

create

IZosUNIXFile create()
             throws ZosUNIXFileException

Create the zOS UNIX file or directory

Returns:

Throws:

ZosUNIXFileException

create

IZosUNIXFile create(Set<PosixFilePermission> accessPermissions)
             throws ZosUNIXFileException

Create the zOS UNIX file or directory with the supplied Access Permissions

Parameters:

accessPermissions - the access permissions, e.g.
PosixFilePermissions.fromString("rwxrwxrwx")

Returns:

Throws:

ZosUNIXFileException

delete

boolean delete()
        throws ZosUNIXFileException

Delete the zOS UNIX file or directory from the zOS image. Attempting to delete a non-empty directory will throw ZosUNIXFileException

Returns:

deleted

Throws:

ZosUNIXFileException

directoryDeleteNonEmpty

boolean directoryDeleteNonEmpty()
                         throws ZosUNIXFileException

Recursively delete the zOS UNIX directory and its contents from the zOS image

Returns:

deleted

Throws:

ZosUNIXFileException

exists

boolean exists()
        throws ZosUNIXFileException

Return true if the zOS UNIX exists on the zOS image

Returns:

Throws:

ZosUNIXFileException

storeText

void storeText(String content)
        throws ZosUNIXFileException

Write the content to the zOS UNIX file on the zOS image in Text mode

See setDataType(UNIXFileDataType)

Throws:

ZosUNIXFileException

storeBinary

void storeBinary(@NotNull
 @javax.validation.constraints.NotNull byte[] content)
          throws ZosUNIXFileException

Write content to the zOS UNIX file on the zOS image in Binary mode

See

invalid @link

#setDataType(DatasetDataType)

Parameters:

content -

Throws:

ZosUNIXFileException

retrieveAsText

String retrieveAsText()
               throws ZosUNIXFileException

Retrieve the content of the zOS UNIX file from the zOS image in Text mode

See

invalid @link

#setDataType(DatasetDataType)

Throws:

ZosUNIXFileException

retrieveAsBinary

byte[] retrieveAsBinary()
                 throws ZosUNIXFileException

Retrieve content of the zOS UNIX file from the zOS image in Binary mode

See

invalid @link

#setDataType(DatasetDataType)

Returns:

data set content

Throws:

ZosUNIXFileException

saveToResultsArchive

void saveToResultsArchive(String rasPath)
                   throws ZosUNIXFileException

Recursively store the content of the zOS UNIX file or directory to the Results Archive Store

Parameters:

rasPath - path in Results Archive Store

Throws:

ZosUNIXFileException

isDirectory

boolean isDirectory()
             throws ZosUNIXFileException

Return true if this object represents a zOS UNIX directory

Returns:

Throws:

ZosUNIXFileException

directoryList

SortedMap<String,IZosUNIXFile> directoryList()
                                      throws ZosUNIXFileException

Returns sorted SortedMap the zOS UNIX files and directories in this zOS UNIX directory

Returns:

Throws:

ZosUNIXFileException

directoryListRecursive

SortedMap<String,IZosUNIXFile> directoryListRecursive()
                                               throws ZosUNIXFileException

Returns recursive sorted SortedMap the zOS UNIX files and directories in this zOS UNIX directory

Returns:

Throws:

ZosUNIXFileException

setDataType

void setDataType(IZosUNIXFile.UNIXFileDataType dataType)

Set the data type (IZosUNIXFile.UNIXFileDataType) for store and retrieve of the zOS UNIX file content

Parameters:

fileType -

setAccessPermissions

void setAccessPermissions(Set<PosixFilePermission> accessPermissions,
 boolean recursive)
                   throws ZosUNIXFileException

Change the Access Permissions of the zOS UNIX file

Parameters:

accessPermissions - the access permissions, e.g.
PosixFilePermissions.fromString("rwxrwxrwx")

recursive - change the access permissions recursively

Throws:

ZosUNIXFileException

getFileType

IZosUNIXFile.UNIXFileType getFileType()

Return the zOS UNIX file type (IZosUNIXFile.UNIXFileType)

Parameters:

fileType -

getDataType

IZosUNIXFile.UNIXFileDataType getDataType()

Return the data type (IZosUNIXFile.UNIXFileDataType) for store and retrieve of the zOS UNIX file content

Parameters:

fileType -

getUnixPath

String getUnixPath()

Return the path of the zOS UNIX file or directory

Parameters:

fileType -

getFileName

String getFileName()

Return the file name of the zOS UNIX file, or null if this object represents a directory

Returns:

getDirectoryPath

String getDirectoryPath()
                 throws ZosUNIXFileException

Return the full directory path for the zOS UNIX file or directory

Returns:

Throws:

ZosUNIXFileException

getFilePermissions

Set<PosixFilePermission> getFilePermissions()
                                     throws ZosUNIXFileException

Throws:

ZosUNIXFileException

getSize

int getSize()
     throws ZosUNIXFileException

Throws:

ZosUNIXFileException

getLastModified

String getLastModified()
                throws ZosUNIXFileException

Throws:

ZosUNIXFileException

getUser

String getUser()
        throws ZosUNIXFileException

Throws:

ZosUNIXFileException

getGroup

String getGroup()
         throws ZosUNIXFileException

Throws:

ZosUNIXFileException

retrieveAttributes

void retrieveAttributes()
                 throws ZosUNIXFileException

Retrieve the attributes of an existing data set to make the values available in the getter methods

Throws:

ZosUNIXFileException

getAttributesAsString

String getAttributesAsString()
                      throws ZosUNIXFileException

Return the attributes of the zOS UNIX file or directory as a String

Returns:

Throws:

ZosUNIXFileException

setShouldArchive

void setShouldArchive(boolean shouldArchive)

Set flag to control if the content of the zOS UNIX path should be stored to the test output. Defaults to false

shouldArchive

boolean shouldArchive()

Return flag that controls if the content of the zOS UNIX path should be stored to the test output

setShouldCleanup

void setShouldCleanup(boolean shouldCleanup)

Set flag to control if the zOS UNIX path should be automatically deleted from zOS at test end. Defaults to true

shouldCleanup

boolean shouldCleanup()

Return flag that controls if the zOS UNIX path should be automatically deleted from zOS at test end

posixFilePermissionsToSymbolicNotation

static String posixFilePermissionsToSymbolicNotation(Set<PosixFilePermission> accessPermissions)

Convert Setinvalid input: '<'PosixFilePermission> to Symbolic Notation (e.g. rwxwrxrwx)

Parameters:

accessPermissions -

Returns:

a String containing the file permissions in Symbolic Notation

posixFilePermissionsToOctal

static String posixFilePermissionsToOctal(Set<PosixFilePermission> accessPermissions)

Convert Set<PosixFilePermission> to Numeric Notation (e.g. 777)

Parameters:

accessPermissions -

Returns:

a String containing the file permissions in Numeric Notation