MagnoliaConfigurationProperties (Magnolia Core 5.5 API)

All Superinterfaces:

PropertySource

All Known Implementing Classes:

AbstractMagnoliaConfigurationProperties, DefaultMagnoliaConfigurationProperties, InitPhaseMagnoliaConfigurationProperties
```
public interface MagnoliaConfigurationProperties
extends PropertySource
```
MagnoliaConfigurationProperties instances provides access to system-wide configuration properties. They are essentially a wrapper around all the magnolia.properties files that are used in the system, as well as properties configured in module descriptors, etc.
Implementations of this interface are responsible for locating relevant PropertySource, and provide them in a sensible order.
The following properties are required:
- magnolia.cache.startdir:
  directory used for cached pages
- magnolia.upload.tmpdir:
  tmp directory for uploaded files
- magnolia.exchange.history:
  history directory used for activation
- magnolia.repositories.config:
  repositories configuration
- log4j.config:
  Name of a log4j config file. Can be a .properties or .xml file. The value can be:
  - a full path
  - a path relative to the webapp root
  - a file name which will be loaded from the classpath
- magnolia.root.sysproperty:
  Name of a system variable which will be set to the webapp root. You can use this property in log4j configuration files to handle relative paths, such as ${magnolia.root}logs/magnolia-debug.log. Important: if you drop multiple magnolia wars in a container which doesn't isolate system properties (e.g. tomcat) you will need to change the name of the magnolia.root.sysproperty variable in web.xml and in log4j configuration files.
- magnolia.bootstrap.dir:
  Directory containing xml files for initialization of a blank magnolia instance. If no content is found in any of the repository, they are initialized importing xml files found in this folder. If you don't want to let magnolia automatically initialize repositories simply remove this parameter.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MAGNOLIA_APP_ROOTDIR`
`static String`	`MAGNOLIA_BOOTSTRAP_ROOTDIR`
`static String`	`MAGNOLIA_BOOTSTRAP_SAMPLES`
`static String`	`MAGNOLIA_CACHE_STARTDIR`
`static String`	`MAGNOLIA_CONTEXTPATH`
`static String`	`MAGNOLIA_EXCHANGE_HISTORY`
`static String`	`MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG`
`static String`	`MAGNOLIA_REPOSITORIES_CLUSTER_MASTER`
`static String`	`MAGNOLIA_REPOSITORIES_CONFIG`
`static String`	`MAGNOLIA_REPOSITORIES_HOME`
`static String`	`MAGNOLIA_SERVERNAME`
`static String`	`MAGNOLIA_UPLOAD_TMPDIR`
`static String`	`MAGNOLIA_UTF8_ENABLED`
`static String`	`MAGNOLIA_WEBAPP`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method and Description

PropertySource getPropertySource(String key)

void init()
- Methods inherited from interface info.magnolia.init.PropertySource
  describe, getBooleanProperty, getKeys, getProperty, hasProperty

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PropertySource`	`getPropertySource(String key)`
`void`	`init()`

- Field Detail
  - MAGNOLIA_REPOSITORIES_HOME
```
static final String MAGNOLIA_REPOSITORIES_HOME
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_REPOSITORIES_CONFIG
```
static final String MAGNOLIA_REPOSITORIES_CONFIG
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG
```
static final String MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_REPOSITORIES_CLUSTER_MASTER
```
static final String MAGNOLIA_REPOSITORIES_CLUSTER_MASTER
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_EXCHANGE_HISTORY
```
static final String MAGNOLIA_EXCHANGE_HISTORY
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_UPLOAD_TMPDIR
```
static final String MAGNOLIA_UPLOAD_TMPDIR
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_CACHE_STARTDIR
```
static final String MAGNOLIA_CACHE_STARTDIR
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_APP_ROOTDIR
```
static final String MAGNOLIA_APP_ROOTDIR
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_BOOTSTRAP_ROOTDIR
```
static final String MAGNOLIA_BOOTSTRAP_ROOTDIR
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_BOOTSTRAP_SAMPLES
```
static final String MAGNOLIA_BOOTSTRAP_SAMPLES
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_UTF8_ENABLED
```
static final String MAGNOLIA_UTF8_ENABLED
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_WEBAPP
```
static final String MAGNOLIA_WEBAPP
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_SERVERNAME
```
static final String MAGNOLIA_SERVERNAME
```
    See Also:
    
    Constant Field Values
  - MAGNOLIA_CONTEXTPATH
```
static final String MAGNOLIA_CONTEXTPATH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getPropertySource
```
PropertySource getPropertySource(String key)
```
  - init
```
void init()
   throws Exception
```
    Throws:
    
    Exception

Interface MagnoliaConfigurationProperties

Field Summary

Method Summary

Methods inherited from interface info.magnolia.init.PropertySource

Field Detail

MAGNOLIA_REPOSITORIES_HOME

MAGNOLIA_REPOSITORIES_CONFIG

MAGNOLIA_REPOSITORIES_CLUSTER_CONFIG

MAGNOLIA_REPOSITORIES_CLUSTER_MASTER

MAGNOLIA_EXCHANGE_HISTORY

MAGNOLIA_UPLOAD_TMPDIR

MAGNOLIA_CACHE_STARTDIR

MAGNOLIA_APP_ROOTDIR

MAGNOLIA_BOOTSTRAP_ROOTDIR

MAGNOLIA_BOOTSTRAP_SAMPLES

MAGNOLIA_UTF8_ENABLED

MAGNOLIA_WEBAPP

MAGNOLIA_SERVERNAME

MAGNOLIA_CONTEXTPATH

Method Detail

getPropertySource

init