ggrandes / webapp-properties Goto Github PK

View Code? Open in Web Editor NEW

Load Properties from a file into SystemProperties or as an Attribute in ServletContext, using WebappBaseName as reference in a servlet container like Tomcat

License: Apache License 2.0

Java 100.00%

webapp-properties's Introduction

webapp-properties

Load Properties from a file into SystemProperties or as an Attribute in ServletContext, using WebappBaseName as reference in a servlet container like Tomcat. Open Source Java project under Apache License v2.0

Current Stable Version is 1.0.0

DOC

Installation:

Place webapp-properties-x.x.x.jar in tomcat/lib/

Configuration:

<!-- Context Listener for Servlet Container -->
<!-- tomcat/conf/web.xml or WEB-INF/web.xml -->
<listener>
	<description>Load Properties from a file into SystemProperties or as an Attribute in ServletContext, using WebappBaseName as reference</description>
	<listener-class>org.javastack.webappproperties.WebAppPropertiesContextListener</listener-class>
</listener>

Note: If you have more than one webapp per JVM and you are loading this to system-properties without SystemClassLoaderProperties the keys with same name can collide and view unexpected values. Properties as Attribute in ServletContext may be better alternative than Global System Properties.

Naming conventions and order of load:

Default system properties (never overwrite existing property): {baseDir}/appconf/{webappBaseName}/system-properties-default.properties
Forced system properties (always overwrite existing property): {baseDir}/appconf/{webappBaseName}/system-properties-forced.properties
Context Attribute properties: {baseDir}/appconf/{webappBaseName}/context.properties

`{webappBaseName}` follow the Tomcat Basenames convention

Resolution order of `{baseDir}` (system property):

org.javastack.webappproperties.conf
catalina.base
catalina.home
user.dir

pick next system property if key is not defined.

Usage of Context Attribute properties:

final String CONST_CONTEXT_ATTRIBUTE_NAME = "org.javastack.webappproperties.ctx";
final Properties p = (Properties) getServletContext().getAttribute(CONST_CONTEXT_ATTRIBUTE_NAME);

MAVEN

<dependency>
    <groupId>org.javastack</groupId>
    <artifactId>webapp-properties</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>

Inspired in SystemClassLoaderProperties and CatalinaProperties, this code is Java-minimalistic version.

Recommend Projects