Java Doc for PropertyReader.java in  » Wiki-Engine » JSPWiki » com » ecyrd » jspwiki » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Wiki Engine » JSPWiki » com.ecyrd.jspwiki 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ecyrd.jspwiki.PropertyReader

PropertyReader
final public class PropertyReader (Code)
Property Reader for the WikiEngine. Reads the properties for the WikiEngine and implements the feature of cascading properties and variable substitution, which come in handy in a multi wiki installation environment: It reduces the need for (shell) scripting in order to generate different jspwiki.properties to a minimum.
author:
   Christoph Sauer
since:
   2.5.x


Field Summary
final public static  StringDEFAULT_PROPERTYFILE
     Path to the default property file.
final public static  StringPARAM_PROPERTYFILE
     The web.xml parameter that defines where the config file is to be found.
final public static  StringPARAM_PROPERTYFILE_CASCADEPREFIX
    
final public static  StringPARAM_VAR_DECLARATION
    
final public static  StringPARAM_VAR_IDENTIFIER
    


Method Summary
public static  voidexpandVars(Properties properties)
     You define a property variable by using the prefix "var.x" as a property.
final public static  PropertiesgetDefaultProperties()
     Returns the default property set as a Properties object.
public static  PropertiesloadWebAppProps(ServletContext context)
     Loads the webapp properties based on servlet context information. Returns a Properties object containing the settings, or null if unable to load it.

Field Detail
DEFAULT_PROPERTYFILE
final public static String DEFAULT_PROPERTYFILE(Code)
Path to the default property file.



PARAM_PROPERTYFILE
final public static String PARAM_PROPERTYFILE(Code)
The web.xml parameter that defines where the config file is to be found. If it is not defined, uses the default as defined by DEFAULT_PROPERTYFILE.



PARAM_PROPERTYFILE_CASCADEPREFIX
final public static String PARAM_PROPERTYFILE_CASCADEPREFIX(Code)



PARAM_VAR_DECLARATION
final public static String PARAM_VAR_DECLARATION(Code)



PARAM_VAR_IDENTIFIER
final public static String PARAM_VAR_IDENTIFIER(Code)





Method Detail
expandVars
public static void expandVars(Properties properties)(Code)
You define a property variable by using the prefix "var.x" as a property. In property values you can then use the "$x" identifier to use this variable. For example you could declare a base directory for all your files like this and use it in all your other property definitions with a "$basedir". Note that it does not matter if you define the variable before its usage.
 var.basedir = /p/mywiki;
 jspwiki.fileSystemProvider.pageDir =         $basedir/www/
 jspwiki.basicAttachmentProvider.storageDir = $basedir/www/
 jspwiki.workDir =                            $basedir/wrk/
 

Parameters:
  properties - - properties to expand;



getDefaultProperties
final public static Properties getDefaultProperties()(Code)
Returns the default property set as a Properties object.



loadWebAppProps
public static Properties loadWebAppProps(ServletContext context)(Code)
Loads the webapp properties based on servlet context information. Returns a Properties object containing the settings, or null if unable to load it. (The default file is WEB-INF/jspwiki.properties, and can be overridden by setting PARAM_PROPERTYFILE in the server or webapp configuration.)

Cascading Properties

You can define additional property files and merge them into the default properties file in a similar process to how you define cascading style sheets; hence we call this cascading property files. This way you can overwrite the default values and only specify the properties you need to change in a multiple wiki environment.

You define a cascade in the context mapping of your servlet container.

 jspwiki.properties.cascade.1
 jspwiki.properties.cascade.2
 jspwiki.properties.cascade.3
 
and so on. You have to number your cascade in a descending way starting with "1". This means you cannot leave out numbers in your cascade. This method is based on an idea by Olaf Kaus, see [JSPWiki:MultipleWikis].



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.