CmsGitConfiguration (OpenCms Core API, version 11.0.0)

java.lang.Object
- org.opencms.ui.apps.git.CmsGitConfiguration

public class CmsGitConfiguration
extends java.lang.Object

Access to a single git configuration file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.File`	`getConfigurationFile()` Returns the wrapped configuration file.
`java.util.Collection<java.lang.String>`	`getConfiguredModules()` Returns the modules specified in the config file.
`boolean`	`getDefaultAutoCommit()` Returns a flag, indicating if automatic commit is enabled by default.
`boolean`	`getDefaultAutoPullAfter()` Returns a flag, indicating if automatic pulling after the commit is enabled by default.
`boolean`	`getDefaultAutoPullBefore()` Returns a flag, indicating if automatic pulling first is enabled by default.
`boolean`	`getDefaultAutoPush()` Returns a flag, indicating if automatic pushing is enabled by default.
`java.lang.String`	`getDefaultCommitMessage()` Returns the default commit message.
`boolean`	`getDefaultCopyAndUnzip()` Returns the default copy-and-unzip flag.
`boolean`	`getDefaultExcludeLibs()` Returns the default exclude libs flag.
`java.lang.String`	`getDefaultGitUserEmail()` Returns the configured default git user email, or `null` if the email is by default not adjusted at all.
`java.lang.String`	`getDefaultGitUserName()` Returns the configured default git user name, or `null` if the name is by default not adjusted at all.
`boolean`	`getDefaultIngoreUnclean()` Returns the default ignore-unclean flag.
`int`	`getExportMode()` Returns the export mode.
`java.lang.String`	`getFilePath()` Returns the path to the config file that is wrapped.
`java.lang.String`	`getModuleExportPath()` Returns the RFS path where module .zip-files are read before check in.
`java.lang.String`	`getModulesPath()` Returns the path to where modules are stored in the repository.
`java.lang.String`	`getName()` Returns the name of the configuration.
`java.lang.String`	`getRepositoryPath()` Returns the path to the home directory of the repository where the modules are checked in.
`java.lang.String`	`getResourcesSubFolder()` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getConfigurationFile
```
public java.io.File getConfigurationFile()
```
    Returns the wrapped configuration file.
    
    Returns:
    
    the wrapped configuration file.
  - getConfiguredModules
```
public java.util.Collection<java.lang.String> getConfiguredModules()
```
    Returns the modules specified in the config file.
    
    Returns:
    
    the modules specified in the config file.
  - getDefaultAutoCommit
```
public boolean getDefaultAutoCommit()
```
    Returns a flag, indicating if automatic commit is enabled by default.
    
    Returns:
    
    a flag, indicating if automatic commit is enabled by default.
  - getDefaultAutoPullAfter
```
public boolean 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
```
public boolean 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
```
public boolean getDefaultAutoPush()
```
    Returns a flag, indicating if automatic pushing is enabled by default.
    
    Returns:
    
    a flag, indicating if automatic pushing is enabled by default.
  - getDefaultCommitMessage
```
public java.lang.String getDefaultCommitMessage()
```
    Returns the default commit message.
    
    Returns:
    
    the default commit message.
  - getDefaultCopyAndUnzip
```
public boolean getDefaultCopyAndUnzip()
```
    Returns the default copy-and-unzip flag.
    
    Returns:
    
    the default copy-and-unzip flag.
  - getDefaultExcludeLibs
```
public boolean getDefaultExcludeLibs()
```
    Returns the default exclude libs flag.
    
    Returns:
    
    the default exclude libs flag.
  - getDefaultGitUserEmail
```
public java.lang.String getDefaultGitUserEmail()
```
    Returns the configured default git user email, or null 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
```
public java.lang.String getDefaultGitUserName()
```
    Returns the configured default git user name, or null 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
```
public boolean getDefaultIngoreUnclean()
```
    Returns the default ignore-unclean flag.
    
    Returns:
    
    the default ignore-unclean flag.
  - getExportMode
```
public int getExportMode()
```
    Returns the export mode.
    
    Returns:
    
    the export mode.
  - getFilePath
```
public java.lang.String getFilePath()
```
    Returns the path to the config file that is wrapped.
    
    Returns:
    
    the path to the config file that is wrapped.
  - getModuleExportPath
```
public java.lang.String 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
```
public java.lang.String getModulesPath()
```
    Returns the path to where modules are stored in the repository.
    
    Returns:
    
    the path to where modules are stored in the repository.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the configuration.
    
    Returns:
    
    the name of the configuration.
  - getRepositoryPath
```
public java.lang.String 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
```
public java.lang.String 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
```
public boolean isValid()
```
    Returns a flag, indicating if the config file could be read.
    
    Returns:
    
    a flag, indicating if the config file could be read.

Class CmsGitConfiguration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getConfigurationFile

getConfiguredModules

getDefaultAutoCommit

getDefaultAutoPullAfter

getDefaultAutoPullBefore

getDefaultAutoPush

getDefaultCommitMessage

getDefaultCopyAndUnzip

getDefaultExcludeLibs

getDefaultGitUserEmail

getDefaultGitUserName

getDefaultIngoreUnclean

getExportMode

getFilePath

getModuleExportPath

getModulesPath

getName

getRepositoryPath

getResourcesSubFolder

isValid