| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:09 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JESTCommand (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JESTCommand (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JESTCommand.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/IOR.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.Format.html" title="enum in org.apache.openjpa.persistence.jest"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/JESTCommand.html" target="_top">Frames</a></li> |
| <li><a href="JESTCommand.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.persistence.jest</div> |
| <h2 title="Interface JESTCommand" class="title">Interface JESTCommand</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/persistence/jest/PropertiesCommand.html" title="class in org.apache.openjpa.persistence.jest">PropertiesCommand</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">JESTCommand</span></pre> |
| <div class="block">Interface for JEST commands. A JEST command denotes a JPA operation such as <code>find</code>, |
| <code>query</code> or <code>domain</code>. Besides signifying a JPA operation, a command may have |
| zero or more qualifiers and arguments. |
| <br> |
| A qualifier qualifies the action to be performed. For example, a <code>query</code> command may be qualified |
| to return a single instance as its result, or limit its result to first 20 instances etc. |
| <br> |
| An argument is an argument to the target JPA method. For example, <code>find</code> command has |
| arguments for the type of the instance and the primary key. A <code>query</code> command has the |
| query string as its argument. |
| <p> |
| A concrete command instance is an outcome of parsing a <code>request</code>. |
| The <code>path</code> segments are parsed for qualifiers. |
| The <code>query string</code> is parsed for the arguments. |
| <p> |
| 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<br> |
| <code>http://www.jpa.com/jest/find/plan=myPlan?type=Person&1234</code><br> |
| with context root <code>http://www.jpa.com/jest</code> has the servlet path <code>/find/plan=myPlan</code> |
| and query string <code>type=Person&1234</code>. |
| <br> |
| The first path segment <code>find</code> will determine that the command is to <em>find</em> a |
| persistent entity of type <code>Person</code> and primary key <code>1234</code> using a fetch plan |
| named <code>myPlan</code>.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Pinaki Poddar</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.Format.html" title="enum in org.apache.openjpa.persistence.jest">JESTCommand.Format</a></strong></code> |
| <div class="block">Supported format monikers.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#getArgument(java.lang.String)">getArgument</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get the value of this command's argument of the given name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#getArguments()">getArguments</a></strong>()</code> |
| <div class="block">Get this command's arguments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/jest/JPAServletContext.html" title="interface in org.apache.openjpa.persistence.jest">JPAServletContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#getExecutionContext()">getExecutionContext</a></strong>()</code> |
| <div class="block">Get the execution context of this command.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#getQualifier(java.lang.String)">getQualifier</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Get the value of this command's qualifier of the given name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#getQualifiers()">getQualifiers</a></strong>()</code> |
| <div class="block">Get this command's qualifiers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#hasArgument(java.lang.String)">hasArgument</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Affirm this command contains an argument of the given name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#hasQualifier(java.lang.String)">hasQualifier</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> |
| <div class="block">Affirm this command contains an qualifier of the given name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#parse()">parse</a></strong>()</code> |
| <div class="block">Parse the given request to populate qualifiers and parameters of this command.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.html#process()">process</a></strong>()</code> |
| <div class="block">Process the given request and write the output on to the given response in the given context.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getExecutionContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionContext</h4> |
| <pre><a href="../../../../../org/apache/openjpa/persistence/jest/JPAServletContext.html" title="interface in org.apache.openjpa.persistence.jest">JPAServletContext</a> getExecutionContext()</pre> |
| <div class="block">Get the execution context of this command.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the execution context. never null.</dd></dl> |
| </li> |
| </ul> |
| <a name="parse()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre>void parse() |
| throws <a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest">ProcessingException</a></pre> |
| <div class="block">Parse the given request to populate qualifiers and parameters of this command. |
| A command can interpret and consume certain path segments or parameters of the |
| original request. During <code>processing</code> |
| phase, the parameters and qualifiers are accessed from the parsed command itself rather than |
| from the original HTTP request.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest">ProcessingException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="process()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>process</h4> |
| <pre>void process() |
| throws <a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest">ProcessingException</a>, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Process the given request and write the output on to the given response in the given context.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest">ProcessingException</a></code></dd> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getArguments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArguments</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getArguments()</pre> |
| <div class="block">Get this command's arguments.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| <a name="getArgument(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgument</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getArgument(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get the value of this command's argument of the given name.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>null if the argument does not exist.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| <a name="hasArgument(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasArgument</h4> |
| <pre>boolean hasArgument(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Affirm this command contains an argument of the given name.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| <a name="getQualifiers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifiers</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getQualifiers()</pre> |
| <div class="block">Get this command's qualifiers.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| <a name="getQualifier(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifier</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getQualifier(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Get the value of this command's qualifier of the given name.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>null if the qualifier does not exist.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| <a name="hasQualifier(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>hasQualifier</h4> |
| <pre>boolean hasQualifier(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| <div class="block">Affirm this command contains an qualifier of the given name.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if accessed prior to parsing.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JESTCommand.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/IOR.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/JESTCommand.Format.html" title="enum in org.apache.openjpa.persistence.jest"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/JESTCommand.html" target="_top">Frames</a></li> |
| <li><a href="JESTCommand.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |