Package de.elo.ix.client.webapp
Interface AppConfig
- All Known Implementing Classes:
AppConfigImpl
public interface AppConfig
This class provides access to the configuration properties of the web application. Furthermore it
defines functions to read, write and delete user profile options.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
deleteUserProfile
(IXConnection ix, String keyFilter) Delete the profile options that match the given key filter.Encrypt or decrypt a string.Get the property names of standard properties.Get the configuration directory.Get the logging levelde.elo.utils.PropertiesEx
Get the configuration properties.de.elo.utils.PropertiesEx
readUserProfile
(IXConnection ix, String keyFilter) Read the profile options that match the given key filter.readUserProfileValue
(IXConnection ix, String key) Reads one value from the profile options.void
setLogLevel
(String level) Set the logging levelvoid
writeUserProfile
(IXConnection ix, Properties props) Write the given profile options.void
writeUserProfileValue
(IXConnection ix, String key, String value) Write one option into the profile.
-
Method Details
-
getAppPropertyNames
AppPropertyNames getAppPropertyNames()Get the property names of standard properties. Modify the returned object, if the application uses different property names.- Returns:
- AppPropertyNames object
-
encrypt
Encrypt or decrypt a string. This function can be used to encrypt or decrypt passwords in configuration files. It uses the encryption algorithm DES. Although DES is a strong encryption algorithm, the enrypted passwords should be kept a secret. This is because the encryption key is contained in the code and could be reverse engineered. Do not use this function to encrypt document files.- Parameters:
value
- String to be encrpyted or decrypted.encryptNotDecrypt
- true, if this function should encrpty- Returns:
- encrypted or decrypted value
-
getProperties
de.elo.utils.PropertiesEx getProperties()Get the configuration properties. The passwords are internally decrypted.- Returns:
- Properties object
-
getConfigDirectory
File getConfigDirectory()Get the configuration directory.- Returns:
- E. g. d:\ELOprofessional\config\ix-elo\
-
readUserProfile
de.elo.utils.PropertiesEx readUserProfile(IXConnection ix, String keyFilter) throws byps.RemoteException Read the profile options that match the given key filter. Only the wildcard * is allowed in the parameter keyFilter. If keyFilter is null or empty, all profile options are read.- Parameters:
ix
- Indexserver connectionkeyFilter
- filter, e.g. "Elo.search.*" or ""- Returns:
- Properties object
- Throws:
byps.RemoteException
- See Also:
-
readUserProfileValue
Reads one value from the profile options.- Parameters:
ix
- Indexserver connectionkey
- option key- Returns:
- option value
- Throws:
byps.RemoteException
-
writeUserProfile
Write the given profile options.- Parameters:
ix
- Indexserver connectionsprops
- Properties object- Throws:
byps.RemoteException
- See Also:
-
writeUserProfileValue
Write one option into the profile.- Parameters:
ix
- Indexserver connectionkey
- option keyvalue
- option value- Throws:
byps.RemoteException
-
deleteUserProfile
Delete the profile options that match the given key filter.- Parameters:
ix
- Indexserver connectionkeyFilter
- filter, e.g. "Elo.search.*" or ""- Throws:
byps.RemoteException
- See Also:
-
setLogLevel
Set the logging level- Parameters:
level
-
-
getLogLevel
String getLogLevel()Get the logging level- Returns:
- level
-