Package io.openliberty.tools.ant

Class AbstractTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

io.openliberty.tools.ant.AbstractTask

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

CleanTask, DeployTask, FeatureManagerTask, InstallLibertyTask, ServerTask, SpringBootUtilTask, UndeployTask

public abstract class AbstractTask
extends org.apache.tools.ant.Task

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	DEFAULT_LOG_FILE
protected static String	DEFAULT_SERVER
protected File	installDir
protected static boolean	isWindows
protected static ResourceBundle	messages
protected static String	osName
protected File	outputDir
protected ProcessBuilder	processBuilder
protected String	ref
protected File	serverConfigDir
protected String	serverName
protected File	serverOutputDir
protected File	userDir
protected static String	WLP_OUTPUT_DIR_VAR
protected static String	WLP_USER_DIR_VAR

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor	Description
AbstractTask()

Method Summary

Modifier and Type	Method	Description
void	checkReturnCode(Process p, String commandLine, int... expectedExitCodes)
void	checkReturnCodeAndError(Process p, String commandLine, int expectedExitCode, int allowedExitCode, String allowedErrorMessage)
int	countStringOccurrencesInFile(String regexp, File fileToSearch)	Searches the given file for the given regular expression, and returns the number of times it occurs.
String	findStringInFile(String regexp, File fileToSearch)	Searches the given file for the given regular expression.
List<String>	findStringsInFile(String regexp, File fileToSearch)	Searches the given file for the given regular expression.
protected String	getFileName(String fileName)
File	getInstallDir()
File	getLogFile()
protected String	getMessage(String key, Object... args)
File	getOutputDir()
String	getRef()
protected int	getReturnCode(Process p, String commandLine)
String	getServerName()
File	getServerOutputDir()
File	getUserDir()
protected void	initTask()
void	sendErrorInvokeCommand(String commandLine, int returnCode, int... expectedExitCodes)
void	setInstallDir(File installDir)
void	setOutputDir(File outputDir)
void	setRef(String ref)
void	setServerName(String serverName)
void	setUserDir(File userDir)
protected void	stopServer(String timeout)
String	waitForStringInLog(String regexp, long timeout, File outputFile)	Check for a number of strings in a potentially remote file
String	waitForUpdatedStringInLog(String regexp, long timeout, File outputFile, int previousOccurrences)	Wait until the number of occurrences of the regular expression in the file increases above the given number of previous occurrences.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

installDir

protected File installDir

userDir

protected File userDir

outputDir

protected File outputDir

serverConfigDir

protected File serverConfigDir

serverOutputDir

protected File serverOutputDir

serverName

protected String serverName

ref

protected String ref

osName

protected static String osName

isWindows

protected static boolean isWindows

processBuilder

protected ProcessBuilder processBuilder

DEFAULT_SERVER

protected static final String DEFAULT_SERVER

See Also:

Constant Field Values

DEFAULT_LOG_FILE

protected static final String DEFAULT_LOG_FILE

See Also:

Constant Field Values

WLP_USER_DIR_VAR

protected static final String WLP_USER_DIR_VAR

See Also:

Constant Field Values

WLP_OUTPUT_DIR_VAR

protected static final String WLP_OUTPUT_DIR_VAR

See Also:

Constant Field Values

messages

protected static final ResourceBundle messages

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

initTask

protected void initTask()

getInstallDir

public File getInstallDir()

setInstallDir

public void setInstallDir(File installDir)

getUserDir

public File getUserDir()

setUserDir

public void setUserDir(File userDir)

getOutputDir

public File getOutputDir()

setOutputDir

public void setOutputDir(File outputDir)

getServerOutputDir

public File getServerOutputDir()

getServerName

public String getServerName()

Returns:

the serverName

setServerName

public void setServerName(String serverName)

Parameters:

serverName - the serverName to set

getLogFile

public File getLogFile()

getRef

public String getRef()

Returns:

the ref

setRef

public void setRef(String ref)

Parameters:

ref - the ref to set

getReturnCode

protected int getReturnCode(Process p,
                            String commandLine)
                     throws InterruptedException

Throws:

InterruptedException

checkReturnCode

public void checkReturnCode(Process p,
                            String commandLine,
                            int... expectedExitCodes)
                     throws InterruptedException

Throws:

InterruptedException

checkReturnCodeAndError

public void checkReturnCodeAndError(Process p,
                                    String commandLine,
                                    int expectedExitCode,
                                    int allowedExitCode,
                                    String allowedErrorMessage)
                             throws InterruptedException

Throws:

InterruptedException

sendErrorInvokeCommand

public void sendErrorInvokeCommand(String commandLine,
                                   int returnCode,
                                   int... expectedExitCodes)

waitForStringInLog

public String waitForStringInLog(String regexp,
                                 long timeout,
                                 File outputFile)

Check for a number of strings in a potentially remote file

Parameters:

regexp - a regular expression to search for

timeout - a timeout, in milliseconds

outputFile - file to check

Returns:

line that matched the regexp

findStringInFile

public String findStringInFile(String regexp,
                               File fileToSearch)

Searches the given file for the given regular expression.

Parameters:

regexp - a regular expression (or just a text snippet) to search for

fileToSearch - the file to search

Returns:

The first line which includes the pattern, or null if the pattern isn't found or if the file doesn't exist

findStringsInFile

public List<String> findStringsInFile(String regexp,
                                      File fileToSearch)

Searches the given file for the given regular expression.

Parameters:

regexp - a regular expression (or just a text snippet) to search for

fileToSearch - the file to search

Returns:

List of lines which includes the pattern, or null if the pattern isn't found or if the file doesn't exist

countStringOccurrencesInFile

public int countStringOccurrencesInFile(String regexp,
                                        File fileToSearch)

Searches the given file for the given regular expression, and returns the number of times it occurs.

Parameters:

regexp - a regular expression (or just a text snippet) to search for

fileToSearch - the file to search

Returns:

the number of occurrences of the regular expression

waitForUpdatedStringInLog

public String waitForUpdatedStringInLog(String regexp,
                                        long timeout,
                                        File outputFile,
                                        int previousOccurrences)

Wait until the number of occurrences of the regular expression in the file increases above the given number of previous occurrences.

Parameters:

regexp - a regular expression to search for

timeout - a timeout, in milliseconds

outputFile - file to check

previousOccurrences - . the previous number of occurrences of the regular expression

Returns:

updated line that matched the regexp

getFileName

protected String getFileName(String fileName)

stopServer

protected void stopServer(String timeout)

getMessage

protected String getMessage(String key,
                            Object... args)