Versions Compared

Old Version 4

changes.mady.by.user ASF Infrabot

Saved on

compared with

New Version Current

changes.mady.by.user ASF Infrabot

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: converted to 1.6 markup

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="53520bef-c01d-4eee-87f3-96ce4fac7f20"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/ Home]

[wiki:Resources Wiki] [wiki

:ResourcesUserGuide Guide]

[wiki:ResourcesUserGuideIntro Getting Started] [

wiki:ResourcesUserGuideMessages Messages]

[wiki:ResourcesUserGuideImplementations Standard] [wiki

:ResourcesUserGuideCreating Creating]

[http://jakarta.apache.org/commons/resources/apidocs/ API] [http://jakarta.apache.org/commons/resources/xref/

Source] ]]></ac:plain-text-body></ac:structured-macro>

...

3. Standard Resources / ResourcesFactory Implementations

Wiki MarkupCommons Resources ships with the following implementations of \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Resources.html Resources\] and \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/ResourcesFactory.html ResourcesFactory\] provided:

Resources

ResourcesFactory

Description<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7ee71201-b1e5-4b6b-ae85-86b443d1e682"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResources.html PropertyResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResourcesFactory.html

PropertyResourcesFactory]

retrieves values from properties files

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a0cb8a2e-f7be-491a-9fe9-951ed64c9fad"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResources.html XMLResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResourcesFactory.html

XMLResourcesFactory]

retrieves values from XML documents

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a80d1783-b588-42d7-8a04-f7c3bc2b47bd"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResources.html JDBCResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResourcesFactory.html

PropertyResourcesFactory]

retrieves values from a database using JDBC

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="71d324d7-a56c-4587-a45c-bf3f20c8fc92"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResources.html WebappPropertyResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.html

WebappPropertyResourcesFactory]

Web App: retrieves values from properties files.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="eaa7c90f-4488-42e4-8a7b-28c570532d24"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResources.html WebappXMLResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResourcesFactory.html

WebappXMLResourcesFactory]

Web App: retrieves values from XML documents

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="be14fbe5-e032-4fdc-8a71-f994e5b39d70"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResources.html ResourceBundleResources] [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html

ResourceBundleResourcesFactory]

wraps java.util.ResourceBundle]]></ac:plain-text-body></ac:structured-macro>

The following sections describe how to use these implementations:

...

No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new PropertyResourcesFactory();

       // Create the Resources
       Resources resources = factory.getResources("Bar", "file:c:/myapp/foo/Bar");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

Wiki MarkupSee *PropertyResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResources.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/PropertyResources.html source\] and *PropertyResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/PropertyResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/PropertyResourcesFactory.html source\] /
source and PropertyResourcesFactory JavaDoc / source.

...

3.2 XML Resources

XMLResources works in pretty much the same way as PropertyResources, except the files are in XML format and XMLResources assumes a .xml file extension. Using the same example, if the configuration URL is passed as file:c:/myapp/foo/Bar then... ...

...

No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new XMLResourcesFactory();

       // Create the Resources
       Resources resources = factory.getResources("Bar", "file:c:myapp/foo/Bar");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

...

See  *XMLResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/XMLResources.html source\] and *XMLResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/XMLResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/XMLResourcesFactory.html source\] /
 source and XMLResourcesFactory JavaDoc / source.
...
3.3 JDBC Resources
JDBCResources retrieves messages from a database using JDBC. The table you use to store the messages needs three columns containing:
...
 No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new JDBCResourcesFactory();

       // Create the Resources
       Resources resources = factory.getResources("Bar", "file:c:myapp/foo/Bar");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

...
See  *JDBCResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/JDBCResources.html source\] and *JDBCResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/JDBCResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/JDBCResourcesFactory.html source\] /
 source and JDBCResourcesFactory JavaDoc / source.
...
3.4 Web Application Property Resources
WebappPropertyResources works the same way as PropertyResources, but in a Web Application environment. The only difference is you specify a context relative URL and you need to initialize the ServletContext....
 No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new WebappPropertyResourcesFactory();
       factory.setServletContext(servletContext);

       // Create the Resources
       Resources resources = factory.getResources("Bar", "/org/apache/struts/Bar");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

 Wiki MarkupSee  *WebappPropertyResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappPropertyResources.html source\] and *WebappPropertyResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappPropertyResourcesFactory.html source\] /
 source and WebappPropertyResourcesFactory JavaDoc / source.
...
3.5 Web Application XML Resources
WebappXMLResources works the same way as XMLResources, but in a Web Application environment. The only difference is you specify a context relative URL and you need to initialize the ServletContext....
 No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new WebappXMLResourcesFactory();
       factory.setServletContext(servletContext);

       // Create the Resources
       Resources resources = factory.getResources("Bar", "/org/apache/struts/Bar");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

See Webapp{{`}}{{`}}XMLResources JavaDoc /
 source and WebappXMLResourcesFactory JavaDoc / source Wiki MarkupSee *!WebappXMLResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappXMLResources.html source\] and *WebappXMLResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappXMLResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/WebappXMLResourcesFactory.html source\].
...
3.6 java.util.ResourceBundle Resources
...
 No Format
       // Create the ResourcesFactory
       ResourcesFactory factory = new ResourceBundleResourcesFactory();

       // Create the Resources
       Resources resources = factory.getResources("Bar", "BarResources");

       // Retrieve an i18n String value
       String msg = resources.getString("some.key", locale, null);

 Wiki MarkupSee  *ResourceBundleResources* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResources.html JavaDoc\] /
\[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/ResourceBundleResources.html source\] and *ResourceBundleResourcesFactory* \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html JavaDoc\] / \[http://jakarta.apache.org/commons/resources/xref/org/apache/commons/resources/impl/ResourceBundleResourcesFactory.html source\]. /
 source and ResourceBundleResourcesFactory JavaDoc / source.
...
 Home 
 Wiki 
 Guide 
 Getting Started 
 Messages 
 Standard 
 Creating 
 API 
 Source 
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ef0afaaf-5f2f-48dd-a128-6a559ab262ff"><ac:plain-text-body><![CDATA[
 [http://jakarta.apache.org/commons/resources/ Home] 
 [wiki:Resources Wiki] 
 [wiki:ResourcesUserGuide Guide] 
 [wiki:ResourcesUserGuideIntro Getting Started] 
 [wiki:ResourcesUserGuideMessages Messages] 
 [wiki:ResourcesUserGuideImplementations Standard] 
 [wiki:ResourcesUserGuideCreating Creating] 
 [http://jakarta.apache.org/commons/resources/apidocs/ API] 
 [http://jakarta.apache.org/commons/resources/xref/ Source] 
]]></ac:plain-text-body></ac:structured-macro>