org.apache.struts.chain.commands: public class: RemoveCachedMessages

org.apache.struts.chain.commands
public class: RemoveCachedMessages [javadoc | source]

java.lang.Object
   org.apache.struts.chain.commands.ActionCommandBase
      org.apache.struts.chain.commands.RemoveCachedMessages

All Implemented Interfaces:
ActionCommand

Remove cached messages stored in the session.

version: $ - Id: RemoveCachedMessages.java 471754 2006-11-06 14:55:09Z husted $

since: Struts - 1.3.5

Method from org.apache.struts.chain.commands.RemoveCachedMessages Summary:
execute

Methods from org.apache.struts.chain.commands.ActionCommandBase:
execute, execute

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.struts.chain.commands.RemoveCachedMessages Detail:
public boolean execute(ActionContext actionCtx) throws Exception { // Get session scope Map session = actionCtx.getSessionScope(); // Remove messages as needed removeAccessedMessages(session, Globals.MESSAGE_KEY); // Remove error messages as needed removeAccessedMessages(session, Globals.ERROR_KEY); return false; } Removes any `ActionMessages` object stored in the session under `Globals.MESSAGE_KEY` and `Globals.ERROR_KEY` if the messages' `isAccessed` method returns true. This allows messages to be stored in the session, displayed one time, and be released here.

Method from org.apache.struts.chain.commands.RemoveCachedMessages Detail:

 public boolean execute(ActionContext actionCtx) throws Exception {
        // Get session scope
        Map session = actionCtx.getSessionScope();
        // Remove messages as needed
        removeAccessedMessages(session, Globals.MESSAGE_KEY);
        // Remove error messages as needed
        removeAccessedMessages(session, Globals.ERROR_KEY);
        return false;
}

Removes any ActionMessages object stored in the session under Globals.MESSAGE_KEY and Globals.ERROR_KEY if the messages' isAccessed method returns true. This allows messages to be stored in the session, displayed one time, and be released here.