org.ifeth.sehr.core.lib

Class SEHRConfiguration

java.lang.Object

org.ifeth.sehr.core.lib.SEHRConfiguration

public class SEHRConfiguration
extends java.lang.Object

This method is the one and only basic configuration handler between the SEHR modules on a running SEHR host and the underlaying operating system.

The configuration file knows (due to the setup procedure) where to find the databases and environments on servers like J2EE, Apache, Mail, JMS etc. as well as clients. These data are processed by this handler and stored in the reusable POJO SEHRConfigurationObject. Use this POJO if you want to track only some settings during runtime, i.e. on clients without a configuration file. But it does not contain secret data like admin passwords.

To retrieve the running configuration one of the methods listed below should be used in accordance to the context. Use 'true' only if you want the object to locate the running configuration file by running some tests on the host because this takes some more time to load all the stuff. After retrieving all parameters the is stored as a serialized bean (see SEHRConfigurationObject) at the LDAP service of the zone to inform clients about important settings and implemented services.

• SEHRConfiguration cfg = new SEHRConfiguration(String cfgfile);
• SEHRConfiguration cfg = new SEHRConfiguration(false);
  Recommended on 'static' and/or 'localhost' implementations. 'localhost' means the application is running on the same machine where the SEHR core is currently running - So use this from J2EE/WEB applications.
• If the SEHR server is running on another port than the default (24100) use SEHRConfiguration cfg = new SEHRConfiguration(hostip, port);
• If you want to be sure that the configuration is valid:
  

   (...)
   SEHRConfiguration cfg= new SEHRConfiguration();
   //search and load the config
   if (!cfg.loadSEHRCfg()){
     //return/exit with error
     return false;
   }
   //continue
   (...)
   

Important: This object requires always a local access to a running or defined configuration file or an access to a LDAP server.
On remote clients transmit specific data of a running SEHR zone, i.e. EHR objects by the using SOAP, LDAP (JNDI) or the native SEHRRemote interface.
In the JEE environment use the EJB named 'SEHRService' to retrieve the SEHRConfigurationObject or single settings like IMAP, POP3 etc. The EJB retrieves the configuration object by starting the SEHRServer from commandline. The JEE environment should be used to trensfer EHR objects between SEHR hosts.

See Also:

SEHR LDAP RFC

Constructor Summary

Constructors

Constructor and Description
SEHRConfiguration() Parameterless instance for using this handler in JSP as bean.
SEHRConfiguration(boolean search) Init SEHR environment object either by scanning for a configuration file (true) or by accessing the host via ip/port to retrieve he settings by JNDI/LDAP (false).
SEHRConfiguration(SEHRConfigurationObject sco) Init configuration handler with settings by the configuration object.
SEHRConfiguration(java.lang.String file) Init SEHR environment object using specified configuration file
SEHRConfiguration(java.lang.String ip, int port) Init SEHR environment object using specified host/port to get the configuration file to load.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAMQBrokerURL()
java.sql.Connection	getCon()
java.lang.String	getCssfile() Get the style file for WEB pages.
java.lang.String	getdbHost()
java.lang.String	getdbHostname()
java.lang.String	getdbSec()
java.lang.String	getdbSecUser()
java.lang.String	getdbSecUserPw()
java.lang.String	getDebug()
int	getDebugInt()
java.util.logging.Level	getDebugLevel() Returns a 'Level' object related to the stored/current debugging level
static java.util.logging.Level	getDebugLevel(int debuglevel) Returns a 'Level' object related to a given 'int' between 0 to 9 See SEHR conventions for debugging details.
java.lang.String	getDomain()
SEHRDataSource	getFbds() Deprecated. use getSEHRDataSource()
java.lang.String	getFQNN() Retrieve the FQNN for accessing the zone db.
java.lang.String	getIMAPServer()
java.io.File	getIPBlacklistFh()
java.io.File	getIPWhitelistFh()
java.lang.String	getLANIP() Get LAN IP where current server by SERVER IP is running on.
java.lang.String	getLDAPBaseDN()
java.lang.String	getLDAPCtx()
java.lang.String	getLDAPHost()
java.lang.String	getLDAPPort()
java.lang.String	getLDAPUser() Get the user to access a LDAP host.
java.lang.String	getLDAPUserDN() Get the DN of an LDAP entry.
java.lang.String	getLDAPUserPw()
java.lang.String	getLogfile() Returns the property entry 'LogFile' or creates a default value.
java.util.logging.Logger	getLogger()
java.lang.String	getModuleOwner()
java.lang.String	getModuleRoot()
java.lang.String	getPOP3Server()
java.lang.String	getRootOID()
java.lang.String	getRunningCfgFile()
SEHRConfigurationObject	getRunningCfgObject() Deprecated. use getSEHRConfigurationObject()
SEHRConfigurationObject	getRuntimeSCO(java.lang.String host, int port) Get runtime settings from SEHR host.
java.lang.String	getRuntimeValue(java.lang.String host, int port, java.lang.String key)
java.lang.String	getSEHRCfgValue(java.lang.String key) Common getter to retrieve a setting value from running(!)
SEHRConfigurationObject	getSEHRConfigurationObject() Get SEHR configuration without secret data for public usage.
SEHRDataSource	getSEHRDataSource()
java.lang.String	getSEHRHost() Get name of host for using in URLs or accesses via namespacing
java.lang.String	getSEHRPort()
java.lang.String	getSERVERIP() Get real IP of host using fpr direct tcp/ip access
java.lang.String	getSERVERPort() Deprecated. HJH: var changed to 'SEHRPort'
java.lang.String	getSMTPServer()
java.lang.String	getSubdomain()
java.lang.String	getSYSHOME() Returns the 'home' path of the system whereare the center home directories are located
java.lang.String	getTitle()
java.lang.String	getURLSEHRAdminAsIP() Returns the URL to access the SEHR-OSI module by JEE for administration purposes.
java.lang.String	getZoneID()
int	getZoneIDInt()
java.sql.Connection	initDBConnection() Deprecated. Don't cascade objects. Use SEHRDataSource
void	initLogger() Init logging for this and other SEHR modules using the debugging level defined by the configuration file.
void	initLogger(int debuglevel) Init logging using the default logger and the given debugging level
void	initLogger(java.lang.String loggerid, int dl)
boolean	isLDAP()
boolean	isMessaging()
static boolean	isNULLOrEmpty(java.lang.String s) Check if a given String is null or empty.
boolean	isSEHRCfgLoaded() Simple check wether the SEHR object was loaded (is available).
boolean	isSEHRCfgProp() Check wether SEHR environment is initialized (configuration is avlb.)
boolean	loadSEHRCfg() Load SEHR configuration by searching for the running configuration.
boolean	loadSEHRCfg(java.io.InputStream is)
boolean	loadSEHRCfg(java.lang.String f) Load SEHR configuration from a given configuration file.
boolean	loadSEHRCfg(java.lang.String host, int port) Loads the configuration of a running SEHR server from LDAP store.
void	logDebug(java.lang.String message)
void	logError(java.lang.String message) Deprecated. use LoggingHelper#logError
void	logInfo(java.lang.String message)
void	logWarn(java.lang.String message)
static void	main(java.lang.String[] args)
boolean	readSEHRCfgFile(java.lang.String file) Read configuration file and store key value pairs as properties.
void	readSEHRCfgFileToProp(java.lang.String file) Deprecated. (for downgrading compatibility) from modules use 'loadSEHRCfg()'
void	saveCfgFile(java.lang.String file) Save configuration in memory as configuration property file.
void	setAMQBrokerURL(java.lang.String url)
void	setCon(java.sql.Connection con)
void	setdbHost(java.lang.String dbHost)
void	setdbSecUser(java.lang.String dbSecUser)
void	setdbSecUserPw(java.lang.String dbSecUserPw)
void	setDebugLevel(int d)
void	setFbds(SEHRDataSource fbds) Deprecated. use setSEHRDataSource(SEHRDataSource sehrds)
void	setLDAPBaseDN(java.lang.String basedn)
void	setLDAPCtx(java.lang.String ctx)
void	setLDAPHost(java.lang.String host)
void	setLDAPPort(java.lang.String port)
void	setLDAPUser(java.lang.String user) Set the user to access a LDAP host.
void	setLDAPUserDN(java.lang.String dn) Set the DN of an LDAP entry.
void	setLDAPUserPw(java.lang.String pw)
void	setRootOID(java.lang.String oid)
boolean	setSEHRCfgValue(java.lang.String key, java.lang.String value) Common method to set/redefine a configuration value to the running configuration.
void	setSEHRConfigurationObject(SEHRConfigurationObject obj) Set SEHR configuration but note that there are no secrets inside.
void	setSEHRDataSource(SEHRDataSource sehrds) Set the instance of the SEHRDataSource for usage.
boolean	setSYSHOME(java.lang.String absolutepath)
void	setZoneID(java.lang.String zoneid)
java.lang.String	toString() Retrieve a very simple object information.
static java.lang.String	trimnull(java.lang.String s) Helper method to set 'null' strings to "" strings for a better review from database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SEHRConfiguration

public SEHRConfiguration()

Parameterless instance for using this handler in JSP as bean.

If using object as bean don't forget to load the configuration by sehrcfg.loadSEHRCfg([options]); . Also there is *NO* d initialization. Use initDBConnection() to initialize a simple db connection.

SEHRConfiguration

public SEHRConfiguration(SEHRConfigurationObject sco)

Init configuration handler with settings by the configuration object.

SEHRConfiguration

public SEHRConfiguration(boolean search)

Init SEHR environment object either by scanning for a configuration file (true) or by accessing the host via ip/port to retrieve he settings by JNDI/LDAP (false).

This constructor also initializes the logger. Parameter 'true' means scan for a running config file; 'false' means don't init by file, use the an existing LDAP/J2EE context. This is working only on the server site. For external clients acessing a SEHR server by LAN/WAN use

 SEHRConfiguration cfg = SEHRConfiguration(<local file>);
 cfg.loadSEHRCfg("<host>", <port>)
 

Parameters:

search -

SEHRConfiguration

public SEHRConfiguration(java.lang.String file)

Init SEHR environment object using specified configuration file

Parameters:

file - Path and name of a configuration file which must be accessable physically

SEHRConfiguration

public SEHRConfiguration(java.lang.String ip,
                         int port)

Init SEHR environment object using specified host/port to get the configuration file to load.

Note: Finally you must have a physical read access to the file or to a JNDI service to load the configuration. On WEB services 127.0.0.1/24100 is the default and you can use the simplified instantiation by using SEHRConfiguration(true). This method is used in testing environments...

Parameters:

ip - IP or DNS of SEHR host

port - SEHR Port (24100 by default)

Method Detail

getSEHRConfigurationObject

public SEHRConfigurationObject getSEHRConfigurationObject()

Get SEHR configuration without secret data for public usage.

Returns:

setSEHRConfigurationObject

public void setSEHRConfigurationObject(SEHRConfigurationObject obj)

Set SEHR configuration but note that there are no secrets inside.

Parameters:

obj -

toString

public java.lang.String toString()

Retrieve a very simple object information.

Overrides:

toString in class java.lang.Object

Returns:

getSEHRCfgValue

public java.lang.String getSEHRCfgValue(java.lang.String key)

Common getter to retrieve a setting value from running(!) configuration.

Note: There are a lot of getters of the configuration object. The configuration object is loaded on start up and represente the real running environment. N.B. Settings of the config file may be changed by command line.

Parameters:

key -

Returns:

setSEHRCfgValue

public boolean setSEHRCfgValue(java.lang.String key,
                               java.lang.String value)

Common method to set/redefine a configuration value to the running configuration.

Note: There are a lot of config values...

Parameters:

key -

value -

Returns:

getModuleRoot

public java.lang.String getModuleRoot()

getModuleOwner

public java.lang.String getModuleOwner()

getLogfile

public java.lang.String getLogfile()

Returns the property entry 'LogFile' or creates a default value.

Returns:

getTitle

public java.lang.String getTitle()

getZoneID

public java.lang.String getZoneID()

getZoneIDInt

public int getZoneIDInt()

setZoneID

public void setZoneID(java.lang.String zoneid)

getDomain

public java.lang.String getDomain()

getSubdomain

public java.lang.String getSubdomain()

getSERVERPort

public java.lang.String getSERVERPort()

Deprecated. HJH: var changed to 'SEHRPort'

getSEHRPort

public java.lang.String getSEHRPort()

getSEHRHost

public java.lang.String getSEHRHost()

Get name of host for using in URLs or accesses via namespacing

getSERVERIP

public java.lang.String getSERVERIP()

Get real IP of host using fpr direct tcp/ip access

getLANIP

public java.lang.String getLANIP()

Get LAN IP where current server by SERVER IP is running on.

Due to the SEHR conventions the LAN IP should be build from SERVER IP otherwise the server would not work :)

Returns:

lanip

getFQNN

public java.lang.String getFQNN()

Retrieve the FQNN for accessing the zone db. Note:The zone db contains all required informations of the services run by the SEHR host for other hosts to access them.

Returns:

getURLSEHRAdminAsIP

public java.lang.String getURLSEHRAdminAsIP()

Returns the URL to access the SEHR-OSI module by JEE for administration purposes. The method may be useful for retrieving the URL with the correct server IP for using by 'thick' clients.

Returns:

getSMTPServer

public java.lang.String getSMTPServer()

getPOP3Server

public java.lang.String getPOP3Server()

getIMAPServer

public java.lang.String getIMAPServer()

getLDAPPort

public java.lang.String getLDAPPort()

setLDAPPort

public void setLDAPPort(java.lang.String port)

getLDAPBaseDN

public java.lang.String getLDAPBaseDN()

setLDAPBaseDN

public void setLDAPBaseDN(java.lang.String basedn)

getLDAPHost

public java.lang.String getLDAPHost()

setLDAPHost

public void setLDAPHost(java.lang.String host)

setLDAPUser

public void setLDAPUser(java.lang.String user)

Set the user to access a LDAP host.

e.g. 'sehradmin'. The DN will be build later, e.g.
uid=sehradmin,ou=sehradmins,cn=people,o=zone\#0000000,dc=de,dc=e-hn,dc=org

Parameters:

user -

getLDAPUser

public java.lang.String getLDAPUser()

Get the user to access a LDAP host.

e.g. 'sehradmin'. To get the DN use getLDAPUserDN()

Returns:

setLDAPUserDN

public void setLDAPUserDN(java.lang.String dn)

Set the DN of an LDAP entry.

by example
uid=sehradmin,ou=sehradmins,cn=people,o=zone\#0000000,dc=de,dc=e-hn,dc=org

Parameters:

dn -

getLDAPUserDN

public java.lang.String getLDAPUserDN()

Get the DN of an LDAP entry.

Example
uid=sehradmin,ou=sehradmins,cn=people,o=zone\#0000000,dc=de,dc=e-hn,dc=org

Returns:

The DN like 'uid=sehradmin,ou=sehradmins, ...'

setLDAPUserPw

public void setLDAPUserPw(java.lang.String pw)

getLDAPUserPw

public java.lang.String getLDAPUserPw()

setLDAPCtx

public void setLDAPCtx(java.lang.String ctx)

getLDAPCtx

public java.lang.String getLDAPCtx()

isLDAP

public boolean isLDAP()

getAMQBrokerURL

public java.lang.String getAMQBrokerURL()

setAMQBrokerURL

public void setAMQBrokerURL(java.lang.String url)

isMessaging

public boolean isMessaging()

getDebug

public java.lang.String getDebug()

getDebugInt

public int getDebugInt()

setDebugLevel

public void setDebugLevel(int d)

getDebugLevel

public java.util.logging.Level getDebugLevel()

Returns a 'Level' object related to the stored/current debugging level

Returns:

Level_object of the current debugging level

getDebugLevel

public static java.util.logging.Level getDebugLevel(int debuglevel)

Returns a 'Level' object related to a given 'int' between 0 to 9

See SEHR conventions for debugging details.
Note:This method does not affect the changing of the debug level of the current session. It is a convenience method to translate the given number to a 'Level' object.

Parameters:

debuglevel - 0 (=none) to 9 (=detailed)

Returns:

Level

getdbSec

public java.lang.String getdbSec()

Returns:

Path and name to the 'IntraSEC' database

getdbHost

public java.lang.String getdbHost()

Returns:

String IP of the SEHR host

getdbHostname

public java.lang.String getdbHostname()

Returns:

String Name of the SEHR host

getRootOID

public java.lang.String getRootOID()

setRootOID

public void setRootOID(java.lang.String oid)

setdbHost

public void setdbHost(java.lang.String dbHost)

getdbSecUser

public java.lang.String getdbSecUser()

setdbSecUser

public void setdbSecUser(java.lang.String dbSecUser)

getdbSecUserPw

public java.lang.String getdbSecUserPw()

setdbSecUserPw

public void setdbSecUserPw(java.lang.String dbSecUserPw)

getCon

public java.sql.Connection getCon()

Returns:

Returns the current database connection handle.

setCon

public void setCon(java.sql.Connection con)

Parameters:

con - Set (store) the current connection handle to IntraSEC.

getFbds

public SEHRDataSource getFbds()

Deprecated. use getSEHRDataSource()

Returns:

SEHRDataSource - Returns the SEHRDataSource object used by this object.

getSEHRDataSource

public SEHRDataSource getSEHRDataSource()

Returns:

SEHRDataSource - Returns the SEHRDataSource object used by this object.

setFbds

public void setFbds(SEHRDataSource fbds)

Deprecated. use setSEHRDataSource(SEHRDataSource sehrds)

setSEHRDataSource

public void setSEHRDataSource(SEHRDataSource sehrds)

Set the instance of the SEHRDataSource for usage.

Parameters:

sehrds - Set (store) the current SEHRDataSource instance

getSYSHOME

public java.lang.String getSYSHOME()

Returns the 'home' path of the system whereare the center home directories are located

Returns:

String The home directory of the SEHR core module

setSYSHOME

public boolean setSYSHOME(java.lang.String absolutepath)

getRunningCfgFile

public java.lang.String getRunningCfgFile()

getRunningCfgObject

public SEHRConfigurationObject getRunningCfgObject()

Deprecated. use getSEHRConfigurationObject()

Returns:

the configuration object

initDBConnection

public java.sql.Connection initDBConnection()

Deprecated. Don't cascade objects. Use SEHRDataSource

Init a db connection to the admin db of the zone using the settings of this object.

Note: This is a simple, not pooled access to the zone database on the host. To use persistent transactions on WEB applications use a JNDI based datasource.

Returns:

connection - A native (pooled) to the (IntraSEC) DB

isSEHRCfgLoaded

public boolean isSEHRCfgLoaded()

Simple check wether the SEHR object was loaded (is available).

Use this method to check if the configuration is avbl. and the db 'intrasec' is accessable

Returns:

boolean 'true' if running cfg is avlb. otherwise 'false'

isSEHRCfgProp

public boolean isSEHRCfgProp()

Check wether SEHR environment is initialized (configuration is avlb.)

Returns:

boolean 'true' if running object is avlb. otherwise 'false'

loadSEHRCfg

public boolean loadSEHRCfg()

Load SEHR configuration by searching for the running configuration.

Use this method to get/init the SEHR configuration for all modules.
The configuration file is placed at 'path_to_sehrroot/etc/.sehr' by convention. If the server has been started (with default or another configuration file using option -c) the running configuration is stored as 'path_to_sehrroot/tmp/.running'.
This method tries to get the running configuration using some methods to find it.
To use another configuration file use
'loadSEHRCfg(fullpath_and_name)'
If the SEHR service host(ip and port) is known use
'loadSEHRCfg(ip, port)'
If the SEHR module/client is running on the same host (localhost) just use
'loadSEHRCfg('127.0.0.1', port)'

Note:
Using this method to load the configuration there is finally a physical request to a local configuration file.

Returns:

getRuntimeSCO

public SEHRConfigurationObject getRuntimeSCO(java.lang.String host,
                                             int port)

Get runtime settings from SEHR host.

Loads the settings from runtime configuration file. The returned object should be the same like the settings object from LDAP store.

Parameters:

host -

port -

Returns:

loadSEHRCfg

public boolean loadSEHRCfg(java.lang.String host,
                           int port)

Loads the configuration of a running SEHR server from LDAP store.

This is a helper function to get the configuration from the LDAP context by requesting the running SEHR server using the params 'host' and 'port'. Use this method also to get settings of the SEHR zone like mail server, JMS broker. If there is no LDAP the SEHR service is not fully configured.

Note:A running SEHR OSI service is required to use this function!

Use getSEHRConfigurationObject() to use the loaded settings.

Parameters:

host - IP/DNS name of a running SEHR service host

port - Port of the SEHR service (not the LDAP/J2EE context!)

Returns:

'true' on successful loading or 'false' on errors

getRuntimeValue

public java.lang.String getRuntimeValue(java.lang.String host,
                                        int port,
                                        java.lang.String key)

Parameters:

host -

port -

key - The key for which the value is requested

Returns:

loadSEHRCfg

public boolean loadSEHRCfg(java.lang.String f)

Load SEHR configuration from a given configuration file.

Parameters:

f - String as path_and_name_to_cfg_file

Returns:

loadSEHRCfg

public boolean loadSEHRCfg(java.io.InputStream is)

getCssfile

public java.lang.String getCssfile()

Get the style file for WEB pages.

Notes:
The default CSS file to use is defined in WEB.XML
Path must be included within HTML code and depends on the location the styles are located

Returns:

cssfile file w/o path

isNULLOrEmpty

public static boolean isNULLOrEmpty(java.lang.String s)

Check if a given String is null or empty.

Parameters:

s -

Returns:

'true' if null or empty

trimnull

public static java.lang.String trimnull(java.lang.String s)

Helper method to set 'null' strings to "" strings for a better review from database. If string is not null the string itself is returned trimmed.

The method is static so it can be used by other classes :)

Parameters:

s -

Returns:

String

readSEHRCfgFileToProp

public void readSEHRCfgFileToProp(java.lang.String file)
                           throws java.io.IOException

Deprecated. (for downgrading compatibility)

from modules use 'loadSEHRCfg()'

This method reads the configuration file and generates a prop object

Throws:

java.io.IOException

readSEHRCfgFile

public boolean readSEHRCfgFile(java.lang.String file)

Read configuration file and store key value pairs as properties.

Use

• 'loadSEHRCfg()' to get DEFAULT SEHR configuration.
• 'loadSEHRCfg(file)' to use a specific SEHR configuration.

Parameters:

file - The configuration of the SEHR host

Returns:

(boolean) true if configuration was loaded successfully

saveCfgFile

public void saveCfgFile(java.lang.String file)
                 throws java.io.IOException

Save configuration in memory as configuration property file.

This method is used by the SEHRServer task to store the 'runnning' configuration and may be used by the user to redefine settings...

Parameters:

file -

Throws:

java.io.IOException

initLogger

public void initLogger()

Init logging for this and other SEHR modules using the debugging level defined by the configuration file.

initLogger

public void initLogger(int debuglevel)

Init logging using the default logger and the given debugging level

Parameters:

debuglevel -

initLogger

public void initLogger(java.lang.String loggerid,
                       int dl)

getLogger

public java.util.logging.Logger getLogger()

logInfo

public void logInfo(java.lang.String message)

logDebug

public void logDebug(java.lang.String message)

logWarn

public void logWarn(java.lang.String message)

logError

public void logError(java.lang.String message)

Deprecated. use LoggingHelper#logError

Parameters:

message -

getIPWhitelistFh

public java.io.File getIPWhitelistFh()

getIPBlacklistFh

public java.io.File getIPBlacklistFh()

main

public static void main(java.lang.String[] args)