grails.util
[Groovy] Class BuildSettings

java.lang.Object
  grails.util.AbstractBuildSettings
      grails.util.BuildSettings

class BuildSettings
extends AbstractBuildSettings

Represents the project paths and other build settings that the user can change when running the Grails commands. Defaults are provided for all settings, but the user can override those by setting the appropriate system property or specifying a value for it in the BuildConfig.groovy file.

Warning The behaviour is poorly defined if you explicitly set some of the project paths (such as BuildSettings.projectWorkDir), but not others. If you set one of them explicitly, set all of them to ensure consistent behaviour.

APP_BASE_DIR

public static final java.lang.String APP_BASE_DIR

The base directory of the application

BUILD_LISTENERS

public static final java.lang.String BUILD_LISTENERS

The name of the system property for multiple buildListeners.

COMPILER_SOURCE_LEVEL

public static final java.lang.String COMPILER_SOURCE_LEVEL

The compiler source level to use

COMPILER_TARGET_LEVEL

public static final java.lang.String COMPILER_TARGET_LEVEL

The compiler source level to use

CONVERT_CLOSURES_KEY

public static final java.lang.String CONVERT_CLOSURES_KEY

A property name to enable/disable AST conversion of closures actions&tags to methods

CORE_WORKING_DIR_NAME

public static final java.lang.String CORE_WORKING_DIR_NAME

The name of the working directory for commands that don't belong to a project (like create-app)

FUNCTIONAL_BASE_URL_PROPERTY

public static final java.lang.String FUNCTIONAL_BASE_URL_PROPERTY

A system property with this name is populated in the preparation phase of functional testing with the base URL that tests should be run against.

GLOBAL_PLUGINS_DIR

public static final java.lang.String GLOBAL_PLUGINS_DIR

The name of the system property for globalPluginsDir.

LOG_SCRIPT_TIMING_KEY

public static final java.lang.String LOG_SCRIPT_TIMING_KEY

Property name to enable/disable script event time logging.

OFFLINE_MODE

public static final java.lang.String OFFLINE_MODE

PLUGINS_DIR

public static final java.lang.String PLUGINS_DIR

The name of the system property for projectPluginsDir.

PROJECT_AUTODEPLOY_DIR

public static final java.lang.String PROJECT_AUTODEPLOY_DIR

The name of the WAR file of the project

PROJECT_CLASSES_DIR

public static final java.lang.String PROJECT_CLASSES_DIR

The name of the system property for classesDir.

PROJECT_DOCS_OUTPUT_DIR

public static final java.lang.String PROJECT_DOCS_OUTPUT_DIR

The name of the system property for docsOutputDir.

PROJECT_PLUGIN_BUILD_CLASSES_DIR

public static final java.lang.String PROJECT_PLUGIN_BUILD_CLASSES_DIR

The name of the system property for pluginBuildClassesDir.

PROJECT_PLUGIN_CLASSES_DIR

public static final java.lang.String PROJECT_PLUGIN_CLASSES_DIR

The name of the system property for pluginClassesDir.

PROJECT_PLUGIN_PROVIDED_CLASSES_DIR

public static final java.lang.String PROJECT_PLUGIN_PROVIDED_CLASSES_DIR

The name of the system property for pluginProvidedClassesDir.

PROJECT_RESOURCES_DIR

public static final java.lang.String PROJECT_RESOURCES_DIR

The name of the system property for .

PROJECT_SOURCE_DIR

public static final java.lang.String PROJECT_SOURCE_DIR

The name of the system property for sourceDir.

PROJECT_TARGET_DIR

public static final java.lang.String PROJECT_TARGET_DIR

The name of the system property for projectTargetDir.

PROJECT_TEST_CLASSES_DIR

public static final java.lang.String PROJECT_TEST_CLASSES_DIR

The name of the system property for testClassesDir.

PROJECT_TEST_REPORTS_DIR

public static final java.lang.String PROJECT_TEST_REPORTS_DIR

The name of the system property for testReportsDir.

PROJECT_TEST_SOURCE_DIR

public static final java.lang.String PROJECT_TEST_SOURCE_DIR

The name of the system property for testSourceDir.

PROJECT_WAR_EXPLODED_DIR

public static final java.lang.String PROJECT_WAR_EXPLODED_DIR

The name of the system property for projectWarExplodedDir.

PROJECT_WAR_FILE

public static final java.lang.String PROJECT_WAR_FILE

The name of the WAR file of the project

PROJECT_WAR_OSGI_HEADERS

public static final java.lang.String PROJECT_WAR_OSGI_HEADERS

The name of the system property for enabling osgi headers in the WAR Manifest

PROJECT_WEB_XML_FILE

public static final java.lang.String PROJECT_WEB_XML_FILE

The name of the system property for BuildSettings.webXmlLocation.

PROJECT_WORK_DIR

public static final java.lang.String PROJECT_WORK_DIR

The name of the system property for projectWorkDir.

SERVLET_VERSION

public static final java.lang.String SERVLET_VERSION

The version of the servlet API

VERBOSE_COMPILE

public static final java.lang.String VERBOSE_COMPILE

The name of the system property for enabling verbose compilation verboseCompile.

WORK_DIR

public static final java.lang.String WORK_DIR

The name of the system property for grailsWorkDir.

settingsFileLoaded

protected boolean settingsFileLoaded

JAR_PATTERN

static final java.util.regex.Pattern JAR_PATTERN

allDependenciesReport

@Lazy
org.apache.ivy.core.report.ResolveReport allDependenciesReport

The dependency report for all configurations

applicationJars

java.util.List applicationJars

List of jars provided in the applications 'lib' directory

autodeployDir

java.io.File autodeployDir

Directory where additional war files to be autodeployed are located

baseDir

java.io.File baseDir

The base directory for the build, which is normally the root directory of the current project. If a command is run outside of a project, then this will be the current working directory that the command was launched from.

buildListeners

java.util.List buildListeners

buildResolveReport

org.apache.ivy.core.report.ResolveReport buildResolveReport

classesDir

java.io.File classesDir

The location to which Grails compiles a project's classes.

compileResolveReport

org.apache.ivy.core.report.ResolveReport compileResolveReport

compilerSourceLevel

java.lang.String compilerSourceLevel

The compiler source level to use

compilerTargetLevel

java.lang.String compilerTargetLevel

The compiler target level to use

convertClosuresArtefacts

boolean convertClosuresArtefacts

coreDependencies

GrailsCoreDependencies coreDependencies

defaultBuildDependencies

@Lazy
java.util.List defaultBuildDependencies

defaultCompileDependencies

@Lazy
java.util.List defaultCompileDependencies

defaultEnv

boolean defaultEnv

true if the default environment for a script should be used.

defaultPluginMap

java.util.Map defaultPluginMap

A Set of plugin names and versions that represent the default set of plugins installed when creating Grails applications

defaultPluginSet

java.util.Set defaultPluginSet

A Set of plugin names that represent the default set of plugins installed when creating Grails applications

defaultProvidedDependencies

@Lazy
java.util.List defaultProvidedDependencies

defaultRuntimeDependencies

@Lazy
java.util.List defaultRuntimeDependencies

defaultTestDependencies

@Lazy
java.util.List defaultTestDependencies

dependenciesExternallyConfigured

boolean dependenciesExternallyConfigured

Whether the project required build dependencies are externally configured (by Maven for example) or not

dependencyManager

IvyDependencyManager dependencyManager

Manages dependencies and dependency resolution in a Grails application

docsOutputDir

java.io.File docsOutputDir

The location of the documentation output.

enableResolve

boolean enableResolve

Whether to enable resolving dependencies

forkSettings

java.util.Map forkSettings

Fork Settings. These are the default settings used to control forked mode, and what

grailsEnv

java.lang.String grailsEnv

The environment for the current script.

grailsHome

java.io.File grailsHome

Location of the Grails distribution as usually identified by the GRAILS_HOME environment variable. This value may be null if GRAILS_HOME is not set, for example if a project uses the Grails JAR files directly.

grailsVersion

java.lang.String grailsVersion

The version of Grails being used for the current script.

grailsWorkDir

java.io.File grailsWorkDir

The location of the Grails working directory where non-project-specific temporary files are stored.

includeJavadoc

boolean includeJavadoc

whether to include javadoc attachments in a resolve

includeSource

boolean includeSource

whether to include source attachments in a resolve

logScriptTiming

boolean logScriptTiming

modified

boolean modified

Return whether the BuildConfig has been modified

offline

boolean offline

Whether the build is allowed to connect to remote servers to resolve dependencies

pluginBuildClassesDir

java.io.File pluginBuildClassesDir

The location to which Grails compiles build scoped plugins classes.

pluginClassesDir

java.io.File pluginClassesDir

The location to which Grails compiles a project's plugin classes. Plugin classes that are compile or runtime scoped will be compiled to this directory

pluginDependencies

java.util.List pluginDependencies

pluginProvidedClassesDir

java.io.File pluginProvidedClassesDir

The location to which Grails compiles provided scoped plugins classes.

projectTargetDir

java.io.File projectTargetDir

The location of the project target directory where reports, artifacts and so on are output.

projectWarExplodedDir

java.io.File projectWarExplodedDir

The location of the Grails WAR directory where exploded WAR is built.

projectWarFile

java.io.File projectWarFile

The WAR file of the project

projectWarOsgiHeaders

boolean projectWarOsgiHeaders

Setting for whether or not to enable OSGI headers in the WAR Manifest, can be overridden via -verboseCompile(=[true|false])?

projectWorkDir

java.io.File projectWorkDir

The location of the project working directory for project-specific temporary files.

providedResolveReport

org.apache.ivy.core.report.ResolveReport providedResolveReport

proxySettings

groovy.util.ConfigObject proxySettings

The settings used to establish the HTTP proxy to use for dependency resolution etc.

proxySettingsFile

java.io.File proxySettingsFile

The file containing the proxy settings

resourcesDir

java.io.File resourcesDir

The location where Grails keeps temporary copies of a project's resources.

rootLoader

java.net.URLClassLoader rootLoader

The root loader for the build. This has the required libraries on the classpath.

runtimeResolveReport

org.apache.ivy.core.report.ResolveReport runtimeResolveReport

servletVersion

java.lang.String servletVersion

The version of the servlet API used

sourceDir

java.io.File sourceDir

The location of the plain source.

testClassesDir

java.io.File testClassesDir

The location to which Grails compiles a project's test classes and any test scoped plugin classes.

testReportsDir

java.io.File testReportsDir

The location of the test reports.

testResolveReport

org.apache.ivy.core.report.ResolveReport testResolveReport

testSourceDir

java.io.File testSourceDir

The location of the test source.

userHome

java.io.File userHome

Location of the current user's home directory - equivalent to "user.home" system property.

verboseCompile

boolean verboseCompile

Setting for whether or not to enable verbose compilation, can be overridden via -verboseCompile(=[true|false])?

webXmlLocation

java.io.File webXmlLocation

Location of the generated web.xml file

BuildSettings

BuildSettings()

BuildSettings

BuildSettings(java.io.File grailsHome)

BuildSettings

BuildSettings(java.io.File grailsHome, java.io.File baseDir)

configureDependencyManager

java.lang.Object configureDependencyManager(groovy.util.ConfigObject config)

copyDirectoryContentsToTarget

@CompileStatic
protected void copyDirectoryContentsToTarget(java.io.File dir, java.lang.String targetPath)

createConfigSlurper

groovy.util.ConfigSlurper createConfigSlurper()

getBaseDir

java.io.File getBaseDir()

Returns the current base directory of this project.

getBasePluginDescriptor

java.io.File getBasePluginDescriptor()

getBuildDependencies

@CompileStatic
java.util.List getBuildDependencies()

List containing the runtime dependencies of the app as File instances.

getBuildListeners

java.lang.Object[] getBuildListeners()

getClassesDir

java.io.File getClassesDir()

getCompileDependencies

@CompileStatic
java.util.List getCompileDependencies()

List containing the compile-time dependencies of the app as File instances.

getConvertClosuresArtefacts

boolean getConvertClosuresArtefacts()

getFunctionalTestBaseUrl

java.lang.String getFunctionalTestBaseUrl()

getGrailsScriptClosure

groovy.lang.Closure getGrailsScriptClosure()

Implementation of the "grailsScript()" method used in Grails scripts.

getGrailsWorkDir

java.io.File getGrailsWorkDir()

getPluginBuildClassesDir

java.io.File getPluginBuildClassesDir()

getPluginBuildDependencies

@CompileStatic
java.util.List getPluginBuildDependencies()

Obtains a list of source plugins that are build time dependencies

Returns:

A list of the source zips

getPluginClassesDir

java.io.File getPluginClassesDir()

getPluginCompileDependencies

@CompileStatic
java.util.List getPluginCompileDependencies()

Obtains a list of source plugins that are provided time dependencies

Returns:

A list of the source zips

getPluginProvidedClassesDir

java.io.File getPluginProvidedClassesDir()

getPluginProvidedDependencies

@CompileStatic
java.util.List getPluginProvidedDependencies()

Obtains a list of source plugins that are provided time dependencies

Returns:

A list of the source zips

getPluginRuntimeDependencies

@CompileStatic
java.util.List getPluginRuntimeDependencies()

Obtains a list of source plugins that are runtime time dependencies

Returns:

A list of the source zips

getPluginTestDependencies

@CompileStatic
java.util.List getPluginTestDependencies()

Obtains a list of source plugins that are test time dependencies

Returns:

A list of the source zips

getProjectTargetDir

java.io.File getProjectTargetDir()

getProjectWarExplodedDir

java.io.File getProjectWarExplodedDir()

getProjectWarFile

java.io.File getProjectWarFile()

getProjectWarOsgiHeaders

boolean getProjectWarOsgiHeaders()

getProjectWorkDir

java.io.File getProjectWorkDir()

getProvidedDependencies

@CompileStatic
java.util.List getProvidedDependencies()

List containing the runtime dependencies of the app as File instances.

getResourcesDir

java.io.File getResourcesDir()

getRuntimeDependencies

@CompileStatic
java.util.List getRuntimeDependencies()

List containing the runtime dependencies of the app as File instances.

getSourceDir

java.io.File getSourceDir()

getTestClassesDir

java.io.File getTestClassesDir()

getTestDependencies

@CompileStatic
java.util.List getTestDependencies()

List containing the test-time dependencies of the app as File instances.

getTestReportsDir

java.io.File getTestReportsDir()

getTestSourceDir

java.io.File getTestSourceDir()

getWebXmlLocation

java.io.File getWebXmlLocation()

initializeResourcesDir

@CompileStatic
void initializeResourcesDir()

isPluginProject

boolean isPluginProject()

isRegisteredInMetadata

boolean isRegisteredInMetadata(java.lang.String pluginName)

loadBuildPropertiesFromClasspath

@CompileStatic
protected java.lang.Object loadBuildPropertiesFromClasspath(java.util.Properties buildProps)

loadConfig

groovy.util.ConfigObject loadConfig()

Loads the application's BuildSettings.groovy file if it exists and returns the corresponding config object. If the file does not exist, this returns an empty config.

loadConfig

@CompileStatic
groovy.util.ConfigObject loadConfig(java.io.File configFile)

Loads the given configuration file if it exists and returns the corresponding config object. If the file does not exist, this returns an empty config.

loadConfig

@CompileStatic
groovy.util.ConfigObject loadConfig(groovy.util.ConfigObject config)

loadSettingsFile

@CompileStatic
protected groovy.util.ConfigObject loadSettingsFile()

makeAbsolute

protected java.io.File makeAbsolute(java.io.File dir)

notDefinedInBuildConfig

boolean notDefinedInBuildConfig(java.lang.String pluginName)

obtainGroovyClassLoader

groovy.lang.GroovyClassLoader obtainGroovyClassLoader()

parseGrailsBuildListeners

protected void parseGrailsBuildListeners()

pluginDependencyHandler

groovy.lang.Closure pluginDependencyHandler()

pluginDependencyHandler

groovy.lang.Closure pluginDependencyHandler(IvyDependencyManager dependencyManager)

postLoadConfig

protected void postLoadConfig()

setBaseDir

@CompileStatic
void setBaseDir(java.io.File newBaseDir)

Changes the base directory, making sure that everything that depends on it gets refreshed too. If you have have previously loaded a configuration file, you should load it again after calling this method.

Warning This method resets the project paths, so if they have been set manually by the caller, then that information will be lost!

setBuildDependencies

@CompileStatic
void setBuildDependencies(java.util.List deps)

Sets the runtime dependencies for the project

setBuildListeners

void setBuildListeners(java.lang.Object buildListeners)

setClassesDir

void setClassesDir(java.io.File dir)

setCompileDependencies

@CompileStatic
void setCompileDependencies(java.util.List deps)

Sets the compile time dependencies for the project

setConvertClosuresArtefacts

void setConvertClosuresArtefacts(boolean convert)

setGrailsWorkDir

void setGrailsWorkDir(java.io.File dir)

setLogScriptTiming

void setLogScriptTiming(boolean b)

setPluginBuildClassesDir

void setPluginBuildClassesDir(java.io.File dir)

setPluginClassesDir

void setPluginClassesDir(java.io.File dir)

setPluginProvidedClassesDir

void setPluginProvidedClassesDir(java.io.File dir)

setProjectTargetDir

void setProjectTargetDir(java.io.File dir)

setProjectWarExplodedDir

void setProjectWarExplodedDir(java.io.File dir)

setProjectWarFile

void setProjectWarFile(java.io.File file)

setProjectWarOsgiHeaders

void setProjectWarOsgiHeaders(boolean flag)

setProjectWorkDir

void setProjectWorkDir(java.io.File dir)

setProvidedDependencies

@CompileStatic
void setProvidedDependencies(java.util.List deps)

Sets the runtime dependencies for the project

setResourcesDir

void setResourcesDir(java.io.File dir)

setRuntimeDependencies

@CompileStatic
void setRuntimeDependencies(java.util.List deps)

Sets the runtime dependencies for the project

setSourceDir

void setSourceDir(java.io.File dir)

setTestClassesDir

void setTestClassesDir(java.io.File dir)

setTestDependencies

@CompileStatic
void setTestDependencies(java.util.List deps)

Sets the test time dependencies for the project

setTestReportsDir

void setTestReportsDir(java.io.File dir)

setTestSourceDir

void setTestSourceDir(java.io.File dir)

setVerboseCompile

void setVerboseCompile(boolean flag)

setWebXmlLocation

void setWebXmlLocation(java.io.File location)

shouldResolve

protected boolean shouldResolve()

storeDependencyCache

@CompileStatic
void storeDependencyCache()

Groovy Documentation