...

3. Standard Resources / ResourcesFactory Implementations

...

Commons 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="7653dd50-edc5-4f3c-bd46-2103a1525a48"><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="9b45389e-c910-4165-8bad-7b73337c7bf1"><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="cc20b783-43d9-4687-9fc9-8d74390c8a84"><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="8e2f8a57-427e-422a-80fe-9b1c56676504"><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="9c9b6200-db3f-442e-8594-4f4d704f403a"><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="099ac7ed-cee9-49de-be3b-4dc3a5379114"><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:

...

File	Locale Suffix	for
c:/myapp/foo/Bar.properties		default resources
c:/myapp/foo/Bar_en.properties	en	English resources
c:/myapp/foo/Bar_en_US.properties	en_US	US English resources
c:/myapp/foo/Bar_fren_GB.properties	en_GB	UK English resources

...

No Format
// Create the ResourcesFactory ResourcesFactory factory = new PropertyResourcesFactory(); // Create the Resources Resources resources = factory.createResourcesgetResources("Bar", "file:c:/myapp/foo/Bar"); // Retrieve an i18n String value String msg = resources.getString("some.key", locale, null);

...

See *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... ...

In these XML files, you specify resources in the following way...

     <resources>

           <resource id="error.date">
                 Date is invalid.
           </resource>

           <resource id="error.number">
                 Number is invalid.
           </resource>

     </resources>

To use XMLResources, you create it using it's factory and then use in the normal way...

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

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

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

Wiki MarkupSee *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:

...

       // Create the ResourcesFactory
       ResourcesFactory factory = new JDBCResourcesFactory();

       // Create the Resources
       Resources resources = factory.createResourcesgetResources("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....

       // Create the ResourcesFactory
       ResourcesFactory factory = new WebappPropertyResourcesFactory();
       factory.setServletContext(servletContext);

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

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

...

See *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....

       // Create the ResourcesFactory
       ResourcesFactory factory = new WebappXMLResourcesFactory();
       factory.setServletContext(servletContext);

       // Create the Resources
       Resources resources = factory.createResourcesgetResources("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

...

       // Create the ResourcesFactory
       ResourcesFactory factory = new ResourceBundleResourcesFactory();

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

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

...

See *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.

...