Class AppMessageResources

java.lang.Object
org.apache.struts.util.MessageResources
org.apache.struts.util.PropertyMessageResources
com.softslate.commerce.customer.core.AppMessageResources
All Implemented Interfaces:
Serializable

public class AppMessageResources extends org.apache.struts.util.PropertyMessageResources
Extension of the Struts PropertyMessageResources class which wraps a second PropertyMessageResources object holding custom application messages.

Messages that come distributed with the application are stored in the application.properties files under the "/WEB-INF/classes/resources" directory. These files may be overwritten with a future upgrade, if new messages need to be added to the files. In order to make use of the Struts MessageResources facility for custom messages, this class automatically creates a second AppMessageResources object from a file named application-custom.properties in the same directory as the distributed application.properties file. Custom messages can safely be placed in these application-custom.properties files because they will not be overwritten during an upgrade.

This class overrides a constructor method, to create the second, custom AppMessageResources object from the application-custom.properties file. It also overrides the getMessage method to look for a message first in the custom object before attempting to find it in the original AppMessageResources object. This allows users to override the default messages with custom ones.

Author:
David Tobey
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • log

      static org.apache.commons.logging.Log log
    • isChild

      boolean isChild
    • customMessageResources

      AppMessageResources customMessageResources
  • Constructor Details

    • AppMessageResources

      public AppMessageResources(org.apache.struts.util.MessageResourcesFactory factory, String config, boolean returnNull, boolean isChild)
  • Method Details

    • getCustomMessageResources

      public AppMessageResources getCustomMessageResources()
    • setCustomMessageResources

      public void setCustomMessageResources(AppMessageResources customMessageResources)
    • getMessage

      public String getMessage(Locale locale, String key)
      Overrides:
      getMessage in class org.apache.struts.util.PropertyMessageResources
    • getMessages

      public Map getMessages()
    • getLocales

      public Map getLocales()
    • getFormats

      public Map getFormats()
    • messageKeyPublic

      public String messageKeyPublic(String locale, String key)