Tutorials : Handling Messages, Errors and Exceptions in Struts 1.1 :

Looking inside the ActionMessage(s) classes

You've seen how to put data inside the ActionMessage and ActionMessages classes, but it's also possible to pull data out again without having to use the Struts tags. You'd want to do this if you had to write your own tags for displaying messages. Here, first, are the methods you'd have to know from the classes:

Class Method Purpose
ActionMessages Iterator properties() Get the "labels" you used when storing the ActionMessage instances
-"- Iterator get(String property) Get the ActionMessage objects 
ActionMessage String getKey() Get the message key for this message
-"- Object[] getValues() Get the replacement values for this message 

You'll also need to know how to find the ActionMessages object. Struts stores it in the request object using the string value "org.apache.struts.action.ACTION_MESSAGE". This value should not be hard coded, but taken from the org.apache.struts.Globals class, which contains most of the keys used for storing various objects. We can also find a pointer to the message resources in the Globals class, and if we want to handle several languages we should also pull out the "locale".

To make it simple here's some code for a jsp-page that peeks into the ActionMessage objects:

Listing 5: The inspectmessages.jsp page

 . .
<%@ page import="java.util.*" %>
<%@ page import="org.apache.struts.*" %>
<%@ page import="org.apache.struts.util.*" %>
<%@ page import="org.apache.struts.action.*" %>

<%
  // Print all attributes in the request object
  out.println("<p><b>All Attributes in request scope:</b>");
  Enumeration paramNames = request.getAttributeNames();
  while (paramNames.hasMoreElements()) {
    String name = (String) paramNames.nextElement();
    Object values = request.getAttribute(name);
    out.println("<br> " + name + ":" + values);
  }
  
  // Print all attributes in the session object
  out.println("<p><b>All Attributes in session scope:</b>");
  paramNames = session.getAttributeNames();
  while (paramNames.hasMoreElements()) {
    String name = (String) paramNames.nextElement();
    Object values = session.getAttribute(name);
    out.println("<br> " + name + ":" + values);
  }

  out.println("<p><b>Data in ActionMessages:</b>");

  // Get the ActionMessages 
  Object o = request.getAttribute(Globals.MESSAGE_KEY);
  if (o != null) {
    ActionMessages ae = (ActionMessages)o;

    // Get the locale and message resources bundle
    Locale locale = 
      (Locale)session.getAttribute(Globals.LOCALE_KEY);
    MessageResources messages = 
      (MessageResources)request.getAttribute
      (Globals.MESSAGES_KEY);

    // Loop thru all the labels in the ActionMessage's  
    for (Iterator i = ae.properties(); i.hasNext();) {
      String property = (String)i.next();
      out.println("<br>property " + property + ": ");

      // Get all messages for this label
      for (Iterator it = ae.get(property); it.hasNext();) {
        ActionMessage a = (ActionMessage)it.next();
        String key = a.getKey();
        Object[] values = a.getValues();
        out.println(" [key=" + key + 
          ", message=" + 
          messages.getMessage(locale,key,values) + 
          "]");
      }
    }
  }
%>
. . .

As you can see, I also print out the objects in the request and session objects. If we have the same data in the ActionMessages object as in Listing 3 we'll get this output from the jsp-page:

All Attributes in request scope: 
. . . (a few lines left out here) . . .
org.apache.struts.action.MESSAGE:
   org.apache.struts.util.PropertyMessageResources@a336d5 
org.apache.struts.action.ACTION_MESSAGE:
   org.apache.struts.action.ActionMessages@3bedc4 

All Attributes in session scope: 
org.apache.struts.action.LOCALE:en 

Data in ActionMessages: 
property message2: [key=data.continue, message=Please continue] 
property message1: [key=data.ok, message=Data saved successfully] 

The two last lines show the same messages as we got from the code in listing 3. At the top you can also identify the request keys for the ActionMessages object and the message resource bundle.

How to Add Java Applets to Your Site

New on the Java Boutique:

New Review:

Time Management Made Easy with the Quartz Enterprise Job Scheduler
Why not just use the Java timer API? This open source scheduling API boasts simplicity, ease-of-integration, a well-rounded feature set, and it's free!

New Applet:

Reverse Complement
Reverse Complement is a simple applet that converts DNA or RNA sequences into three useful formats.

Elsewhere on internet.com:

WebDeveloper Java
Lots of Java information on webdeveloper.com

WDVL Java
Thorough Java resource at the Web Developer's Virtual Library.

ScriptSearch Java
Hundreds of free Java code files to download.

jGuru: Your View of the Java Universe
Customizable portal with online training, FAQs, regular news updates, and tutorials.