Package com.randomnoun.common.webapp

Class AppConfigBase

java.lang.Object

java.util.Dictionary<Object,Object>

java.util.Hashtable<Object,Object>

java.util.Properties

com.randomnoun.common.webapp.AppConfigBase

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public abstract class AppConfigBase
extends Properties

An attempt to standardise config objects across the handful of webapps in this workspace.

Holds configuration data for this web application. Is used to look up resources for use by other application components, including:

• database connections (JdbcTemplates)
• security contexts (for authentication / authorisation)

Author:

Greg

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,DataSource>	dataSources	Datasource underlying the jdbcTemplates
protected Throwable	initialisationFailure	If set to non-null, indicates an exception that occurred during initialisation.
static AppConfigBase	instance	Global instance
protected Map<String,org.springframework.jdbc.core.JdbcTemplate>	jdbcTemplates	JdbcTemplates for this AppConfig
static org.apache.log4j.Logger	logger	Logger instance for this class
protected SecurityContext	securityContext	Security context used for authentication and authorisation

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
AppConfigBase()

Method Summary

Modifier and Type	Method	Description
void	checkPermission(User user, String permission)	Determines whether a user 'may have' a permission on the application.
ResourceBundle	getBundle(String i18nBundleName, User user)	Returns a bundle to be used for internationalisation.
abstract String	getConfigResourceLocation()	The name of the file which configures this application; e.g.
DataSource	getDataSource()	Provides direct access to the datasource for this application.
DataSource	getDataSource(String connectionName)	Provides direct access to a named datasource for this application.
org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate()	Return a jdbcTemplate object that can be used to query the database
org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate(String connectionName)	Returns a named jdbcTemplate object that can be used to query the database
SecurityContext	getSecurityContext()	Return the security context for this application
abstract String	getSystemPropertyKeyConfigPath()	The name of the -D directive which, if present, specifies the folder containing the configuration file; e.g.
boolean	hasPermission(User user, String permission)	Determines whether a user 'may have' a permission on the application.
boolean	hasPermission(User user, String permission, Map<String,Object> resourceContext)	Determines whether a user has a permission on the application.
protected void	initDatabase()	Ensure that the database drivers are accessible, for simple and dbcp connection types
protected void	initHostname()	Sets the hostname application property.
protected void	initLogger()	Initialises log4j
protected void	initSecurityContext()
protected void	loadProperties()	Load the configuration from both the classpath and the filesystem.

Methods inherited from class java.util.Properties

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

logger

public static org.apache.log4j.Logger logger

Logger instance for this class

instance

public static AppConfigBase instance

Global instance

jdbcTemplates

protected Map<String,org.springframework.jdbc.core.JdbcTemplate> jdbcTemplates

JdbcTemplates for this AppConfig

dataSources

protected Map<String,DataSource> dataSources

Datasource underlying the jdbcTemplates

securityContext

protected SecurityContext securityContext

Security context used for authentication and authorisation

initialisationFailure

protected Throwable initialisationFailure

If set to non-null, indicates an exception that occurred during initialisation.

Constructor Details

AppConfigBase

public AppConfigBase()

Method Details

getSystemPropertyKeyConfigPath

public abstract String getSystemPropertyKeyConfigPath()

The name of the -D directive which, if present, specifies the folder containing the configuration file; e.g. "com.randomnoun.appName.configPath"

getConfigResourceLocation

public abstract String getConfigResourceLocation()

The name of the file which configures this application; e.g. "/appName-web.properties"

initDatabase

protected void initDatabase()

Ensure that the database drivers are accessible, for simple and dbcp connection types

initLogger

protected void initLogger()

Initialises log4j

initSecurityContext

protected void initSecurityContext()

initHostname

protected void initHostname()

Sets the hostname application property. Should be called before loadProperties(), which may have ENVIRONMENT settings that rely on the hostname.

getBundle

public ResourceBundle getBundle(String i18nBundleName,
 User user)

Returns a bundle to be used for internationalisation. The bundle will initially be searched for using the standard ResourceBundle.getBundle(name) method (i.e. in the server's classpath); and, if this fails, will return ResourceBundle("resources.i18n." + name); which will search the i18n tree of the eomail project.

Parameters:

i18nBundleName - The bundle name to search for (e.g. "user")

user - The user for whom we are retrieving i18ned messages for (the locale of this user will be used to determine which resource bundle to use)

Returns:

The ResourceBundle requested.

loadProperties

protected void loadProperties()

Load the configuration from both the classpath and the filesystem. Properties defined on the filesystem will override any contained within the web application.

Multiple environments can be specified in properties files using the STARTENVIRONMENT/ENDENVIRONMENT tags. The tags use the machine's hostname as an environment specifier.

getJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate()

Return a jdbcTemplate object that can be used to query the database

Returns:

a jdbcTemplate to the database

getJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate(String connectionName)

Returns a named jdbcTemplate object that can be used to query the database

Parameters:

connectionName - The name of the connection

Returns:

a jdbcTemplate to the database

getSecurityContext

public SecurityContext getSecurityContext()

Return the security context for this application

Returns:

the security context for this application

hasPermission

public boolean hasPermission(User user,
 String permission)

Determines whether a user 'may have' a permission on the application. See the hasPermission method in SecurityContext for more details.

Parameters:

user - The user we are checking permissions for.

permission - The permission we are checking.

Returns:

'true' if the user may be authorised to perform the permission, false otherwise

checkPermission

public void checkPermission(User user,
 String permission)
                     throws SecurityException

Determines whether a user 'may have' a permission on the application. See the hasPermission method in SecurityContext for more details. If the user does not have the permission, then a SecurityException is thrown

Parameters:

user - The user we are checking permissions for.

permission - The permission we are checking.

Throws:

SecurityException - if the user does not have the supplied permission

See Also:

• SecurityContext.hasPermission(com.randomnoun.common.security.User, String)

hasPermission

public boolean hasPermission(User user,
 String permission,
 Map<String,Object> resourceContext)

Determines whether a user has a permission on the application. See the hasPermission method in SecurityContext for more details.

Parameters:

user - The user we are checking permissions for.

permission - The permission we are checking.

resourceContext - Fine-grained resource context

Returns:

'true' if the user is authorised to perform the permission, false otherwise

getDataSource

public DataSource getDataSource()

Provides direct access to the datasource for this application. Most applications should use the getJdbcTemplate() method instead.

Returns:

the dataSource underlying the jdbcTemplate to the database

getDataSource

public DataSource getDataSource(String connectionName)

Provides direct access to a named datasource for this application. Most applications should use the getJdbcTemplate(String) method instead.

Parameters:

connectionName - the name of the connection

Returns:

the dataSource underlying the named jdbcTemplate to the database