com.neurosys.site.wicket.app

Class AppSettings

java.lang.Object

com.neurosys.site.wicket.app.AppSettings

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Component(value="appSettings")
public class AppSettings
extends Object
implements org.springframework.context.ApplicationContextAware

 Common site wide application settings accessible globally.
 Loaded in Spring Context as appSettings
 
 Note: Putting non-static App specific configs, in SiteApplication presented a problem in situations where there is no web context.
 While testing we can rely on classes like WicketTester or SiteTester however it has serious limitations and complications, specially when booting an App when the Web Context may not have yet kicked in.
 

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
Properties	adminConfiguration
Properties	appConfiguration
String	APPLICATION_ENCODING_CHARSET The Application/Project wide default Encoding Charset defined by appConfiguration project.encoding.charset
String	APPLICATION_EXTENSION Any default extension to apply to the user facing site/pages defined by appConfiguration site.ext
Class	appUserType Application default user Type (Class)
AuthorizationModule	authModule
String	CDN_LOCATION Location/Name for a Content Delivery Network This is useful to set the base URL's for all resources if we wish to fetch them from a CDN The CDN Location should be independent of any protocol; and should represent the Domain Name.
protected static ThreadLocal<AppSettings>	configs
String	CONTEXT_BASE_ABSOLUTE_PATH A reference to the Base path on the OS for files. IF not defined, then is set automatically.
SimpleDateFormat	DATE_FORMAT
String	DATE_FORMAT_PATTERN
int	DEFAULT_DISPLAY_PAGE_SIZE For admin Grids the Page size is defined by adminConfiguration data.table.page.size
Locale	DEFAULT_LOCALE Locale as null is not good.
javax.persistence.EntityManager	entityManager
static Date	LICENSE_EXPIRES
static String	LICENSE_ISSUER
static String	LICENSED_TO
String	MODULE_EXTENSION Any default extension to apply to the admin/module based site/pages defined by adminConfiguration module.ext
List<String>	RESOURCE_FOLDER_BASE_PATHS Defined by appConfiguration site.resources.folder.base
Boolean	RESOURCE_REL_TO_WEB_CNTXT If images/resources are loaded relative to Web-Context or absolute, defined by appConfiguration site.resources.folder.mode.relative
org.springframework.context.ApplicationContext	springContext
SpringConfiguredContainerFactory	WICKET_CONTAINER_FACTORY

Constructor Summary

Constructors

Constructor and Description
AppSettings()

Method Summary

Modifier and Type	Method and Description
static AppSettings	get()
Properties	getAdminConfiguration()
Properties	getAppConfiguration()
String	getAPPLICATION_ENCODING_CHARSET()
String	getAPPLICATION_EXTENSION()
org.springframework.context.ApplicationContext	getApplicationContext()
AuthorizationModule	getAuthModule()
String	getCONTEXT_BASE_ABSOLUTE_PATH()
int	getDEFAULT_DISPLAY_PAGE_SIZE()
Locale	getDEFAULT_LOCALE()
String	getMODULE_EXTENSION()
List<String>	getRESOURCE_FOLDER_BASE_PATHS()
Boolean	getRESOURCE_REL_TO_WEB_CNTXT()
void	init()
static void	set(AppSettings appSettings)
void	setAdminConfiguration(Properties adminConfiguration)
void	setAppConfiguration(Properties appConfiguration)
void	setAPPLICATION_ENCODING_CHARSET(String aPPLICATION_ENCODING_CHARSET)
void	setAPPLICATION_EXTENSION(String aPPLICATION_EXTENSION)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAppSettings()
void	setAuthModule(AuthorizationModule authModule)
void	setCONTEXT_BASE_ABSOLUTE_PATH(String cONTEXT_BASE_ABSOLUTE_PATH)
void	setDEFAULT_DISPLAY_PAGE_SIZE(int dEFAULT_DISPLAY_PAGE_SIZE)
void	setDEFAULT_LOCALE(Locale dEFAULT_LOCALE)
void	setMODULE_EXTENSION(String mODULE_EXTENSION)
void	setRESOURCE_FOLDER_BASE_PATHS(List<String> rESOURCE_FOLDER_BASE_PATHS)
void	setRESOURCE_REL_TO_WEB_CNTXT(Boolean rESOURCE_REL_TO_WEB_CNTXT)

Methods inherited from class java.lang.Object

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

Field Detail

springContext

public org.springframework.context.ApplicationContext springContext

entityManager

public javax.persistence.EntityManager entityManager

appConfiguration

public Properties appConfiguration

adminConfiguration

public Properties adminConfiguration

authModule

public AuthorizationModule authModule

CONTEXT_BASE_ABSOLUTE_PATH

public String CONTEXT_BASE_ABSOLUTE_PATH

A reference to the Base path on the OS for files.
IF not defined, then is set automatically. (via SiteApplication or SiteWicketFilter)

APPLICATION_ENCODING_CHARSET

public String APPLICATION_ENCODING_CHARSET

The Application/Project wide default Encoding Charset defined by appConfiguration project.encoding.charset

APPLICATION_EXTENSION

public String APPLICATION_EXTENSION

Any default extension to apply to the user facing site/pages defined by appConfiguration site.ext

MODULE_EXTENSION

public String MODULE_EXTENSION

Any default extension to apply to the admin/module based site/pages defined by adminConfiguration module.ext

DEFAULT_DISPLAY_PAGE_SIZE

public int DEFAULT_DISPLAY_PAGE_SIZE

For admin Grids the Page size is defined by adminConfiguration data.table.page.size

RESOURCE_REL_TO_WEB_CNTXT

public Boolean RESOURCE_REL_TO_WEB_CNTXT

If images/resources are loaded relative to Web-Context or absolute, defined by appConfiguration site.resources.folder.mode.relative

RESOURCE_FOLDER_BASE_PATHS

public List<String> RESOURCE_FOLDER_BASE_PATHS

Defined by appConfiguration site.resources.folder.base

DEFAULT_LOCALE

public Locale DEFAULT_LOCALE

Locale as null is not good. Application should use a default Locale

appUserType

public Class appUserType

Application default user Type (Class)

Default value:

Class BasicUser

WICKET_CONTAINER_FACTORY

public SpringConfiguredContainerFactory WICKET_CONTAINER_FACTORY

See Also:

SpringConfiguredContainerFactory

LICENSED_TO

public static String LICENSED_TO

LICENSE_ISSUER

public static String LICENSE_ISSUER

LICENSE_EXPIRES

public static Date LICENSE_EXPIRES

CDN_LOCATION

public String CDN_LOCATION

Location/Name for a Content Delivery Network
This is useful to set the base URL's for all resources if we wish to fetch them from a CDN
The CDN Location should be independent of any protocol; and should represent the Domain Name.

Defined by appConfiguration cdn.location

Default value:

null

DATE_FORMAT_PATTERN

public String DATE_FORMAT_PATTERN

DATE_FORMAT

public SimpleDateFormat DATE_FORMAT

configs

protected static ThreadLocal<AppSettings> configs

Constructor Detail

AppSettings

public AppSettings()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

init

@PostConstruct
public final void init()
                               throws Exception

Throws:

Exception

setAppSettings

public void setAppSettings()

set

public static void set(AppSettings appSettings)

get

public static AppSettings get()

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

getAppConfiguration

public Properties getAppConfiguration()

setAppConfiguration

public void setAppConfiguration(Properties appConfiguration)

getAdminConfiguration

public Properties getAdminConfiguration()

setAdminConfiguration

public void setAdminConfiguration(Properties adminConfiguration)

getCONTEXT_BASE_ABSOLUTE_PATH

public String getCONTEXT_BASE_ABSOLUTE_PATH()

setCONTEXT_BASE_ABSOLUTE_PATH

public void setCONTEXT_BASE_ABSOLUTE_PATH(String cONTEXT_BASE_ABSOLUTE_PATH)

getAPPLICATION_ENCODING_CHARSET

public String getAPPLICATION_ENCODING_CHARSET()

setAPPLICATION_ENCODING_CHARSET

public void setAPPLICATION_ENCODING_CHARSET(String aPPLICATION_ENCODING_CHARSET)

getAPPLICATION_EXTENSION

public String getAPPLICATION_EXTENSION()

setAPPLICATION_EXTENSION

public void setAPPLICATION_EXTENSION(String aPPLICATION_EXTENSION)

getMODULE_EXTENSION

public String getMODULE_EXTENSION()

setMODULE_EXTENSION

public void setMODULE_EXTENSION(String mODULE_EXTENSION)

getDEFAULT_DISPLAY_PAGE_SIZE

public int getDEFAULT_DISPLAY_PAGE_SIZE()

setDEFAULT_DISPLAY_PAGE_SIZE

public void setDEFAULT_DISPLAY_PAGE_SIZE(int dEFAULT_DISPLAY_PAGE_SIZE)

getRESOURCE_REL_TO_WEB_CNTXT

public Boolean getRESOURCE_REL_TO_WEB_CNTXT()

setRESOURCE_REL_TO_WEB_CNTXT

public void setRESOURCE_REL_TO_WEB_CNTXT(Boolean rESOURCE_REL_TO_WEB_CNTXT)

getRESOURCE_FOLDER_BASE_PATHS

public List<String> getRESOURCE_FOLDER_BASE_PATHS()

setRESOURCE_FOLDER_BASE_PATHS

public void setRESOURCE_FOLDER_BASE_PATHS(List<String> rESOURCE_FOLDER_BASE_PATHS)

getDEFAULT_LOCALE

public Locale getDEFAULT_LOCALE()

setDEFAULT_LOCALE

public void setDEFAULT_LOCALE(Locale dEFAULT_LOCALE)

getAuthModule

public AuthorizationModule getAuthModule()

setAuthModule

public void setAuthModule(AuthorizationModule authModule)