Package dev.galasa.zos.spi

Interface IZosManagerSpi

All Superinterfaces:

IZosManager

public interface IZosManagerSpi
extends IZosManager

Method Summary

Modifier and Type	Method	Description
String	buildUniquePathName(Path artifactPath, String name)	Build a unique results archive artifact name
void	createArtifactDirectory(Path artifactPath)	Create an empty dirictory in the results archive on behalf of another manager
ICredentials	getCredentials(String credentialsId, String imageId)	Returns the credentials on the specified image id
@NotNull IZosImage	getImage(String imageId)	Returns a zOS Image for the specified image ID
@NotNull IZosImage	getImageForTag(@NotNull String tag)	Returns a zOS Image for the specified tag
@NotNull String	getRunDatasetHLQ(@NotNull IZosImage image)	Returns the data set HLQ(s) for temporary data sets for the specified image
@NotNull String	getRunUNIXPathPrefix(@NotNull IZosImage image)	Returns the zOS UNIX path prefix for temporary file for the specified image
HashMap<String,String>	getTaggedPorts()	Returns the provisioned z/OS ports which are tagged with a string value
@NotNull IZosImage	getUnmanagedImage(String imageId)	Returns a zOS Image for the specified image that may not have been provisioned so far
boolean	getZosBatchPropertyBatchRestrictToImage(String imageId)	Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].restrict.to.image property
int	getZosBatchPropertyJobWaitTimeout(String imageId)	Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].timeout property
boolean	getZosBatchPropertyTruncateJCLRecords(String imageId)	Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].truncate.jcl.records property
boolean	getZosBatchPropertyUseSysaff(String imageId)	Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].use.sysaff property
boolean	getZosConsolePropertyConsoleRestrictToImage(String imageId)	Provides other managers to the zOS Console zosconsole.console.[imageid].restrict.to.image property
int	getZosFilePropertyDirectoryListMaxItems(String imageId)	Provides other managers to the zOS File zosfile.unix.[imageid].directory.list.max.items property
boolean	getZosFilePropertyFileRestrictToImage(String imageId)	Provides other managers to the zOS File zosfile.batchjob.[imageid].restrict.to.image property
String	getZosFilePropertyUnixFilePermissions(String imageId)	Provides other managers to the zOS File zosfile.[imageid].unix.file.permission property
IZosBatchJobname	newZosBatchJobname(IZosImage image)	Provides other managers a IZosBatchJobname with a prefix defined by the zOS Batch zosbatch.jobname.[imageid].prefix property
IZosBatchJobname	newZosBatchJobname(String name)	Provides other managers a IZosBatchJobname with a the supplied name
IZosBatchJobOutputSpi	newZosBatchJobOutput(IZosBatchJob batchJob, String name, String jobid)	Create a new batch job output object
IZosBatchJobOutputSpoolFile	newZosBatchJobOutputSpoolFile(IZosBatchJob batchJob, String jobname, String jobid, String stepname, String procstep, String ddname, String id, String records)	Create a new zOS Batch job spool file object
@NotNull IZosImage	provisionImageForTag(@NotNull String tag)	Returns a zOS Image for the specified tag, if necessary provisions it
void	storeArtifact(Path artifactPath, String content, ResultArchiveStoreContentType type)	Store an artifact in the results archive on behalf of another manager

Method Details

provisionImageForTag

@NotNull
@NotNull IZosImage provisionImageForTag(@NotNull
 @NotNull String tag)
                                 throws ZosManagerException

Returns a zOS Image for the specified tag, if necessary provisions it

Parameters:

tag - the tag of the image

Returns:

and image, never null

Throws:

ZosManagerException - if the tag is missing

getImageForTag

@NotNull
@NotNull IZosImage getImageForTag(@NotNull
 @NotNull String tag)
                           throws ZosManagerException

Returns a zOS Image for the specified tag

Parameters:

tag - the tag of the image

Returns:

and image, never null

Throws:

ZosManagerException - if the tag is missing

getImage

@NotNull
@NotNull IZosImage getImage(String imageId)
                     throws ZosManagerException

Returns a zOS Image for the specified image ID

Parameters:

image - the ID of the image

Returns:

the image, never null

Throws:

ZosManagerException

getUnmanagedImage

@NotNull
@NotNull IZosImage getUnmanagedImage(String imageId)
                              throws ZosManagerException

Returns a zOS Image for the specified image that may not have been provisioned so far

Parameters:

image - the ID of the image

Returns:

the image, never null

Throws:

ZosManagerException - if there is no image defined

getRunDatasetHLQ

@NotNull
@NotNull String getRunDatasetHLQ(@NotNull
 @NotNull IZosImage image)
                          throws ZosManagerException

Returns the data set HLQ(s) for temporary data sets for the specified image

Parameters:

the - image

Returns:

the image, never null

Throws:

ZosManagerException

getRunUNIXPathPrefix

@NotNull
@NotNull String getRunUNIXPathPrefix(@NotNull
 @NotNull IZosImage image)
                              throws ZosManagerException

Returns the zOS UNIX path prefix for temporary file for the specified image

Parameters:

the - image

Returns:

the image, never null

Throws:

ZosManagerException

getZosBatchPropertyBatchRestrictToImage

boolean getZosBatchPropertyBatchRestrictToImage(String imageId)
                                         throws ZosBatchManagerException

Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].restrict.to.image property

Parameters:

imageId -

Returns:

Throws:

ZosBatchManagerException

getZosBatchPropertyUseSysaff

boolean getZosBatchPropertyUseSysaff(String imageId)
                              throws ZosBatchManagerException

Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].use.sysaff property

Parameters:

imageId -

Returns:

Throws:

ZosBatchManagerException

getZosBatchPropertyJobWaitTimeout

int getZosBatchPropertyJobWaitTimeout(String imageId)
                               throws ZosBatchManagerException

Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].timeout property

Parameters:

imageId -

Returns:

Throws:

ZosBatchManagerException

getZosBatchPropertyTruncateJCLRecords

boolean getZosBatchPropertyTruncateJCLRecords(String imageId)
                                       throws ZosBatchManagerException

Provides other managers to the zOS Batch zosbatch.batchjob.[imageid].truncate.jcl.records property

Parameters:

imageId -

Returns:

Throws:

ZosBatchManagerException

newZosBatchJobname

IZosBatchJobname newZosBatchJobname(IZosImage image)
                             throws ZosBatchException

Provides other managers a IZosBatchJobname with a prefix defined by the zOS Batch zosbatch.jobname.[imageid].prefix property

Parameters:

imageId -

Returns:

Throws:

ZosBatchException

newZosBatchJobname

IZosBatchJobname newZosBatchJobname(String name)
                             throws ZosBatchException

Provides other managers a IZosBatchJobname with a the supplied name

Parameters:

name -

Returns:

Throws:

ZosBatchException

newZosBatchJobOutput

IZosBatchJobOutputSpi newZosBatchJobOutput(IZosBatchJob batchJob,
 String name,
 String jobid)

Create a new batch job output object

Parameters:

batchJob -

name -

jobid -

Returns:

newZosBatchJobOutputSpoolFile

IZosBatchJobOutputSpoolFile newZosBatchJobOutputSpoolFile(IZosBatchJob batchJob,
 String jobname,
 String jobid,
 String stepname,
 String procstep,
 String ddname,
 String id,
 String records)
                                                   throws ZosBatchException

Create a new zOS Batch job spool file object

Parameters:

batchJob -

jobname -

jobid -

stepname -

procstep -

ddname -

id -

records -

Returns:

Throws:

ZosBatchException

buildUniquePathName

String buildUniquePathName(Path artifactPath,
 String name)

Build a unique results archive artifact name

Parameters:

artifactPath -

name -

Returns:

storeArtifact

void storeArtifact(Path artifactPath,
 String content,
 ResultArchiveStoreContentType type)
            throws ZosManagerException

Store an artifact in the results archive on behalf of another manager

Parameters:

archivePath -

content -

type -

Throws:

ZosManagerException

createArtifactDirectory

void createArtifactDirectory(Path artifactPath)
                      throws ZosManagerException

Create an empty dirictory in the results archive on behalf of another manager

Parameters:

artifactPath -

Throws:

ZosManagerException

getZosFilePropertyDirectoryListMaxItems

int getZosFilePropertyDirectoryListMaxItems(String imageId)
                                     throws ZosFileManagerException

Provides other managers to the zOS File zosfile.unix.[imageid].directory.list.max.items property

Parameters:

imageId -

Returns:

Throws:

ZosFileManagerException

getZosFilePropertyFileRestrictToImage

boolean getZosFilePropertyFileRestrictToImage(String imageId)
                                       throws ZosFileManagerException

Provides other managers to the zOS File zosfile.batchjob.[imageid].restrict.to.image property

Parameters:

imageId -

Returns:

Throws:

ZosFileManagerException

getZosFilePropertyUnixFilePermissions

String getZosFilePropertyUnixFilePermissions(String imageId)
                                      throws ZosFileManagerException

Provides other managers to the zOS File zosfile.[imageid].unix.file.permission property

Parameters:

imageId -

Returns:

Throws:

ZosFileManagerException

getZosConsolePropertyConsoleRestrictToImage

boolean getZosConsolePropertyConsoleRestrictToImage(String imageId)
                                             throws ZosConsoleManagerException

Provides other managers to the zOS Console zosconsole.console.[imageid].restrict.to.image property

Parameters:

imageId -

Returns:

Throws:

ZosConsoleManagerException

getCredentials

ICredentials getCredentials(String credentialsId,
 String imageId)
                     throws ZosManagerException

Returns the credentials on the specified image id

Parameters:

credentialsId -

imageId -

Returns:

Throws:

ZosManagerException

getTaggedPorts

HashMap<String,String> getTaggedPorts()

Returns the provisioned z/OS ports which are tagged with a string value

Returns:

Map of tags to ports