Package org.opencms.ui.apps.git
Class CmsGitConfiguration
java.lang.Object
org.opencms.ui.apps.git.CmsGitConfiguration
Access to a single git configuration file.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the wrapped configuration file.Returns the modules specified in the config file.boolean
Returns a flag, indicating if automatic commit is enabled by default.boolean
Returns a flag, indicating if automatic pulling after the commit is enabled by default.boolean
Returns a flag, indicating if automatic pulling first is enabled by default.boolean
Returns a flag, indicating if automatic pushing is enabled by default.Returns the default commit message.boolean
Returns the default copy-and-unzip flag.boolean
Returns the default exclude libs flag.Returns the configured default git user email, ornull
if the email is by default not adjusted at all.Returns the configured default git user name, ornull
if the name is by default not adjusted at all.boolean
Returns the default ignore-unclean flag.int
Returns the export mode.Returns the path to the config file that is wrapped.Returns the RFS path where module .zip-files are read before check in.Returns the path to where modules are stored in the repository.getName()
Returns the name of the configuration.Returns the path to the home directory of the repository where the modules are checked in.Returns the subfolder where module resources are placed inside the modules main folder in the repository.boolean
isValid()
Returns a flag, indicating if the config file could be read.
-
Method Details
-
getConfigurationFile
Returns the wrapped configuration file.- Returns:
- the wrapped configuration file.
-
getConfiguredModules
Returns the modules specified in the config file.- Returns:
- the modules specified in the config file.
-
getDefaultAutoCommit
Returns a flag, indicating if automatic commit is enabled by default.- Returns:
- a flag, indicating if automatic commit is enabled by default.
-
getDefaultAutoPullAfter
Returns a flag, indicating if automatic pulling after the commit is enabled by default.- Returns:
- a flag, indicating if automatic pulling after the commit is enabled by default.
-
getDefaultAutoPullBefore
Returns a flag, indicating if automatic pulling first is enabled by default.- Returns:
- a flag, indicating if automatic pulling first is enabled by default.
-
getDefaultAutoPush
Returns a flag, indicating if automatic pushing is enabled by default.- Returns:
- a flag, indicating if automatic pushing is enabled by default.
-
getDefaultCommitMessage
Returns the default commit message.- Returns:
- the default commit message.
-
getDefaultCopyAndUnzip
Returns the default copy-and-unzip flag.- Returns:
- the default copy-and-unzip flag.
-
getDefaultExcludeLibs
Returns the default exclude libs flag.- Returns:
- the default exclude libs flag.
-
getDefaultGitUserEmail
Returns the configured default git user email, ornull
if the email is by default not adjusted at all.- Returns:
- the configured default git user email, or
null
if the email is by default not adjusted at all.
-
getDefaultGitUserName
Returns the configured default git user name, ornull
if the name is by default not adjusted at all.- Returns:
- the configured default git user name, or
null
if the name is by default not adjusted at all.
-
getDefaultIngoreUnclean
Returns the default ignore-unclean flag.- Returns:
- the default ignore-unclean flag.
-
getExportMode
Returns the export mode.- Returns:
- the export mode.
-
getFilePath
Returns the path to the config file that is wrapped.- Returns:
- the path to the config file that is wrapped.
-
getModuleExportPath
Returns the RFS path where module .zip-files are read before check in.- Returns:
- the RFS path where module .zip-files are read before check in.
-
getModulesPath
Returns the path to where modules are stored in the repository.- Returns:
- the path to where modules are stored in the repository.
-
getName
Returns the name of the configuration.- Returns:
- the name of the configuration.
-
getRepositoryPath
Returns the path to the home directory of the repository where the modules are checked in.- Returns:
- the path to the home directory of the repository where the modules are checked in.
-
getResourcesSubFolder
Returns the subfolder where module resources are placed inside the modules main folder in the repository.- Returns:
- the subfolder where module resources are placed inside the modules main folder in the repository.
-
isValid
Returns a flag, indicating if the config file could be read.- Returns:
- a flag, indicating if the config file could be read.
-