com.redhat.thermostat.shared.config

Interface CommonPaths

@Service
public interface CommonPaths

Contains locations to various files and directories used by thermostat components.

Some configuration files or directories are system-wide while others are per-user. System-wide file or directories are indicated by the word System in the name. These should contain non-mutable data that is meant to be used by all instances of thermostat running on one machine. Per-user directories will normally contain configuration and data specific for a different instance of thermostat. Per-user files and directories indicated by the word "User" in the method name.

The directories are split according to functionality, along the lines of Filesystem Hierarchy Standard (FHS).

Method Summary

Modifier and Type	Method and Description
File	getSystemAgentAuthConfigFile()
File	getSystemAgentConfigurationFile()
File	getSystemBinRoot()
File	getSystemConfigurationDirectory()
File	getSystemLibRoot()
File	getSystemNativeLibsRoot()
File	getSystemPluginConfigurationDirectory()
File	getSystemPluginRoot()
File	getSystemStorageConfigurationFile()
File	getSystemThermostatHome()
File	getUserAgentAuthConfigFile()
File	getUserAgentConfigurationFile()
File	getUserCacheDirectory()
File	getUserClientConfigurationFile()
File	getUserConfigurationDirectory()
File	getUserHistoryFile()
File	getUserLogDirectory()
File	getUserPersistentDataDirectory() A location that contains data that is persisted
File	getUserPluginConfigurationDirectory()
File	getUserPluginRoot()
File	getUserRuntimeDataDirectory() Contains data that is only useful for the duration that thermostat is running
File	getUserSetupCompleteStampFile() A file indicating that Thermostat commands are ready to be run
File	getUserStorageConfigurationFile()
File	getUserStorageDirectory()
File	getUserStorageLogFile()
File	getUserStoragePidFile()
File	getUserThermostatHome()

Method Detail

getSystemThermostatHome

File getSystemThermostatHome()
                      throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserThermostatHome

File getUserThermostatHome()
                    throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemPluginRoot

File getSystemPluginRoot()
                  throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemLibRoot

File getSystemLibRoot()
               throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemBinRoot

File getSystemBinRoot()
               throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemNativeLibsRoot

File getSystemNativeLibsRoot()
                      throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemConfigurationDirectory

File getSystemConfigurationDirectory()
                              throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemPluginConfigurationDirectory

File getSystemPluginConfigurationDirectory()
                                    throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserPluginConfigurationDirectory

File getUserPluginConfigurationDirectory()
                                  throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserConfigurationDirectory

File getUserConfigurationDirectory()
                            throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserSetupCompleteStampFile

File getUserSetupCompleteStampFile()
                            throws InvalidConfigurationException

A file indicating that Thermostat commands are ready to be run

Throws:

InvalidConfigurationException

getUserPersistentDataDirectory

File getUserPersistentDataDirectory()
                             throws InvalidConfigurationException

A location that contains data that is persisted

Throws:

InvalidConfigurationException

getUserRuntimeDataDirectory

File getUserRuntimeDataDirectory()
                          throws InvalidConfigurationException

Contains data that is only useful for the duration that thermostat is running

Throws:

InvalidConfigurationException

getUserLogDirectory

File getUserLogDirectory()
                  throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserCacheDirectory

File getUserCacheDirectory()
                    throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserPluginRoot

File getUserPluginRoot()
                throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserStorageDirectory

File getUserStorageDirectory()
                      throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemStorageConfigurationFile

File getSystemStorageConfigurationFile()
                                throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserStorageConfigurationFile

File getUserStorageConfigurationFile()
                              throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserStorageLogFile

File getUserStorageLogFile()
                    throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserStoragePidFile

File getUserStoragePidFile()
                    throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemAgentConfigurationFile

File getSystemAgentConfigurationFile()
                              throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserAgentConfigurationFile

File getUserAgentConfigurationFile()
                            throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getSystemAgentAuthConfigFile

File getSystemAgentAuthConfigFile()
                           throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserAgentAuthConfigFile

File getUserAgentAuthConfigFile()
                         throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserClientConfigurationFile

File getUserClientConfigurationFile()
                             throws InvalidConfigurationException

Throws:

InvalidConfigurationException

getUserHistoryFile

File getUserHistoryFile()
                 throws InvalidConfigurationException

Throws:

InvalidConfigurationException