ScmConfiguration (SCM-Manager API Reference (1.59))

java.lang.Object
- sonia.scm.config.ScmConfiguration

All Implemented Interfaces:

ListenerSupport<ConfigChangedListener<ScmConfiguration>>
```
public class ScmConfiguration
extends Object
implements ListenerSupport<ConfigChangedListener<ScmConfiguration>>
```
The main configuration object for SCM-Manager. This class is a singleton and is available via injection.

Author:

Sebastian Sdorra

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DATEFORMAT` Default JavaScript date format
`static String`	`DEFAULT_PLUGINURL` Default plugin url
`static String`	`OLD_PLUGINURL` Default plugin url from version 1.0
`static String`	`PATH` Path to the configuration file

Constructor Summary

Constructors
Constructor and Description

ScmConfiguration()

Constructors
Constructor and Description
`ScmConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addListener(ConfigChangedListener<ScmConfiguration> listener)` Register a `ConfigChangedListener`
`void`	`addListeners(Collection<ConfigChangedListener<ScmConfiguration>> listeners)` Register a `Collection` of `ConfigChangedListener`
`void`	`fireChangeEvent()` Calls the `ConfigChangedListener.configChanged(Object)` method of all registered listeners.
`Set<String>`	`getAdminGroups()` Returns a set of admin group names.
`Set<String>`	`getAdminUsers()` Returns a set of admin user names.
`String`	`getBaseUrl()` Returns the complete base url of the scm-manager including the context path.
`String`	`getDateFormat()` Returns the date format for the user interface.
`int`	`getForwardPort()` Deprecated. use `getBaseUrl()`
`int`	`getLoginAttemptLimit()` Returns maximum allowed login attempts.
`long`	`getLoginAttemptLimitTimeout()` Returns the timeout in seconds for users which are temporary disabled, because of too many failed login attempts.
`String`	`getPluginUrl()` Returns the url of the plugin repository.
`Set<String>`	`getProxyExcludes()` Returns a set of glob patterns for urls which should excluded from proxy settings.
`String`	`getProxyPassword()` Method description
`int`	`getProxyPort()` Returns the proxy port.
`String`	`getProxyServer()` Returns the servername or ip of the proxyserver.
`String`	`getProxyUser()` Method description
`String`	`getRealmDescription()` Returns the realm description.
`String`	`getServername()` Deprecated. use `getBaseUrl()`
`int`	`getSslPort()` Deprecated. use `getBaseUrl()` and `isForceBaseUrl()`
`boolean`	`isAnonymousAccessEnabled()` Returns true if the anonymous access to the SCM-Manager is enabled.
`boolean`	`isDisableGroupingGrid()` Method description
`boolean`	`isEnabledXsrfProtection()` Returns `true` if the cookie xsrf protection is enabled.
`boolean`	`isEnablePortForward()` Deprecated. use `getBaseUrl()`
`boolean`	`isEnableProxy()` Returns true if proxy is enabled.
`boolean`	`isEnableRepositoryArchive()` Returns true if the repository archive is enabled.
`boolean`	`isEnableSSL()` Deprecated. use `getBaseUrl()` and `isForceBaseUrl()`
`boolean`	`isForceBaseUrl()` Returns true if force base url is enabled.
`boolean`	`isLoginAttemptLimitEnabled()` Returns true if the login attempt limit is enabled.
`boolean`	`isSkipFailedAuthenticators()` Returns true if failed authenticators are skipped.
`void`	`load(ScmConfiguration other)` Load all properties from another `ScmConfiguration` object.
`void`	`removeListener(ConfigChangedListener listener)` Unregister a listener object.
`void`	`setAdminGroups(Set<String> adminGroups)` Method description
`void`	`setAdminUsers(Set<String> adminUsers)` Method description
`void`	`setAnonymousAccessEnabled(boolean anonymousAccessEnabled)` Method description
`void`	`setBaseUrl(String baseUrl)` Method description
`void`	`setDateFormat(String dateFormat)` Sets the date format for the ui.
`void`	`setDisableGroupingGrid(boolean disableGroupingGrid)` Method description
`void`	`setEnabledXsrfProtection(boolean enabledXsrfProtection)` Set `true` to enable xsrf cookie protection.
`void`	`setEnablePortForward(boolean enablePortForward)` Deprecated. use `setBaseUrl(String)`
`void`	`setEnableProxy(boolean enableProxy)` Method description
`void`	`setEnableRepositoryArchive(boolean enableRepositoryArchive)` Enable or disable the repository archive.
`void`	`setEnableSSL(boolean enableSSL)` Deprecated. use `setBaseUrl(String)` and {$link #setForceBaseUrl(boolean)}
`void`	`setForceBaseUrl(boolean forceBaseUrl)` Method description
`void`	`setForwardPort(int forwardPort)` Deprecated. use `setBaseUrl(String)`
`void`	`setLoginAttemptLimit(int loginAttemptLimit)` Set maximum allowed login attempts.
`void`	`setLoginAttemptLimitTimeout(long loginAttemptLimitTimeout)` Sets the timeout in seconds for users which are temporary disabled, because of too many failed login attempts.
`void`	`setPluginUrl(String pluginUrl)` Method description
`void`	`setProxyExcludes(Set<String> proxyExcludes)` Set glob patterns for urls which are should be excluded from proxy settings.
`void`	`setProxyPassword(String proxyPassword)` Method description
`void`	`setProxyPort(int proxyPort)` Method description
`void`	`setProxyServer(String proxyServer)` Method description
`void`	`setProxyUser(String proxyUser)` Method description
`void`	`setRealmDescription(String realmDescription)` Sets the realm description.
`void`	`setServername(String servername)` Deprecated. use `setBaseUrl(String)`
`void`	`setSkipFailedAuthenticators(boolean skipFailedAuthenticators)` If set to true the authentication chain is not stopped, if an authenticator finds the user but fails to authenticate the user.
`void`	`setSslPort(int sslPort)` Deprecated. use `setBaseUrl(String)` and `setForceBaseUrl(boolean)`

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

- Field Detail
  - DEFAULT_DATEFORMAT
```
public static final String DEFAULT_DATEFORMAT
```
    Default JavaScript date format
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PLUGINURL
```
public static final String DEFAULT_PLUGINURL
```
    Default plugin url
    
    See Also:
    
    Constant Field Values
  - OLD_PLUGINURL
```
public static final String OLD_PLUGINURL
```
    Default plugin url from version 1.0
    
    See Also:
    
    Constant Field Values
  - PATH
```
public static final String PATH
```
    Path to the configuration file
- Constructor Detail
  - ScmConfiguration
```
public ScmConfiguration()
```
- Method Detail
  - addListener
```
public void addListener(ConfigChangedListener<ScmConfiguration> listener)
```
    Register a ConfigChangedListener
    
    Specified by:
    
    addListener in interface ListenerSupport<ConfigChangedListener<ScmConfiguration>>
    
    Parameters:
    
    listener -
  - addListeners
```
public void addListeners(Collection<ConfigChangedListener<ScmConfiguration>> listeners)
```
    Register a Collection of ConfigChangedListener
    
    Specified by:
    
    addListeners in interface ListenerSupport<ConfigChangedListener<ScmConfiguration>>
    
    Parameters:
    
    listeners -
  - fireChangeEvent
```
public void fireChangeEvent()
```
    Calls the ConfigChangedListener.configChanged(Object) method of all registered listeners.
  - load
```
public void load(ScmConfiguration other)
```
    Load all properties from another ScmConfiguration object.
    
    Parameters:
    
    other -
  - removeListener
```
public void removeListener(ConfigChangedListener listener)
```
    Unregister a listener object.
    
    Specified by:
    
    removeListener in interface ListenerSupport<ConfigChangedListener<ScmConfiguration>>
    
    Parameters:
    
    listener -
  - getAdminGroups
```
public Set<String> getAdminGroups()
```
    Returns a set of admin group names.
    
    Returns:
    
    set of admin group names
  - getAdminUsers
```
public Set<String> getAdminUsers()
```
    Returns a set of admin user names.
    
    Returns:
    
    set of admin user names
  - getBaseUrl
```
public String getBaseUrl()
```
    Returns the complete base url of the scm-manager including the context path. For example http://localhost:8080/scm
    
    Returns:
    
    complete base url of the scm-manager
    
    Since:
    
    1.5
  - getDateFormat
```
public String getDateFormat()
```
    Returns the date format for the user interface. This format is a JavaScript date format, from the library moment.js.
    
    Returns:
    
    moment.js date format
    
    See Also:
    
    http://momentjs.com/docs/#/parsing/
  - getForwardPort
```
@Deprecated
public int getForwardPort()
```
    Deprecated. use getBaseUrl()
    
    Returns the forwarding port.
    
    Returns:
    
    forwarding port
  - getLoginAttemptLimit
```
public int getLoginAttemptLimit()
```
    Returns maximum allowed login attempts.
    
    Returns:
    
    maximum allowed login attempts
    
    Since:
    
    1.34
  - getLoginAttemptLimitTimeout
```
public long getLoginAttemptLimitTimeout()
```
    Returns the timeout in seconds for users which are temporary disabled, because of too many failed login attempts.
    
    Returns:
    
    login attempt timeout in seconds
    
    Since:
    
    1.34
  - getPluginUrl
```
public String getPluginUrl()
```
    Returns the url of the plugin repository. This url can contain placeholders. Explanation of the {placeholders}:
    - version = SCM-Manager Version
    - os = Operation System
    - arch = Architecture
    For example http://plugins.scm-manager.org/scm-plugin-backend/api/{version}/plugins?os={os}&arch={arch}&snapshot=false
    Returns:
    
    the complete plugin url.
  - getProxyExcludes
```
public Set<String> getProxyExcludes()
```
    Returns a set of glob patterns for urls which should excluded from proxy settings.
    
    Returns:
    
    set of glob patterns
    
    Since:
    
    1.23
  - getProxyPassword
```
public String getProxyPassword()
```
    Method description
    
    Returns:
    
    Since:
    
    1.7
  - getProxyPort
```
public int getProxyPort()
```
    Returns the proxy port.
    
    Returns:
    
    proxy port
  - getProxyServer
```
public String getProxyServer()
```
    Returns the servername or ip of the proxyserver.
    
    Returns:
    
    servername or ip of the proxyserver
  - getProxyUser
```
public String getProxyUser()
```
    Method description
    
    Returns:
    
    Since:
    
    1.7
  - getRealmDescription
```
public String getRealmDescription()
```
    Returns the realm description.
    
    Returns:
    
    realm description
    
    Since:
    
    1.36
  - getServername
```
public String getServername()
```
    Deprecated. use getBaseUrl()
    
    Returns the servername of the SCM-Manager host.
    
    Returns:
    
    servername of the SCM-Manager host
  - getSslPort
```
@Deprecated
public int getSslPort()
```
    Deprecated. use getBaseUrl() and isForceBaseUrl()
    
    Returns the ssl port.
    
    Returns:
    
    ssl port
  - isAnonymousAccessEnabled
```
public boolean isAnonymousAccessEnabled()
```
    Returns true if the anonymous access to the SCM-Manager is enabled.
    
    Returns:
    
    true if the anonymous access to the SCM-Manager is enabled
  - isDisableGroupingGrid
```
public boolean isDisableGroupingGrid()
```
    Method description
    
    Returns:
    
    Since:
    
    1.9
  - isEnabledXsrfProtection
```
public boolean isEnabledXsrfProtection()
```
    Returns true if the cookie xsrf protection is enabled.
    
    Returns:
    
    true if the cookie xsrf protection is enabled
    
    Since:
    
    1.47
    
    See Also:
    
    Issue 793
  - isEnablePortForward
```
@Deprecated
public boolean isEnablePortForward()
```
    Deprecated. use getBaseUrl()
    
    Returns true if port forwarding is enabled.
    
    Returns:
    
    true if port forwarding is enabled
  - isEnableProxy
```
public boolean isEnableProxy()
```
    Returns true if proxy is enabled.
    
    Returns:
    
    true if proxy is enabled
  - isEnableRepositoryArchive
```
public boolean isEnableRepositoryArchive()
```
    Returns true if the repository archive is enabled.
    
    Returns:
    
    true if the repository archive is enabled
    
    Since:
    
    1.14
  - isEnableSSL
```
@Deprecated
public boolean isEnableSSL()
```
    Deprecated. use getBaseUrl() and isForceBaseUrl()
    
    Returns true if ssl is enabled.
    
    Returns:
    
    true if ssl is enabled
  - isForceBaseUrl
```
public boolean isForceBaseUrl()
```
    Returns true if force base url is enabled.
    
    Returns:
    
    true if force base url is enabled
    
    Since:
    
    1.5
  - isLoginAttemptLimitEnabled
```
public boolean isLoginAttemptLimitEnabled()
```
    Returns true if the login attempt limit is enabled.
    
    Returns:
    
    true if login attempt limit is enabled
    
    Since:
    
    1.37
  - isSkipFailedAuthenticators
```
public boolean isSkipFailedAuthenticators()
```
    Returns true if failed authenticators are skipped.
    
    Returns:
    
    true if failed authenticators are skipped
    
    Since:
    
    1.36
  - setAdminGroups
```
public void setAdminGroups(Set<String> adminGroups)
```
    Method description
    
    Parameters:
    
    adminGroups -
  - setAdminUsers
```
public void setAdminUsers(Set<String> adminUsers)
```
    Method description
    
    Parameters:
    
    adminUsers -
  - setAnonymousAccessEnabled
```
public void setAnonymousAccessEnabled(boolean anonymousAccessEnabled)
```
    Method description
    
    Parameters:
    
    anonymousAccessEnabled -
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    Method description
    
    Parameters:
    
    baseUrl -
    
    Since:
    
    1.5
  - setDateFormat
```
public void setDateFormat(String dateFormat)
```
    Sets the date format for the ui.
    
    Parameters:
    
    dateFormat - date format for ui
  - setDisableGroupingGrid
```
public void setDisableGroupingGrid(boolean disableGroupingGrid)
```
    Method description
    
    Parameters:
    
    disableGroupingGrid -
    
    Since:
    
    1.9
  - setEnablePortForward
```
@Deprecated
public void setEnablePortForward(boolean enablePortForward)
```
    Deprecated. use setBaseUrl(String)
    
    Method description
    
    Parameters:
    
    enablePortForward -
  - setEnableProxy
```
public void setEnableProxy(boolean enableProxy)
```
    Method description
    
    Parameters:
    
    enableProxy -
  - setEnableRepositoryArchive
```
public void setEnableRepositoryArchive(boolean enableRepositoryArchive)
```
    Enable or disable the repository archive. Default is disabled.
    
    Parameters:
    
    enableRepositoryArchive - true to disable the repository archive
    
    Since:
    
    1.14
  - setEnableSSL
```
@Deprecated
public void setEnableSSL(boolean enableSSL)
```
    Deprecated. use setBaseUrl(String) and {$link #setForceBaseUrl(boolean)}
    
    Method description
    
    Parameters:
    
    enableSSL -
  - setForceBaseUrl
```
public void setForceBaseUrl(boolean forceBaseUrl)
```
    Method description
    
    Parameters:
    
    forceBaseUrl -
    
    Since:
    
    1.5
  - setForwardPort
```
@Deprecated
public void setForwardPort(int forwardPort)
```
    Deprecated. use setBaseUrl(String)
    
    Method description
    
    Parameters:
    
    forwardPort -
  - setLoginAttemptLimit
```
public void setLoginAttemptLimit(int loginAttemptLimit)
```
    Set maximum allowed login attempts.
    
    Parameters:
    
    loginAttemptLimit - login attempt limit
    
    Since:
    
    1.34
  - setLoginAttemptLimitTimeout
```
public void setLoginAttemptLimitTimeout(long loginAttemptLimitTimeout)
```
    Sets the timeout in seconds for users which are temporary disabled, because of too many failed login attempts.
    
    Parameters:
    
    loginAttemptLimitTimeout - login attempt timeout in seconds
    
    Since:
    
    1.34
  - setPluginUrl
```
public void setPluginUrl(String pluginUrl)
```
    Method description
    
    Parameters:
    
    pluginUrl -
  - setProxyExcludes
```
public void setProxyExcludes(Set<String> proxyExcludes)
```
    Set glob patterns for urls which are should be excluded from proxy settings.
    
    Parameters:
    
    proxyExcludes - glob patterns
    
    Since:
    
    1.23
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Method description
    
    Parameters:
    
    proxyPassword -
    
    Since:
    
    1.7
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    Method description
    
    Parameters:
    
    proxyPort -
  - setProxyServer
```
public void setProxyServer(String proxyServer)
```
    Method description
    
    Parameters:
    
    proxyServer -
  - setProxyUser
```
public void setProxyUser(String proxyUser)
```
    Method description
    
    Parameters:
    
    proxyUser -
    
    Since:
    
    1.7
  - setRealmDescription
```
public void setRealmDescription(String realmDescription)
```
    Sets the realm description.
    
    Parameters:
    
    realmDescription -
    
    Since:
    
    1.36
  - setServername
```
public void setServername(String servername)
```
    Deprecated. use setBaseUrl(String)
    
    Method description
    
    Parameters:
    
    servername -
  - setSkipFailedAuthenticators
```
public void setSkipFailedAuthenticators(boolean skipFailedAuthenticators)
```
    If set to true the authentication chain is not stopped, if an authenticator finds the user but fails to authenticate the user.
    
    Parameters:
    
    skipFailedAuthenticators - true to skip failed authenticators
    
    Since:
    
    1.36
  - setSslPort
```
@Deprecated
public void setSslPort(int sslPort)
```
    Deprecated. use setBaseUrl(String) and setForceBaseUrl(boolean)
    
    Method description
    
    Parameters:
    
    sslPort -
  - setEnabledXsrfProtection
```
public void setEnabledXsrfProtection(boolean enabledXsrfProtection)
```
    Set true to enable xsrf cookie protection.
    
    Parameters:
    
    enabledXsrfProtection - true to enable xsrf protection
    
    Since:
    
    1.47
    
    See Also:
    
    Issue 793

Class ScmConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DATEFORMAT

DEFAULT_PLUGINURL

OLD_PLUGINURL

PATH

Constructor Detail

ScmConfiguration

Method Detail

addListener

addListeners

fireChangeEvent

load

removeListener

getAdminGroups

getAdminUsers

getBaseUrl

getDateFormat

getForwardPort

getLoginAttemptLimit

getLoginAttemptLimitTimeout

getPluginUrl

getProxyExcludes

getProxyPassword

getProxyPort

getProxyServer

getProxyUser

getRealmDescription

getServername

getSslPort

isAnonymousAccessEnabled

isDisableGroupingGrid

isEnabledXsrfProtection

isEnablePortForward

isEnableProxy

isEnableRepositoryArchive

isEnableSSL

isForceBaseUrl

isLoginAttemptLimitEnabled

isSkipFailedAuthenticators

setAdminGroups

setAdminUsers

setAnonymousAccessEnabled

setBaseUrl

setDateFormat

setDisableGroupingGrid

setEnablePortForward

setEnableProxy

setEnableRepositoryArchive

setEnableSSL

setForceBaseUrl

setForwardPort

setLoginAttemptLimit

setLoginAttemptLimitTimeout

setPluginUrl

setProxyExcludes

setProxyPassword

setProxyPort

setProxyServer

setProxyUser

setRealmDescription

setServername

setSkipFailedAuthenticators

setSslPort

setEnabledXsrfProtection