|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationService
Core platform service that provides access to file-system based configuration information. System registry configuration should be loaded through the RegistryDbLoader.
Method Summary | |
---|---|
void |
addCustomProperties(java.lang.String configName,
java.io.File customConfigFile,
boolean mustExist)
Provision for implementations of ApplicationLauncher
to provide non-relative locations for client manipulated configuration properties. |
void |
configServiceInit(java.io.File blackboardRootDir,
java.util.Properties bbServicesProps)
configServiceInit |
java.io.File |
createTempFile()
Creates a temp file in the Bb temp file space. |
java.util.Properties |
getBbProperties()
Returns aggregate of bb-config.properties and properties from active service manager config. |
java.lang.String |
getBbProperty(java.lang.String key)
Shortcut to return an individual property from bb-config.properties or from this service manager's config file. |
java.lang.String |
getBbProperty(java.lang.String key,
java.lang.String defaultIfNotFound)
Shortcut to return an individual property from bb-config.properties or from this service manager's config file. |
java.io.File |
getBbServicesDir()
Deprecated. |
java.io.File |
getBlackboardDir()
Returns the directory in which the Blackboard application is installed. |
java.io.File |
getConfiguredFile(java.lang.String propertyName,
boolean mustExist)
Utility for service implementations to get a file path from the configured properties. |
java.io.File[] |
getConfiguredFiles(java.lang.String propertyName,
boolean mustExist)
Utility for service implementations to get a file list from the configured properties. |
java.util.Properties |
getCustomProperties(java.lang.String configName,
boolean mustExist)
Provision for implementations of ApplicationLauncher
to provide non-relative locations for client manipulated configuration properties. |
java.io.File |
getLocaleDir()
Returns the base directory in which locale packs are installed. |
java.io.File |
getSharedContentDir()
Returns the directory in which shared content is kept |
java.io.File |
getTempDir()
getTempDir |
java.io.File |
resolveFile(java.lang.String relativePath)
Resolves the specified file. |
java.io.File |
resolveFile(java.lang.String relativePath,
boolean bMustExist)
Resolves the specified file. |
Method Detail |
---|
void configServiceInit(java.io.File blackboardRootDir, java.util.Properties bbServicesProps) throws InitializationException
InitializationException
java.util.Properties getBbProperties()
java.lang.String getBbProperty(java.lang.String key)
java.lang.String getBbProperty(java.lang.String key, java.lang.String defaultIfNotFound)
java.io.File getBlackboardDir()
java.io.File getSharedContentDir()
java.io.File getLocaleDir()
java.io.File resolveFile(java.lang.String relativePath) throws InitializationException
InitializationException
- if file does not existjava.io.File resolveFile(java.lang.String relativePath, boolean bMustExist) throws InitializationException
InitializationException
- if file does not existjava.io.File getBbServicesDir()
java.io.File getTempDir()
java.io.File createTempFile() throws java.io.IOException
java.io.IOException
java.io.File getConfiguredFile(java.lang.String propertyName, boolean mustExist) throws InitializationException
InitializationException
- if the property is not found in the
config file or if the requested file does not exist when required
(mustExist == true
).java.io.File[] getConfiguredFiles(java.lang.String propertyName, boolean mustExist) throws InitializationException
InitializationException
- if the property is not found in the
config file or if the requested file does not exist when required
(mustExist == true
).void addCustomProperties(java.lang.String configName, java.io.File customConfigFile, boolean mustExist) throws InitializationException
ApplicationLauncher
to provide non-relative locations for client manipulated configuration properties.
configName
- String designating unique to identify custom property
collection.customConfigFile
- File
designation for location of property
file.mustExist
- boolean>
flag denoting if proper loading of
file is required.
InitializationException
- if the requested file does not exist when
required (mustExist == true
).java.util.Properties getCustomProperties(java.lang.String configName, boolean mustExist) throws InitializationException
ApplicationLauncher
to provide non-relative locations for client manipulated configuration properties.
configName
- String designating unique to identify custom property
collection.mustExist
- boolean
flag denoting if proper loading of file
is required.
Properties
Custom properties relevant to Application
implementation.
InitializationException
- if the requested property designation does
not exist when required (mustExist == true
).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |