org.apache.struts.chain.commands
Class RemoveCachedMessages

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

All Implemented Interfaces:

org.apache.commons.chain.Command, ActionCommand

public class RemoveCachedMessages
extends ActionCommandBase

Remove cached messages stored in the session.

Since:

Struts 1.3.5

Version:

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

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

RemoveCachedMessages()

Method Summary

boolean

execute(ActionContext actionCtx) Removes any ActionMessages object stored in the session under Globals.MESSAGE_KEY and Globals.ERROR_KEY if the messages' isAccessed method returns true.

Methods inherited from class org.apache.struts.chain.commands.ActionCommandBase

execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoveCachedMessages

public RemoveCachedMessages()

Method Detail

execute

public boolean execute(ActionContext actionCtx)
                throws java.lang.Exception

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.

Specified by:

execute in interface ActionCommand

Specified by:

execute in class ActionCommandBase

Parameters:

actionCtx - The Context for the current request

Returns:

false so that processing continues

Throws:

java.lang.Exception - on any error