Package dev.galasa.zosfile

Interface IZosFileHandler

public interface IZosFileHandler

Tester facing interface for zOS file management.

Provides 3 types of files:

• IUNIXFile
• IDataset
• IVSAMDataset

Typical usage would be to instantiate one of these using the newXXX(...) methods (e.g.:

invalid @link

#newDataset(String)

), then to call methods on that object to configure it, and then to call methods on this manager to manipulate it.

Method Summary

Modifier and Type	Method	Description
List<String>	listDatasets(String prefix, IZosImage image)	Return a List of data set name starting with the supplied prefix
IZosDataset	newDataset(String dsname, IZosImage image)	Instantiate a new IZosDataset, which can represent either an existing dataset, or one to be created.
IZosUNIXFile	newUNIXFile(String fullFilePath, IZosImage image)	Instantiate a new IZosUNIXFile, which can represent either an existing UNIX file, or directory, or one to be created.
IZosVSAMDataset	newVSAMDataset(String dsname, IZosImage image)	Instantiate a new IZosVSAMDataset object with the given name.

Method Details

newDataset

IZosDataset newDataset(String dsname,
 IZosImage image)
                throws ZosDatasetException

Instantiate a new IZosDataset, which can represent either an existing dataset, or one to be created. Member name will be ignored

Parameters:

dsname -

image -

Returns:

Throws:

ZosDatasetException

newUNIXFile

IZosUNIXFile newUNIXFile(String fullFilePath,
 IZosImage image)
                  throws ZosUNIXFileException

Instantiate a new IZosUNIXFile, which can represent either an existing UNIX file, or directory, or one to be created.

N.B. If a directory is to be represented, fullFilePath must end with a "/"

Parameters:

fullFilePath -

Returns:

Throws:

ZosUNIXFileException

newVSAMDataset

IZosVSAMDataset newVSAMDataset(String dsname,
 IZosImage image)
                        throws ZosVSAMDatasetException

Instantiate a new IZosVSAMDataset object with the given name. The object returned is a 'blank-slate' and will require configuring before it can be defined or stored. See

invalid @link

#newESDS(String)

,

invalid @link

#newKSDS(String)

or

invalid @link

#newRRDS(String)

for pre-configured VSAM objects.

Parameters:

dsname -

Returns:

Throws:

ZosVSAMDatasetException

listDatasets

List<String> listDatasets(String prefix,
 IZosImage image)
                   throws ZosDatasetException

Return a List of data set name starting with the supplied prefix

Parameters:

prefix -

image -

Returns:

Throws:

ZosDatasetException