| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc (1.8.0_92) on Mon Aug 13 15:36:38 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>org.apache.olingo.server.api.processor (Olingo-OData 4.5.0 API)</title> | |
| <meta name="date" content="2018-08-13"> | |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> | |
| <script type="text/javascript" src="../../../../../../script.js"></script> | |
| </head> | |
| <body> | |
| <script type="text/javascript"><!-- | |
| try { | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="org.apache.olingo.server.api.processor (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| </script> | |
| <noscript> | |
| <div>JavaScript is disabled on your browser.</div> | |
| </noscript> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <div class="topNav"><a name="navbar.top"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.top.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> | |
| <li class="navBarCell1Rev">Package</li> | |
| <li>Class</li> | |
| <li><a href="package-use.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/olingo/server/api/prefer/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../org/apache/olingo/server/api/serializer/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/package-summary.html" target="_top">Frames</a></li> | |
| <li><a href="package-summary.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> | |
| <a name="skip.navbar.top"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <div class="header"> | |
| <h1 title="Package" class="title">Package org.apache.olingo.server.api.processor</h1> | |
| <div class="docSummary"> | |
| <div class="block">Olingo Processors</div> | |
| </div> | |
| <p>See: <a href="#package.description">Description</a></p> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> | |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Interface</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tbody> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionComplexCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of ComplexCollection.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionComplexProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionComplexProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of Complex.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionEntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionEntityCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of Entity Collection.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionEntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionEntityProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of Entity.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionPrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionPrimitiveCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of Primitive Collection.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionPrimitiveProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionPrimitiveProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with a return type of Primitive.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ActionVoidProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionVoidProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an action request with no return type.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/BatchProcessor.html" title="interface in org.apache.olingo.server.api.processor">BatchProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a single instance of an Entity Type.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ComplexCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a collection of complex-type instances, e.g., | |
| a property of an entity defined as collection of complex-type instances.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ComplexProcessor.html" title="interface in org.apache.olingo.server.api.processor">ComplexProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an instance of a complex type, e.g., a complex property of an entity.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/CountComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountComplexCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling counting a collection of complex properties, e.g.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/CountEntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountEntityCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling counting a collection of entities, e.g.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/CountPrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountPrimitiveCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling counting a collection of primitive properties, e.g.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/DeltaProcessor.html" title="interface in org.apache.olingo.server.api.processor">DeltaProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a single instance of an Delta Response.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/EntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">EntityCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a collection of entities, e.g., an Entity Set.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/EntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">EntityProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a single instance of an Entity Type.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ErrorProcessor.html" title="interface in org.apache.olingo.server.api.processor">ErrorProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor which is called if any error/exception occurs inside the library or another processor.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/MediaEntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">MediaEntityProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling Entity Media.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/MetadataProcessor.html" title="interface in org.apache.olingo.server.api.processor">MetadataProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling the metadata document.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a collection of primitive-type instances, e.g., | |
| a property of an entity defined as collection of primitive-type instances.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveValueProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveValueProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling an instance of a primitive type, e.g., a primitive property of an entity.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/Processor.html" title="interface in org.apache.olingo.server.api.processor">Processor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Base interface for all processor types.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ReferenceCollectionProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a collection an Entity References.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceProcessor.html" title="interface in org.apache.olingo.server.api.processor">ReferenceProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling a single instance of an Entity Reference.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/ServiceDocumentProcessor.html" title="interface in org.apache.olingo.server.api.processor">ServiceDocumentProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor interface for handling the service document.</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| <li class="blockList"> | |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> | |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Class</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tbody> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/server/api/processor/DefaultProcessor.html" title="class in org.apache.olingo.server.api.processor">DefaultProcessor</a></td> | |
| <td class="colLast"> | |
| <div class="block">Processor implementation for handling default cases: | |
| request for the metadata document | |
| request for the service document | |
| error handling</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| </ul> | |
| <a name="package.description"> | |
| <!-- --> | |
| </a> | |
| <h2 title="Package org.apache.olingo.server.api.processor Description">Package org.apache.olingo.server.api.processor Description</h2> | |
| <div class="block">Olingo Processors | |
| <p>Processors are used to handle OData requests and send back the OData reponse. | |
| Before a specific processor is called the Olingo library will parse the URI and validate it. | |
| Afterwards the Processor which matches the return type is called. | |
| Example: If a primitive property is requested by the URI we will call the | |
| PrimitiveProcessor.readPrimitive method.</p> | |
| <p>Processors can be registered at the <a href="../../../../../../org/apache/olingo/server/api/ODataHttpHandler.html" title="interface in org.apache.olingo.server.api"><code>ODataHttpHandler</code></a> object. | |
| Per default the <a href="../../../../../../org/apache/olingo/server/api/processor/DefaultProcessor.html" title="class in org.apache.olingo.server.api.processor"><code>DefaultProcessor</code></a> is registered | |
| to perform basic functionality like delivering the metadata and service documents, respectively, | |
| as well as rendering an OData error. | |
| In case an application would like to perform custom tasks for these cases a new | |
| <a href="../../../../../../org/apache/olingo/server/api/processor/ServiceDocumentProcessor.html" title="interface in org.apache.olingo.server.api.processor"><code>ServiceDocumentProcessor</code></a> can be registered | |
| in order to overwrite the default behavior.</div> | |
| </div> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <div class="bottomNav"><a name="navbar.bottom"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.bottom.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> | |
| <li class="navBarCell1Rev">Package</li> | |
| <li>Class</li> | |
| <li><a href="package-use.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/olingo/server/api/prefer/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../org/apache/olingo/server/api/serializer/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/package-summary.html" target="_top">Frames</a></li> | |
| <li><a href="package-summary.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> | |
| <a name="skip.navbar.bottom"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <p class="legalCopy"><small>Copyright © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |