Package dev.galasa.cicsts

Interface ICicsRegion

All Known Subinterfaces:

ICicsRegionProvisioned

All Known Implementing Classes:

BaseCicsImpl

public interface ICicsRegion

Method Summary

Modifier and Type	Method	Description
void	alterSit(@NotNull String sitParam, String sitValue)	This method allows a SIT parameter to be altered, but only if the provisioning tool allows it.
ICeci	ceci()
ICeda	ceda()
ICemt	cemt()
ICicsResource	cicsResource()	Provides a CICS resource instance that can then be used to create a specific CICS resource
String	getApplid()	Retrieve the CICS TS Region applid
String	getJavaHome()
String	getJvmProfileDir()
MasType	getMasType()	Describes the type of CICS region
IZosBatchJob	getRegionJob()	Return the CICS region IZosBatchJob
default String	getRegionProperty(String propertyName)	Allows a testcase to get a specific property about the region.
IZosUNIXFile	getRunTemporaryUNIXDirectory()
String	getSysid()	Retrieve the CICS TS Region sysid
String	getTag()	Retrieve the CICS TS Region tag
String	getUssHome()
ProductVersion	getVersion()	Retrieve the CICS TS Region version
IZosImage	getZosImage()	Retrieve the zOS Image the CICS TS region resides on
boolean	isProvisionStart()
void	removeSit(@NotNull String sitParam)	This method removes a SIT parameter from CICS runtime JCL provided the provisioning tool allows.
void	shutdown()
void	startup()

Method Details

getTag

String getTag()

Retrieve the CICS TS Region tag

Returns:

the tag of the CICS TS Region

getApplid

String getApplid()

Retrieve the CICS TS Region applid

Returns:

the applid of the CICS TS Region

Throws:

CicstsManagerException - If the applid is not available

getSysid

String getSysid()

Retrieve the CICS TS Region sysid

Returns:

the sysid of the CICS TS Region

Throws:

CicstsManagerException - If the applid is not available

getVersion

ProductVersion getVersion()
                   throws CicstsManagerException

Retrieve the CICS TS Region version

Returns:

the version of the CICS TS Region

Throws:

CicstsManagerException - If the version is not available

getZosImage

IZosImage getZosImage()

Retrieve the zOS Image the CICS TS region resides on

Returns:

the zOS Image the CICS TS region resides on

getMasType

MasType getMasType()

Describes the type of CICS region

Returns:

The type of CICS Region

cemt

ICemt cemt()
    throws CicstsManagerException

Throws:

CicstsManagerException

ceda

ICeda ceda()
    throws CicstsManagerException

Throws:

CicstsManagerException

ceci

ICeci ceci()
    throws CicstsManagerException

Throws:

CicstsManagerException

cicsResource

ICicsResource cicsResource()
                    throws CicstsManagerException

Provides a CICS resource instance that can then be used to create a specific CICS resource

Returns:

a ICicsResource instance associated with this CICS region

Throws:

CicstsManagerException

startup

void startup()
      throws CicstsManagerException

Throws:

CicstsManagerException

shutdown

void shutdown()
       throws CicstsManagerException

Throws:

CicstsManagerException

isProvisionStart

boolean isProvisionStart()

getUssHome

String getUssHome()
           throws CicstsManagerException

Throws:

CicstsManagerException

getJvmProfileDir

String getJvmProfileDir()
                 throws CicstsManagerException

Throws:

CicstsManagerException

getJavaHome

String getJavaHome()
            throws CicstsManagerException

Throws:

CicstsManagerException

getRegionJob

IZosBatchJob getRegionJob()
                   throws CicstsManagerException

Return the CICS region IZosBatchJob

Returns:

the CICS region job

Throws:

CicstsManagerException

getRunTemporaryUNIXDirectory

IZosUNIXFile getRunTemporaryUNIXDirectory()
                                   throws CicstsManagerException

Returns:

the Run Temporary UNIX Directory for this CICS Region

Throws:

CicstsManagerException

alterSit

void alterSit(@NotNull
 @NotNull String sitParam,
 String sitValue)
       throws CicstsManagerException

This method allows a SIT parameter to be altered, but only if the provisioning tool allows it. The CICS TS Region must be down before this method is called.

Parameters:

sitParam - - The SIT parameter to alter

sitValue - - The value to set, null = delete parameter

Throws:

CicstsManagerException - - If the provisioning tool does not allow SIT modification or the CICS Regions is still up

removeSit

void removeSit(@NotNull
 @NotNull String sitParam)
        throws CicstsManagerException

This method removes a SIT parameter from CICS runtime JCL provided the provisioning tool allows. The CICS TS Region must be down before this method is called.

Parameters:

sitParam -

Throws:

CicstsManagerException

getRegionProperty

default String getRegionProperty(String propertyName)
                          throws CicstsManagerException

Allows a testcase to get a specific property about the region. The list of properties supported will depend upon how the region was deployed/provisioned. By default, no properties are supported, but each implementation of this interface is free to provide tests with whatever values they wish to reflect this particular CICS region.

Parameters:

propertyName - The name of the property for which the caller wishes to get a value.

Returns:

A string value for the requested property, or null if that property value is not available.

Throws:

CicstsManagerException