|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommandProcessor
This interfaces defines the contract and lifecycle of a Servlet Command Processor.
A command processor is defined as a class capable of executing a set of related Command objects. It performs the bulk of the work for the command servlet. The processor impl is responsible for validating that the command can be processed (given the supplied remaining URL arguments from the servlet) and processing the command. It is also responsible for supply an output status page on successfuly execution of the command.
The arguments passed to a Command Processor are the remaining URL elements from the command servlet URL after removing the web-app name, servlet name and command processor name.
Method Summary | |
---|---|
void |
outputStatus(java.io.PrintWriter out)
Output a simple status message to the supplied PrintWriter. |
void |
process(org.alfresco.service.ServiceRegistry serviceRegistry,
javax.servlet.http.HttpServletRequest request,
java.lang.String command)
Process the supplied command name. |
boolean |
validateArguments(javax.servlet.ServletContext sc,
java.lang.String command,
java.util.Map args,
java.lang.String[] urlElements)
Pass and validate URL arguments for the command processor. |
Method Detail |
---|
boolean validateArguments(javax.servlet.ServletContext sc, java.lang.String command, java.util.Map args, java.lang.String[] urlElements)
sc
- ServletContext, can be used to retrieve ServiceRegistry instance
from the Repository bean.command
- Name of the command the arguments are forargs
- Map of URL args passed to the command servleturlElements
- String[] of the remaining URL arguments to the command servlet
void process(org.alfresco.service.ServiceRegistry serviceRegistry, javax.servlet.http.HttpServletRequest request, java.lang.String command)
serviceRegistry
- ServiceRegistryrequest
- HttpServletRequestcommand
- Name of the command to construct and executevoid outputStatus(java.io.PrintWriter out)
out
- PrintWriter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |