com.tts.gradle.plugin.tasks

Class CommonTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.tts.gradle.plugin.tasks.CommonTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

Direct Known Subclasses:

Deploy, InstallLocal, InstallSdk, Restart, Start, Stop, TestTask

public class CommonTask
extends org.gradle.api.DefaultTask

This class represents the most commonly used Task with attributes. Standard mandatory attributes are normally:

 Required
                -a, --account   Subaccount name
                Type: string (up to 30 characters; lowercase letters and numbers, starting with a letter)
                -b, --application       Application name
                Type: string (up to 30 characters; lowercase letters and numbers, starting with a letter)
                -h, --host      Enter a region host.
                Type: URL, for acceptable values see Regions.
                -p, --password  To protect your password, enter it only when prompted by the console client and not explicitly as a parameter in the properties file or the command line.
                Type: string
                -u, --user      Use your email, SAP ID or user name
                Type: string
 

So this class takes care of building the basic commandline runner and verifying it. This class is meant to be subclassed for further task specific attributes/actions

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
CommonTask()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	baseCommandlineArguments(java.lang.String command) Builds the default arguments for the neo cli.
protected void	cliRunner(java.util.List<java.lang.String> commands)
protected NeoJavaWebExtension	getExtension()
protected java.lang.String	getNeoExecutable()
protected boolean	isSdkInstalled() Tests if the neo sdk is installed

Methods inherited from class org.gradle.api.DefaultTask

newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonTask

public CommonTask()

Method Detail

baseCommandlineArguments

protected java.util.List<java.lang.String> baseCommandlineArguments(java.lang.String command)
                                                             throws java.lang.Throwable

Builds the default arguments for the neo cli. It add either neo.sh or neo.bat at the beginning depending on OS Further more we check if the neccesary prerequisits are fullfilled e.g. neo sdk is installed

Parameters:

command - the command to be inserted see CommandsAndParams

Returns:

the default cli arguments

Throws:

java.lang.Throwable - if a mandatory property is missing

isSdkInstalled

protected boolean isSdkInstalled()
                          throws java.lang.Throwable

Tests if the neo sdk is installed

Returns:

true if sdkLocation exists, is a directory and isn't empty

Throws:

java.lang.Throwable - if no neo sdk is found

getExtension

protected NeoJavaWebExtension getExtension()

getNeoExecutable

protected java.lang.String getNeoExecutable()
                                     throws java.lang.Throwable

Throws:

java.lang.Throwable

cliRunner

protected void cliRunner(java.util.List<java.lang.String> commands)