Package dev.galasa.cicsts.cicsresource

Interface IJvmserver

public interface IJvmserver

Represents a CICS JVM server resource. It provides methods to set JVM server specific attributes on the resource (via CEDA) and to manage and set attributes in CEMT. Methods are provided to manage the logs associated with the JVM server.

JVM profile options should be managed via the IJvmprofile JVM profile object

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IJvmserver.JvmserverType
static enum	IJvmserver.PurgeType

Method Summary

Modifier and Type	Method	Description
void	build()	Build the complete JVM server including the profile zOS UNIX file and the CICS resource definition.
void	buildInstallResourceDefinition()	Build and install the CICS JVMSERVER resource definition
void	buildProfile()	Build the JVM server profile zOS UNIX file only
void	buildResourceDefinition()	Build the CICS JVMSERVER resource definition only
void	checkpointLogs()	Save a checkpoint of the current state of the JVM server logs
void	clearJvmLogs()	Delete the JVM server logs
void	delete()	Delete the CICS JVMSERVER resource including it's zOS UNIX files and directories.
void	delete(boolean ignoreErrors)	Delete the CICS JVMSERVER resource including it's zOS UNIX files and directories.
boolean	disable()	Disable the CICS JVMSERVER resource
boolean	disable(IJvmserver.PurgeType purgeType)	Disable the CICS JVMSERVER resource with a specific IJvmserver.PurgeType
boolean	disable(IJvmserver.PurgeType purgeType, int timeout)	Disable the CICS JVMSERVER resource with a specific IJvmserver.PurgeType and specified timeout
void	disableDiscardDelete(boolean ignoreErrors)	Disable and discard the CICS JVMSERVER resource and delete the resource definition.
IJvmserver.PurgeType	disableWithEscalate()	Disable the CICS JVMSERVER resource.
IJvmserver.PurgeType	disableWithEscalate(int stepTimeout)	Disable the CICS JVMSERVER resource.
void	discard()	Discard the CICS JVMSERVER resource.
void	enable()	Enable the CICS JVMSERVER resource
IZosUNIXFile	getJavaHome()	Convenience method that returns the JAVA_HOME as defined in the JVM Profile
List<IZosUNIXFile>	getJavaLogs()	Get a List of Java log files, i.e Snap.*.trc, javacore.*.txt etc.
IJvmserverLog	getJvmLog()	Returns the JVM server JVMLOG
IJvmprofile	getJvmprofile()	Return the JVM profile for this JVM server
IJvmserverLog	getJvmTrace()	Returns the JVM server JVMTRACE
IZosLibertyServer	getLibertyServer()	Returns the zOS Liberty server object associated with this JVM server
String	getName()	Returns the JVM server name as defined in the CICS Resource Definition
String	getResourceDefinitionDescriptionAttribute()	Return the CICS JVMSERVER resource definition DESCRIPTION attribute value
String	getResourceDefinitionGroupAttribute()	Return the CICS JVMSERVER resource definition GROUP attribute value
String	getResourceDefinitionJvmprofileAttribute()	Return the CICS JVMSERVER resource JVMPROFILE attribute value
String	getResourceDefinitionLerunoptsAttribute()	Return the CICS JVMSERVER resource LERUNOPTS attribute value
String	getResourceDefinitionNameAttribute()	Return the CICS JVMSERVER resource definition NAME attribute value
CicsResourceStatus	getResourceDefinitionStatusAttribute()	Return the CICS JVMSERVER resource definition STATUS attribute value
int	getResourceDefinitionThreadlimitAttribute()	Return the CICS JVMSERVER resource THREADLIMIT attribute value
IJvmserverLog	getStdErr()	Returns the JVM server STDERR
IJvmserverLog	getStdOut()	Returns the JVM server STDOUT
int	getThreadCount()	Get the JVMSERVER Threadcount value form CEMT, i.e the number of threads in use
int	getThreadLimit()	Get the JVMSERVER Threadlimit value from CEMT
IZosUNIXFile	getWorkingDirectory()	Convenience method that returns the WORK_DIR as defined in the JVM Profile
void	installResourceDefinition()	Install the CICS JVMSERVER resource definition
boolean	isEnabled()	Returns whether the CICS JVMSERVER resource is currently enabled
boolean	isProfileBuilt()	Checks if the JVM profile has been built
boolean	resourceDefined()	Check if the CICS JVMSERVER resource definition exist via CEDA DISPLAY
boolean	resourceInstalled()	Check if the CICS JVMSERVER resource has been installed via CEMT INQUIRE
void	saveToResultsArchive()	Store the content of the JVM server logs to the default location in the Results Archive Store
void	saveToResultsArchive(String rasPath)	Store the content of the JVM server logs to the Results Archive Store
void	setDefinitionDescriptionAttribute(String value)	Set the CICS JVMSERVER resource definition DESCRIPTION attribute value
void	setDefinitionStatusAttribute(CicsResourceStatus value)	Set the CICS JVMSERVER resource definition STATUS attribute value
void	setLibertyServer(IZosLibertyServer zosLibertyServer)	Sets the zOS Liberty server object associated with this JVM server
void	setResourceDefinitionLerunoptsAttribute(String lerunopts)	Set the CICS JVMSERVER resource LERUNOPTS attribute value
void	setResourceDefinitionThreadlimitAttribute(int threadlimit)	Set the CICS JVMSERVER resource THREADLIMIT attribute value
void	setShouldArchive(boolean shouldArchive)	Set flag to control if the JVM server should be automatically stored to the test output.
void	setShouldCleanup(boolean shouldCleanup)	Set flag to control if the JVM server should be automatically purged from zOS.
void	setThreadLimit(int threadlimit)	Set the JVMSERVER Threadlimit value in CEMT
boolean	shouldArchive()	Return flag that controls if the JVM server should be automatically stored to the test output
boolean	shouldCleanup()	Return flag that controls if the JVM server should be automatically purged from zOS
boolean	waitForDisable()	Wait for the CICS JVMSERVER resource to be disabled.
boolean	waitForDisable(int timeout)	Wait for the CICS JVMSERVER resource to be disabled with specified timeout.
boolean	waitForEnable()	Wait for the CICS JVMSERVER resource to be enabled.
boolean	waitForEnable(int timeout)	Wait for the CICS JVMSERVER resource to be enabled with specified timeout.

Method Details

setDefinitionDescriptionAttribute

void setDefinitionDescriptionAttribute(String value)

Set the CICS JVMSERVER resource definition DESCRIPTION attribute value

Parameters:

value - the resource definition DESCRIPTION attribute value

setDefinitionStatusAttribute

void setDefinitionStatusAttribute(CicsResourceStatus value)

Set the CICS JVMSERVER resource definition STATUS attribute value

Parameters:

value - the resource definition STATUS attribute value

setResourceDefinitionLerunoptsAttribute

void setResourceDefinitionLerunoptsAttribute(String lerunopts)

Set the CICS JVMSERVER resource LERUNOPTS attribute value

Parameters:

lerunopts - the resource LERUNOPTS attribute value

setResourceDefinitionThreadlimitAttribute

void setResourceDefinitionThreadlimitAttribute(int threadlimit)

Set the CICS JVMSERVER resource THREADLIMIT attribute value

Parameters:

threadlimit - the resource THREADLIMIT attribute value

getResourceDefinitionNameAttribute

String getResourceDefinitionNameAttribute()

Return the CICS JVMSERVER resource definition NAME attribute value

Returns:

the resource definition NAME attribute value

getResourceDefinitionGroupAttribute

String getResourceDefinitionGroupAttribute()

Return the CICS JVMSERVER resource definition GROUP attribute value

Returns:

the resource definition GROUP attribute value

getResourceDefinitionDescriptionAttribute

String getResourceDefinitionDescriptionAttribute()

Return the CICS JVMSERVER resource definition DESCRIPTION attribute value

Returns:

the resource definition DESCRIPTION attribute value

getResourceDefinitionStatusAttribute

CicsResourceStatus getResourceDefinitionStatusAttribute()

Return the CICS JVMSERVER resource definition STATUS attribute value

Returns:

the resource definition STATUS attribute value

getResourceDefinitionJvmprofileAttribute

String getResourceDefinitionJvmprofileAttribute()

Return the CICS JVMSERVER resource JVMPROFILE attribute value

Returns:

the resource JVMPROFILE attribute value

getResourceDefinitionLerunoptsAttribute

String getResourceDefinitionLerunoptsAttribute()

Return the CICS JVMSERVER resource LERUNOPTS attribute value

Returns:

the resource LERUNOPTS attribute value

getResourceDefinitionThreadlimitAttribute

int getResourceDefinitionThreadlimitAttribute()

Return the CICS JVMSERVER resource THREADLIMIT attribute value

Returns:

the resource THREADLIMIT attribute value

buildResourceDefinition

void buildResourceDefinition()
                      throws CicsJvmserverResourceException

Build the CICS JVMSERVER resource definition only

Throws:

CicsJvmserverResourceException

buildInstallResourceDefinition

void buildInstallResourceDefinition()
                             throws CicsJvmserverResourceException

Build and install the CICS JVMSERVER resource definition

Throws:

CicsJvmserverResourceException

installResourceDefinition

void installResourceDefinition()
                        throws CicsJvmserverResourceException

Install the CICS JVMSERVER resource definition

Throws:

CicsJvmserverResourceException

resourceDefined

boolean resourceDefined()
                 throws CicsJvmserverResourceException

Check if the CICS JVMSERVER resource definition exist via CEDA DISPLAY

Throws:

CicsJvmserverResourceException

resourceInstalled

boolean resourceInstalled()
                   throws CicsJvmserverResourceException

Check if the CICS JVMSERVER resource has been installed via CEMT INQUIRE

Throws:

CicsJvmserverResourceException

enable

void enable()
     throws CicsJvmserverResourceException

Enable the CICS JVMSERVER resource

Throws:

CicsJvmserverResourceException

waitForEnable

boolean waitForEnable()
               throws CicsJvmserverResourceException

Wait for the CICS JVMSERVER resource to be enabled. Does NOT issue the enable command

Returns:

true if enabled, false if not enabled

Throws:

CicsJvmserverResourceException

waitForEnable

boolean waitForEnable(int timeout)
               throws CicsJvmserverResourceException

Wait for the CICS JVMSERVER resource to be enabled with specified timeout. Does NOT issue the enable command

Parameters:

timeout - timeout in seconds

Returns:

true if enabled, false if not enabled

Throws:

CicsJvmserverResourceException

isEnabled

boolean isEnabled()
           throws CicsJvmserverResourceException

Returns whether the CICS JVMSERVER resource is currently enabled

Returns:

true if enabled, false if not enabled

Throws:

CicsJvmserverResourceException

disable

boolean disable()
         throws CicsJvmserverResourceException

Disable the CICS JVMSERVER resource

Returns:

true if disabled, false if not disabled

Throws:

CicsJvmserverResourceException

disable

boolean disable(IJvmserver.PurgeType purgeType)
         throws CicsJvmserverResourceException

Disable the CICS JVMSERVER resource with a specific IJvmserver.PurgeType

Parameters:

purgeType -

Returns:

true if the resource disables within the time, false otherwise

Throws:

CicsJvmserverResourceException

disable

boolean disable(IJvmserver.PurgeType purgeType,
 int timeout)
         throws CicsJvmserverResourceException

Disable the CICS JVMSERVER resource with a specific IJvmserver.PurgeType and specified timeout

Parameters:

purgeType -

timeout - timeout in seconds

Returns:

true if the resource disables within the time, false otherwise

Throws:

CicsJvmserverResourceException

disableWithEscalate

IJvmserver.PurgeType disableWithEscalate()
                                  throws CicsJvmserverResourceException

Disable the CICS JVMSERVER resource. This method will escalate through all the IJvmserver.PurgeType levels (PHASEOUT, PURGE, FORCEPURGE, KILL) as necessary. If the disable at any level is not successful within the default timeout, escalation will happen

Returns:

the IJvmserver.PurgeType at which the disable was successful

Throws:

CicsJvmserverResourceException

disableWithEscalate

IJvmserver.PurgeType disableWithEscalate(int stepTimeout)
                                  throws CicsJvmserverResourceException

Disable the CICS JVMSERVER resource. This method will escalate through all the IJvmserver.PurgeType levels (PHASEOUT, PURGE, FORCEPURGE, KILL) as necessary. If the disable at any level is not successful within the stepTimeout, escalation will happen

Parameters:

stepTimeout - time in seconds to allow each step to disable before escalating

Returns:

the IJvmserver.PurgeType at which the disable was successful

Throws:

CicsJvmserverResourceException

waitForDisable

boolean waitForDisable()
                throws CicsJvmserverResourceException

Wait for the CICS JVMSERVER resource to be disabled. Does NOT issue the disable command

Returns:

true if disabled, false if not disabled

Throws:

CicsJvmserverResourceException

waitForDisable

boolean waitForDisable(int timeout)
                throws CicsJvmserverResourceException

Wait for the CICS JVMSERVER resource to be disabled with specified timeout. Does NOT issue the disable command

Parameters:

timeout - timeout in seconds

Returns:

true if disabled, false if not disabled

Throws:

CicsJvmserverResourceException

delete

void delete()
     throws CicsJvmserverResourceException

Delete the CICS JVMSERVER resource including it's zOS UNIX files and directories. If the resource is installed, it will be disabled and discarded

Throws:

CicsJvmserverResourceException

delete

void delete(boolean ignoreErrors)
     throws CicsJvmserverResourceException

Delete the CICS JVMSERVER resource including it's zOS UNIX files and directories. If the resource is installed, it will be disabled and discarded. Errors during the process will cause an exception to be thrown depending on the value of ignoreErrors

Parameters:

ignoreErrors -

Throws:

CicsJvmserverResourceException

discard

void discard()
      throws CicsJvmserverResourceException

Discard the CICS JVMSERVER resource. If the resource is enabled, it will be disabled and discarded

Throws:

CicsJvmserverResourceException

disableDiscardDelete

void disableDiscardDelete(boolean ignoreErrors)
                   throws CicsJvmserverResourceException

Disable and discard the CICS JVMSERVER resource and delete the resource definition. Errors during the process will cause an exception to be thrown depending on the value of ignoreErrors

Parameters:

ignoreErrors -

Throws:

CicsJvmserverResourceException

setThreadLimit

void setThreadLimit(int threadlimit)
             throws CicsJvmserverResourceException

Set the JVMSERVER Threadlimit value in CEMT

Parameters:

threadlimit - max number of threads used by the JVM server

Throws:

CicsJvmserverResourceException

getThreadLimit

int getThreadLimit()
            throws CicsJvmserverResourceException

Get the JVMSERVER Threadlimit value from CEMT

Returns:

the Threadlimit value

Throws:

CicsJvmserverResourceException

getThreadCount

int getThreadCount()
            throws CicsJvmserverResourceException

Get the JVMSERVER Threadcount value form CEMT, i.e the number of threads in use

Returns:

the Threadcount value

Throws:

CicsJvmserverResourceException

build

void build()
    throws CicsJvmserverResourceException

Build the complete JVM server including the profile zOS UNIX file and the CICS resource definition. This method will install the CICS resource and wait for it to become enabled

Throws:

CicsJvmserverResourceException

getJvmprofile

IJvmprofile getJvmprofile()

Return the JVM profile for this JVM server

Returns:

the JVM profile object

buildProfile

void buildProfile()
           throws CicsJvmserverResourceException

Build the JVM server profile zOS UNIX file only

Throws:

CicsJvmserverResourceException

isProfileBuilt

boolean isProfileBuilt()

Checks if the JVM profile has been built

Returns:

Boolean

setLibertyServer

void setLibertyServer(IZosLibertyServer zosLibertyServer)

Sets the zOS Liberty server object associated with this JVM server

Parameters:

zosLibertyServer - the IZosLibertyServer object to associate with this JVM server

getLibertyServer

IZosLibertyServer getLibertyServer()

Returns the zOS Liberty server object associated with this JVM server

Returns:

the IZosLibertyServer associated with this JVM server

getName

String getName()

Returns the JVM server name as defined in the CICS Resource Definition

Returns:

the JVM server name

getJavaHome

IZosUNIXFile getJavaHome()
                  throws CicsJvmserverResourceException

Convenience method that returns the JAVA_HOME as defined in the JVM Profile

Returns:

the JAVA_HOME value

Throws:

CicsJvmserverResourceException

getWorkingDirectory

IZosUNIXFile getWorkingDirectory()
                          throws CicsJvmserverResourceException

Convenience method that returns the WORK_DIR as defined in the JVM Profile

Returns:

the WORK_DIR value

Throws:

CicsJvmserverResourceException

getJvmLog

IJvmserverLog getJvmLog()
                 throws CicsJvmserverResourceException

Returns the JVM server JVMLOG

Returns:

JVMLOG IJvmserverLog

Throws:

CicsJvmserverResourceException

getStdOut

IJvmserverLog getStdOut()
                 throws CicsJvmserverResourceException

Returns the JVM server STDOUT

Returns:

STDOUT IJvmserverLog

Throws:

CicsJvmserverResourceException

getStdErr

IJvmserverLog getStdErr()
                 throws CicsJvmserverResourceException

Returns the JVM server STDERR

Returns:

STDERR IJvmserverLog

Throws:

CicsJvmserverResourceException

getJvmTrace

IJvmserverLog getJvmTrace()
                   throws CicsJvmserverResourceException

Returns the JVM server JVMTRACE

Returns:

JVMTRACE IJvmserverLog

Throws:

CicsJvmserverResourceException

checkpointLogs

void checkpointLogs()
             throws CicsJvmserverResourceException

Save a checkpoint of the current state of the JVM server logs

Throws:

CicsJvmserverResourceException

getJavaLogs

List<IZosUNIXFile> getJavaLogs()
                        throws CicsJvmserverResourceException

Get a List of Java log files, i.e Snap.*.trc, javacore.*.txt etc.

Returns:

Throws:

CicsJvmserverResourceException

saveToResultsArchive

void saveToResultsArchive()
                   throws CicsJvmserverResourceException

Store the content of the JVM server logs to the default location in the Results Archive Store

Throws:

CicsJvmserverResourceException

saveToResultsArchive

void saveToResultsArchive(String rasPath)
                   throws CicsJvmserverResourceException

Store the content of the JVM server logs to the Results Archive Store

Parameters:

rasPath - path in Results Archive Store

Throws:

CicsJvmserverResourceException

clearJvmLogs

void clearJvmLogs()
           throws CicsJvmserverResourceException

Delete the JVM server logs

Parameters:

rasPath - path in Results Archive Store

Throws:

CicsJvmserverResourceException

setShouldArchive

void setShouldArchive(boolean shouldArchive)

Set flag to control if the JVM server should be automatically stored to the test output. Defaults to true

shouldArchive

boolean shouldArchive()

Return flag that controls if the JVM server should be automatically stored to the test output

setShouldCleanup

void setShouldCleanup(boolean shouldCleanup)

Set flag to control if the JVM server should be automatically purged from zOS. Defaults to true

shouldCleanup

boolean shouldCleanup()

Return flag that controls if the JVM server should be automatically purged from zOS