Package dev.galasa.cicsts.cicsresource

Interface IJvmserverLog

public interface IJvmserverLog

Method Summary

Modifier and Type	Method	Description
long	checkpoint()	Checkpoint this IJvmserverLog
void	delete()	Delete the IZosUNIXFile if it exists.
long	getCheckpoint()	Return the current checkpoint on this IJvmserverLog
String	getName()	Returns the name of the specified log file or DDNAME
IZosBatchJobOutputSpoolFile	getZosBatchJobOutputSpoolFile()	Returns the IZosBatchJobOutputSpoolFile associated with this IJvmserverLog
IZosUNIXFile	getZosUNIXFile()	Returns the IZosUNIXFile associated with this IJvmserverLog
boolean	isZosBatchJobSpoolFile()	Is this JVM server log a IZosBatchJobOutputSpoolFile
boolean	isZosUNIXFile()	Is this JVM server log a IZosUNIXFile
OutputStream	retrieve()	Returns the contents of a specified log
OutputStream	retrieveSinceCheckpoint()	Returns the contents of log since the last checkpoint
void	saveToResultsArchive(String rasPath)	Save the log to the Results Archive Store
String	searchForPattern(Pattern searchPattern)	Searches contents of log for specified search Pattern
String	searchForPattern(Pattern searchPattern, Pattern failPattern)	Searches contents of log for specified search or fail Pattern
String	searchForPatternSinceCheckpoint(Pattern searchPattern)	Searches contents of log for specified search Pattern since the last checkpoint
String	searchForPatternSinceCheckpoint(Pattern searchPattern, Pattern failPattern)	Searches contents of log for specified search or fail Pattern since the last checkpoint
String	searchForText(String searchText)	Searches contents of log for specified search text
String	searchForText(String searchText, String failText)	Searches contents of log for specified search or fail String
String	searchForTextSinceCheckpoint(String searchText)	Searches contents of log for specified search text String since the last checkpoint
String	searchForTextSinceCheckpoint(String searchText, String failText)	Searches contents of log for specified search or fail String since the last checkpoint
String	waitForPattern(Pattern searchPattern, long timeout)	Wait for a search Pattern to appear in specified log.
String	waitForPattern(Pattern searchPattern, Pattern failPattern, long timeout)	Wait for a search or fail Pattern or fail Pattern to appear in specified log.
String	waitForPatternSinceCheckpoint(Pattern searchPattern, long timeout)	Wait for a search Pattern to appear in specified log since the last checkpoint.
String	waitForPatternSinceCheckpoint(Pattern searchPattern, Pattern failPattern, long timeout)	Wait for a search or fail Pattern or fail Pattern to appear in specified log since the last checkpoint.
String	waitForText(String searchText, long timeout)	Wait for a search String to appear in specified log.
String	waitForText(String searchText, String failText, long timeout)	Wait for a search String or fail text to appear in specified log.
String	waitForTextSinceCheckpoint(String searchText, long timeout)	Wait for a search String to appear in specified log since the last checkpoint.
String	waitForTextSinceCheckpoint(String searchText, String failText, long timeout)	Wait for a search or fail String to appear in specified log since the last checkpoint.

Method Details

getName

String getName()
        throws CicsJvmserverResourceException

Returns the name of the specified log file or DDNAME

Returns:

the file or DDNAME name

Throws:

CicsJvmserverResourceException

isZosUNIXFile

boolean isZosUNIXFile()

Is this JVM server log a IZosUNIXFile

Returns:

isZosBatchJobSpoolFile

boolean isZosBatchJobSpoolFile()

Is this JVM server log a IZosBatchJobOutputSpoolFile

Returns:

getZosUNIXFile

IZosUNIXFile getZosUNIXFile()
                     throws CicsJvmserverResourceException

Returns the IZosUNIXFile associated with this IJvmserverLog

Returns:

JVM server log file

Throws:

CicsJvmserverResourceException

getZosBatchJobOutputSpoolFile

IZosBatchJobOutputSpoolFile getZosBatchJobOutputSpoolFile()
                                                   throws CicsJvmserverResourceException

Returns the IZosBatchJobOutputSpoolFile associated with this IJvmserverLog

Returns:

JVM server log spool file

Throws:

CicsJvmserverResourceException

retrieve

OutputStream retrieve()
               throws CicsJvmserverResourceException

Returns the contents of a specified log

Returns:

contents of log

Throws:

CicsJvmserverResourceException

delete

void delete()
     throws CicsJvmserverResourceException

Delete the IZosUNIXFile if it exists.

Throws:

CicsJvmserverResourceException - the log is a IZosBatchJobOutputSpoolFile

saveToResultsArchive

void saveToResultsArchive(String rasPath)
                   throws CicsJvmserverResourceException

Save the log to the Results Archive Store

Parameters:

rasPath -

Throws:

CicsJvmserverResourceException

checkpoint

long checkpoint()
         throws CicsJvmserverResourceException

Checkpoint this IJvmserverLog

Returns:

checkpoint

Throws:

CicsJvmserverResourceException

getCheckpoint

long getCheckpoint()

Return the current checkpoint on this IJvmserverLog

Returns:

checkpoint

retrieveSinceCheckpoint

OutputStream retrieveSinceCheckpoint()
                              throws CicsJvmserverResourceException

Returns the contents of log since the last checkpoint

Returns:

contents of log

Throws:

CicsJvmserverResourceException

searchForText

String searchForText(String searchText)
              throws CicsJvmserverResourceException

Searches contents of log for specified search text

Parameters:

searchText - the text to search

Returns:

true if text found

Throws:

CicsJvmserverResourceException

searchForText

String searchForText(String searchText,
 String failText)
              throws CicsJvmserverResourceException

Searches contents of log for specified search or fail String

Parameters:

searchText - the text to search

Returns:

true if text found

Throws:

CicsJvmserverResourceException

searchForTextSinceCheckpoint

String searchForTextSinceCheckpoint(String searchText)
                             throws CicsJvmserverResourceException

Searches contents of log for specified search text String since the last checkpoint

Parameters:

searchText - the text to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

searchForTextSinceCheckpoint

String searchForTextSinceCheckpoint(String searchText,
 String failText)
                             throws CicsJvmserverResourceException

Searches contents of log for specified search or fail String since the last checkpoint

Parameters:

searchText - the text to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

searchForPattern

String searchForPattern(Pattern searchPattern)
                 throws CicsJvmserverResourceException

Searches contents of log for specified search Pattern

Parameters:

searchPattern - the Pattern to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

searchForPattern

String searchForPattern(Pattern searchPattern,
 Pattern failPattern)
                 throws CicsJvmserverResourceException

Searches contents of log for specified search or fail Pattern

Parameters:

searchPattern - the Pattern to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

searchForPatternSinceCheckpoint

String searchForPatternSinceCheckpoint(Pattern searchPattern)
                                throws CicsJvmserverResourceException

Searches contents of log for specified search Pattern since the last checkpoint

Parameters:

searchPattern - the Pattern to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

searchForPatternSinceCheckpoint

String searchForPatternSinceCheckpoint(Pattern searchPattern,
 Pattern failPattern)
                                throws CicsJvmserverResourceException

Searches contents of log for specified search or fail Pattern since the last checkpoint

Parameters:

searchPattern - the Pattern to search

failPattern - the failure pattern to search

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForText

String waitForText(String searchText,
 long timeout)
            throws CicsJvmserverResourceException

Wait for a search String to appear in specified log. Will check every 3 seconds until one of:

• the searchText is found
• the failText is found
• the specified timeout is reached

Parameters:

searchText - the text to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForText

String waitForText(String searchText,
 String failText,
 long timeout)
            throws CicsJvmserverResourceException

Wait for a search String or fail text to appear in specified log. Will check every 3 seconds until one of:

• the searchText is found
• the failText is found
• the specified timeout is reached

Parameters:

searchText - the text to search

failText - the failure text to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForTextSinceCheckpoint

String waitForTextSinceCheckpoint(String searchText,
 long timeout)
                           throws CicsJvmserverResourceException

Wait for a search String to appear in specified log since the last checkpoint. Will check every 3 seconds until one of:

• the searchText is found
• the failText is found
• the specified timeout is reached

Parameters:

searchText - the text to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForTextSinceCheckpoint

String waitForTextSinceCheckpoint(String searchText,
 String failText,
 long timeout)
                           throws CicsJvmserverResourceException

Wait for a search or fail String to appear in specified log since the last checkpoint. Will check every 3 seconds until one of:

• the searchText is found
• the failText is found
• the specified timeout is reached

Parameters:

searchText - the text to search

failText - the failure text to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForPattern

String waitForPattern(Pattern searchPattern,
 long timeout)
               throws CicsJvmserverResourceException

Wait for a search Pattern to appear in specified log. Will check every 3 seconds until one of:

• the searchPattern is found;
• the failPattern is found;
• the specified timeout is reached.

Parameters:

searchPattern - the Pattern to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForPattern

String waitForPattern(Pattern searchPattern,
 Pattern failPattern,
 long timeout)
               throws CicsJvmserverResourceException

Wait for a search or fail Pattern or fail Pattern to appear in specified log. Will check every 3 seconds until one of:

• the searchPattern is found
• the failPattern is found
• the specified timeout is reached

Parameters:

searchPattern - the Pattern to search

failPattern - the failure pattern to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForPatternSinceCheckpoint

String waitForPatternSinceCheckpoint(Pattern searchPattern,
 long timeout)
                              throws CicsJvmserverResourceException

Wait for a search Pattern to appear in specified log since the last checkpoint. Will check every 3 seconds until one of:

• the searchPattern is found
• the failPattern is found
• the specified timeout is reached

Parameters:

searchPattern - the Pattern to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException

waitForPatternSinceCheckpoint

String waitForPatternSinceCheckpoint(Pattern searchPattern,
 Pattern failPattern,
 long timeout)
                              throws CicsJvmserverResourceException

Wait for a search or fail Pattern or fail Pattern to appear in specified log since the last checkpoint. Will check every 3 seconds until one of:

• the searchPattern is found
• the failPattern is found
• the specified timeout is reached

Parameters:

searchPattern - the Pattern to search

failPattern - the failure pattern to search

timeout - timeout in seconds

Returns:

the string found or null

Throws:

CicsJvmserverResourceException