Package de.willuhn.jameica.system
Class Config
- java.lang.Object
-
- de.willuhn.jameica.system.Config
-
public final class Config extends java.lang.Object
Liest die System-Konfiguration aus config.xml.- Author:
- willuhn
-
-
Field Summary
Fields Modifier and Type Field Description static int
RMI_DEFAULT_PORT
Definition des Default-Ports fuer die RMI-Kommunikation.
-
Constructor Summary
Constructors Modifier Constructor Description protected
Config()
ct.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getBackupCount()
Liefert die Anzahl zu erstellender Backups.java.lang.String
getBackupDir()
Liefert das Backup-Verzeichnis.java.lang.String
getConfigDir()
Liefert den Pfad zum Config-Verzeichnis.java.lang.String
getHttpsProxyHost()
Liefert einen ggf definierten HTTPS-Proxy, ueber den Jameica mit der Aussenwelt kommunizieren soll.int
getHttpsProxyPort()
Liefert den TCP-Port des HTTPS-Proxys insofern einer definiert ist.java.util.Locale
getLocale()
Liefert das konfigurierte Locale (Sprach-Auswahl).java.lang.String
getLogFile()
Liefert Pfad und Dateiname des Log-Files.java.lang.String
getLogLevel()
Liefert den Namen des Loglevels.long
getLogSize()
Liefert die Dateigroesse nach der die Log-Datei rotiert und gezippt wird.boolean
getMandatoryCheck()
Legt fest, ob Eingabe-Felder auf Pflichteingaben geprueft werden.boolean
getMandatoryLabel()
Legt fest, ob auch die Label vor Pflichtfeldern rot markiert werden sollen.boolean
getMulticastLookup()
Prueft, ob im Server-Mode die Dienste via Multicast-Lookup im LAN announced werden sollen.java.io.File[]
getPluginDirs()
Liefert die in ~/.jameica/cfg/de.willuhn.jameica.system.Config.properties definierten Pluginverzeichnisse.java.lang.String
getProxyHost()
Liefert einen ggf definierten Proxy, ueber den Jameica mit der Aussenwelt kommunizieren soll.int
getProxyPort()
Liefert den TCP-Port des Proxys insofern einer definiert ist.int
getRmiPort()
Liefert den fuer die lokale RMI-Registry zu verwendenden TCP-Port.boolean
getRmiSSL()
Prueft, ob die RMI-Verbindungen SSL-verschluesselt werden sollen.boolean
getRmiUseClientAuth()
Prueft, ob bei SSL-verschluesselten RMI-Verbindungen Client-Authentifizierung verwendet werden soll.boolean
getShareServices()
Prueft, ob im Server-Mode die Dienste nach aussen freigegeben werden sollen.java.lang.String
getStoreUntranslatedDir()
Liefert das Verzeichnis, in dem Strings gespeichert werden sollen, zu denen keine Uebersetzungen existieren.java.io.File
getSystemPluginDir()
Liefert das System-Plugin-Verzeichnis.boolean
getTrustJavaCerts()
Prueft, ob den Aussteller-Zertifikaten der Java-Installation vertraut werden soll.java.io.File
getUpdateDir()
Liefert das Verzeichnis, in dem Plugin-Updates gespeichert werden.boolean
getUseBackup()
Prueft, ob Backups erstellt werden sollen.java.io.File
getUserPluginDir()
Liefert das User-Plugin-Verzeichnis.boolean
getUseSystemProxy()
Prueft, ob die Proxy-Einstellungen des Systems verwendet werden sollen.java.lang.String
getWorkDir()
Liefert das Work-Verzeichnis von Jameica.protected void
init()
Initialisiert die Konfiguration.void
setBackupCount(int count)
Speichert die Anzahl zu erstellender Backups.void
setBackupDir(java.lang.String dir)
Speichert das Backup-Verzeichnis.void
setHttpsProxyHost(java.lang.String host)
Speichert den HTTPS-Proxy-Host,void
setHttpsProxyPort(int port)
Speichert die TCP-Portnummer des HTTPS-Proxys.void
setLocale(java.util.Locale l)
Speichert das Locale (Sprach-Auswahl).void
setLoglevel(java.lang.String name)
Legt den Log-Level fest.void
setMandatoryCheck(boolean check)
Legt fest, ob Eingabe-Felder auf Pflichteingaben geprueft werden.void
setMandatoryLabel(boolean check)
Legt fest, ob auch die Label vor Pflichtfeldern rot markiert werden sollen.void
setProxyHost(java.lang.String host)
Speichert den Proxy-Host,void
setProxyPort(int port)
Speichert die TCP-Portnummer des Proxys.void
setRmiPort(int port)
Speichert den zu verwendenden TCP-Port fuer die lokale RMI-Registry.void
setRmiSSL(boolean b)
Aktiviert oder deaktiviert die Verwendung von SSL fuer die RMI-Verbindungen.void
setTrustJavaCerts(boolean b)
Legt fest, ob den Aussteller-Zertifikaten der Java-Installation vertraut werden soll.void
setUseBackup(boolean enabled)
Speichert, ob Backups erstellt werden sollen.void
setUseSystemProxy(boolean b)
Legt fest, ob die System-Einstellungen fuer den Proxy verwendet werden sollen.
-
-
-
Field Detail
-
RMI_DEFAULT_PORT
public static final int RMI_DEFAULT_PORT
Definition des Default-Ports fuer die RMI-Kommunikation.- See Also:
- Constant Field Values
-
-
Method Detail
-
init
protected void init() throws java.lang.Exception
Initialisiert die Konfiguration.- Throws:
de.willuhn.util.ApplicationException
- wenn das Benutzerverzeichnis nicht lesbar ist oder nicht erstellt werden konntejava.lang.Exception
-
getRmiPort
public int getRmiPort()
Liefert den fuer die lokale RMI-Registry zu verwendenden TCP-Port.- Returns:
- Nummer des TCP-Ports.
-
setRmiPort
public void setRmiPort(int port) throws de.willuhn.util.ApplicationException
Speichert den zu verwendenden TCP-Port fuer die lokale RMI-Registry.- Parameters:
port
-- Throws:
de.willuhn.util.ApplicationException
- Wird geworfen, wenn die Port-Angabe ungueltig (kleiner 1 oder groesser 65535) ist oder der Port bereits belegt.
-
getRmiSSL
public boolean getRmiSSL()
Prueft, ob die RMI-Verbindungen SSL-verschluesselt werden sollen.- Returns:
- true, wenn die Verwendung von SSL aktiv ist.
-
getRmiUseClientAuth
public boolean getRmiUseClientAuth()
Prueft, ob bei SSL-verschluesselten RMI-Verbindungen Client-Authentifizierung verwendet werden soll.- Returns:
- true, wenn die Client-Authentifizierung verwendet wird.
-
getProxyHost
public java.lang.String getProxyHost()
Liefert einen ggf definierten Proxy, ueber den Jameica mit der Aussenwelt kommunizieren soll.- Returns:
- Hostname/IP des Proxy oder
null
wenn keiner definiert ist.
-
getProxyPort
public int getProxyPort()
Liefert den TCP-Port des Proxys insofern einer definiert ist.- Returns:
- TCP-Portnummer des Proxys oder
-1
,
-
setProxyHost
public void setProxyHost(java.lang.String host)
Speichert den Proxy-Host,- Parameters:
host
- Proxy-Host.
-
setProxyPort
public void setProxyPort(int port) throws de.willuhn.util.ApplicationException
Speichert die TCP-Portnummer des Proxys.- Parameters:
port
- Port-Nummer.- Throws:
de.willuhn.util.ApplicationException
- Bei Angabe eines ungueltigen Ports (kleiner 1 oder groesser 65535). Es sei denn, es wurde "-1" angegeben. Der Wert steht fuer "nicht verwenden".- See Also:
getProxyPort()
-
getHttpsProxyHost
public java.lang.String getHttpsProxyHost()
Liefert einen ggf definierten HTTPS-Proxy, ueber den Jameica mit der Aussenwelt kommunizieren soll.- Returns:
- Hostname/IP des Proxy oder
null
wenn keiner definiert ist.
-
getHttpsProxyPort
public int getHttpsProxyPort()
Liefert den TCP-Port des HTTPS-Proxys insofern einer definiert ist.- Returns:
- TCP-Portnummer des Proxys oder
-1
,
-
setHttpsProxyHost
public void setHttpsProxyHost(java.lang.String host)
Speichert den HTTPS-Proxy-Host,- Parameters:
host
- Proxy-Host.
-
setHttpsProxyPort
public void setHttpsProxyPort(int port) throws de.willuhn.util.ApplicationException
Speichert die TCP-Portnummer des HTTPS-Proxys.- Parameters:
port
- Port-Nummer.- Throws:
de.willuhn.util.ApplicationException
- Bei Angabe eines ungueltigen Ports (kleiner 1 oder groesser 65535). Es sei denn, es wurde "-1" angegeben. Der Wert steht fuer "nicht verwenden".- See Also:
getHttpsProxyPort()
-
getUseSystemProxy
public boolean getUseSystemProxy()
Prueft, ob die Proxy-Einstellungen des Systems verwendet werden sollen.- Returns:
true
, wenn die Default-Systemeinstellungen verwendet werden sollen.
-
setUseSystemProxy
public void setUseSystemProxy(boolean b)
Legt fest, ob die System-Einstellungen fuer den Proxy verwendet werden sollen.- Parameters:
b
-true
, wenn die System-Einstellungen des Betriebssystems verwendet werden sollen.
-
getTrustJavaCerts
public boolean getTrustJavaCerts()
Prueft, ob den Aussteller-Zertifikaten der Java-Installation vertraut werden soll.- Returns:
true
, wenn den Aussteller-Zertifikaten der Java-Installation vertraut werden soll. Liefert per Default true.
-
setTrustJavaCerts
public void setTrustJavaCerts(boolean b)
Legt fest, ob den Aussteller-Zertifikaten der Java-Installation vertraut werden soll.- Parameters:
b
-true
, wenn den Aussteller-Zertifikaten der Java-Installation vertraut werden soll.
-
getShareServices
public boolean getShareServices()
Prueft, ob im Server-Mode die Dienste nach aussen freigegeben werden sollen. Der Parameter wird nur im Server-Mode interpretiert.- Returns:
true
, wenn die Dienste freigegeben werden.
-
getMulticastLookup
public boolean getMulticastLookup()
Prueft, ob im Server-Mode die Dienste via Multicast-Lookup im LAN announced werden sollen. Der Parameter wird nur im Server-Mode interpretiert.- Returns:
true
, wenn die Dienste via Multicast-Lookup announced werden sollen.
-
setRmiSSL
public void setRmiSSL(boolean b)
Aktiviert oder deaktiviert die Verwendung von SSL fuer die RMI-Verbindungen.- Parameters:
b
-
-
getLocale
public java.util.Locale getLocale()
Liefert das konfigurierte Locale (Sprach-Auswahl).- Returns:
- konfiguriertes Locale.
-
setLocale
public void setLocale(java.util.Locale l)
Speichert das Locale (Sprach-Auswahl).- Parameters:
l
- das zu verwendende Locale.
-
getPluginDirs
public java.io.File[] getPluginDirs()
Liefert die in ~/.jameica/cfg/de.willuhn.jameica.system.Config.properties definierten Pluginverzeichnisse.- Returns:
- Liste Plugin-Verzeichnisse.
-
getSystemPluginDir
public java.io.File getSystemPluginDir()
Liefert das System-Plugin-Verzeichnis. Das ist jenes, welches sich im Jameica-Verzeichnis befindet.- Returns:
- das System-Plugin-Verzeichnis.
-
getUserPluginDir
public java.io.File getUserPluginDir()
Liefert das User-Plugin-Verzeichnis. Das ist jenes, welches sich im Work-Verzeichnis des Users befindet. In der Regel ist das ~/.jameica/plugins.- Returns:
- das user-Plugin-Verzeichnis.
-
getUpdateDir
public java.io.File getUpdateDir()
Liefert das Verzeichnis, in dem Plugin-Updates gespeichert werden. Die werden beim naechsten Start entpackt und gegen das alte Plugin ersetzt.- Returns:
- das Update-Verzeichnis.
-
getLogFile
public java.lang.String getLogFile()
Liefert Pfad und Dateiname des Log-Files.- Returns:
- Logfile.
-
getLogSize
public long getLogSize()
Liefert die Dateigroesse nach der die Log-Datei rotiert und gezippt wird.- Returns:
- die Dateigroesse des Logs in Bytes.
-
getMandatoryCheck
public boolean getMandatoryCheck()
Legt fest, ob Eingabe-Felder auf Pflichteingaben geprueft werden.- Returns:
- Pruefen von Pflichteingaben.
-
setMandatoryCheck
public void setMandatoryCheck(boolean check)
Legt fest, ob Eingabe-Felder auf Pflichteingaben geprueft werden.- Parameters:
check
- Pruefen von Pflichteingaben.
-
getMandatoryLabel
public boolean getMandatoryLabel()
Legt fest, ob auch die Label vor Pflichtfeldern rot markiert werden sollen.- Returns:
true
, wenn auch die Label rot markiert werden sollen.
-
setMandatoryLabel
public void setMandatoryLabel(boolean check)
Legt fest, ob auch die Label vor Pflichtfeldern rot markiert werden sollen.- Parameters:
check
-true
, wenn auch die Label rot markiert werden sollen.
-
getLogLevel
public java.lang.String getLogLevel()
Liefert den Namen des Loglevels.- Returns:
- Name des Loglevels.
-
setLoglevel
public void setLoglevel(java.lang.String name)
Legt den Log-Level fest.- Parameters:
name
- Name des Log-Levels.
-
getConfigDir
public java.lang.String getConfigDir()
Liefert den Pfad zum Config-Verzeichnis.- Returns:
- Pfad zum Config-Verzeichnis.
-
getWorkDir
public java.lang.String getWorkDir()
Liefert das Work-Verzeichnis von Jameica.- Returns:
- das Work-Verzeichnis von Jameica.
-
getBackupDir
public java.lang.String getBackupDir() throws de.willuhn.util.ApplicationException
Liefert das Backup-Verzeichnis.- Returns:
- Backup-Verzeichnis.
- Throws:
de.willuhn.util.ApplicationException
- wenn das Verzeichnis ungueltig ist.
-
setBackupDir
public void setBackupDir(java.lang.String dir) throws de.willuhn.util.ApplicationException
Speichert das Backup-Verzeichnis. Der Pfad wird nur gespeichert, wenn er vom Default-Wert abweicht. Andernfalls wird der Wert in der Config resettet, damit wieder das Standardverzeichnis genutzt wird.- Parameters:
dir
- das Backup-Verzeichnis.- Throws:
de.willuhn.util.ApplicationException
- wenn das Verzeichnis ungueltig ist.
-
getBackupCount
public int getBackupCount()
Liefert die Anzahl zu erstellender Backups.- Returns:
- Anzahl der Backups.
-
setBackupCount
public void setBackupCount(int count)
Speichert die Anzahl zu erstellender Backups.Default-Wert: 10.
- Parameters:
count
- Anzahl der Backups.
-
getUseBackup
public boolean getUseBackup()
Prueft, ob Backups erstellt werden sollen.- Returns:
true
, wenn Backups erstellt werden sollen.
-
setUseBackup
public void setUseBackup(boolean enabled)
Speichert, ob Backups erstellt werden sollen.Default:
true
.- Parameters:
enabled
-true
, wenn Backups erstellt werden sollen.
-
getStoreUntranslatedDir
public java.lang.String getStoreUntranslatedDir()
Liefert das Verzeichnis, in dem Strings gespeichert werden sollen, zu denen keine Uebersetzungen existieren.- Returns:
- Der Ordner oder
null
, wenn nicht gespeichert werden soll.
-
-