com.iplanet.jato.view.command
Class DefaultRequestHandlingCommand

java.lang.Object
  |
  +--com.iplanet.jato.view.command.DefaultRequestHandlingCommand
All Implemented Interfaces:
Command

public class DefaultRequestHandlingCommand
extends java.lang.Object
implements Command

The default command used to handle client requests. This command will dispatch the request to a handler method on the parent container view of the activated CommandField.

All event handling methods have the same name of the following form:

    handle<Command field name>Request(...)
 
This implementation searches for event handling methods by signature in the following order:

    public void handle<Command field name>Request(RequestInvocationEvent event)
    public void handle<Command field name>Request(RequestContext requestContext)  (for backward compatibility)
 
If the activated command child is an image button or HREF, then this implementation searches for event handling methods by signature in the following order:

    public void handle<Command field name>Request(RequestInvocationEvent event)
    public void handle<Command field name>Request(RequestContext requestContext, 
        int imageXCoordinate, int imageYCoordinate)  (for backward compatibility)
    public void handle<Command field name>Request(RequestContext requestContext)  (for backward compatibility)
 
In both cases, the event signatures without RequestInvocatinEvent are for backward compatibility with older JATO applications and should not be used in new JATO applications. Also, in both cases, the expanded handler method signature with image coordinates is optional, and if not found, the request will be dispatched to the default handler method signature.

Note that the throws clause of handler methods need not declare any particular exceptions except those that the developer wishes to throw from the method.>p> The expected behavior of the request event handling method is to forward the request to another JSP/view bean/resource, preparing the target in any way necessary to support the request. Note that the current request context has already been set on the target parent container when the event handler method is called by virtue of the RequestParticipant interface.

Since:
JATO/1.2
Version:
JATO/1.2.2 $Id: DefaultRequestHandlingCommand.java,v 1.9 2002/03/16 03:26:42 todd Exp $

Field Summary
static CommandDescriptor COMMAND_DESCRIPTOR
           
static java.lang.String HANDLE_REQUEST_METHOD_PREFIX
           
static java.lang.String HANDLE_REQUEST_METHOD_SUFFIX
           
static boolean OPTION_FALLBACK_TO_LEGACY_REQUEST_EVENT_SIGNATURES
           
 
Fields inherited from interface com.iplanet.jato.command.Command
DEFAULT_OPERATION_NAME
 
Constructor Summary
DefaultRequestHandlingCommand()
          Default constructor
 
Method Summary
 void execute(CommandEvent anEvent)
          Called to execute the command.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HANDLE_REQUEST_METHOD_PREFIX

public static final java.lang.String HANDLE_REQUEST_METHOD_PREFIX

HANDLE_REQUEST_METHOD_SUFFIX

public static final java.lang.String HANDLE_REQUEST_METHOD_SUFFIX

COMMAND_DESCRIPTOR

public static final CommandDescriptor COMMAND_DESCRIPTOR

OPTION_FALLBACK_TO_LEGACY_REQUEST_EVENT_SIGNATURES

public static final boolean OPTION_FALLBACK_TO_LEGACY_REQUEST_EVENT_SIGNATURES
Constructor Detail

DefaultRequestHandlingCommand

public DefaultRequestHandlingCommand()
Default constructor
Method Detail

execute

public void execute(CommandEvent anEvent)
             throws CommandException
Called to execute the command.
Specified by:
execute in interface Command
Parameters:
event - The command event, contains information pertinent to to the invocation of this command
Throws:
CommandException - Thrown if an error occurs executing the command