| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface JESTCommand
Interface for JEST commands. A JEST command denotes a JPA operation such as find,
 query or domain. Besides signifying a JPA operation, a command may have
 zero or more qualifiers and arguments. 
 
 A qualifier qualifies the action to be performed. For example, a query command may be qualified
 to return a single instance as its result, or limit its result to first 20 instances etc.
 
 An argument is an argument to the target JPA method. For example, find command has
 arguments for the type of the instance and the primary key. A query command has the
 query string as its argument.
 
 A concrete command instance is an outcome of parsing a request. 
 The path segments are parsed for qualifiers. 
 The query string is parsed for the arguments. 
 
 A JEST command often attaches special semantics to a standard URI syntax. For example, all JEST
 URI enforces that the first segment of a servlet path denotes the command moniker e.g. the URI
 http://www.jpa.com/jest/find/plan=myPlan?type=Person&1234
 with context root http://www.jpa.com/jest has the servlet path /find/plan=myPlan
 and query string type=Person&1234.
 
 The first path segment find will determine that the command is to find a 
 persistent entity of type Person and primary key 1234 using a fetch plan
 named myPlan.
| Nested Class Summary | |
|---|---|
| static class | JESTCommand.FormatSupported format monikers. | 
| Method Summary | |
|---|---|
|  String | getArgument(String key)Get the value of this command's argument of the given name. | 
|  Map<String,String> | getArguments()Get this command's arguments. | 
|  JPAServletContext | getExecutionContext()Get the execution context of this command. | 
|  String | getQualifier(String key)Get the value of this command's qualifier of the given name. | 
|  Map<String,String> | getQualifiers()Get this command's qualifiers. | 
|  boolean | hasArgument(String key)Affirm this command contains an argument of the given name. | 
|  boolean | hasQualifier(String key)Affirm this command contains an qualifier of the given name. | 
|  void | parse()Parse the given request to populate qualifiers and parameters of this command. | 
|  void | process()Process the given request and write the output on to the given response in the given context. | 
| Method Detail | 
|---|
JPAServletContext getExecutionContext()
void parse()
           throws ProcessingException
processing
 phase, the parameters and qualifiers are accessed from the parsed command itself rather than
 from the original HTTP request.
ProcessingException
void process()
             throws ProcessingException,
                    IOException
ProcessingException
IOExceptionMap<String,String> getArguments()
IllegalStateException - if accessed prior to parsing.String getArgument(String key)
IllegalStateException - if accessed prior to parsing.boolean hasArgument(String key)
IllegalStateException - if accessed prior to parsing.Map<String,String> getQualifiers()
IllegalStateException - if accessed prior to parsing.String getQualifier(String key)
IllegalStateException - if accessed prior to parsing.boolean hasQualifier(String key)
IllegalStateException - if accessed prior to parsing.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||