Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata2 / org / apache / olingo / odata2 / api / processor / package-summary.html
blob: 456f4387e553d1593c6f5d5a26b765b8e0bd3c5f [file] [log] [blame]
<!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 Wed Dec 06 14:36:24 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.odata2.api.processor (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<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.odata2.api.processor (olingo-odata2-parent 2.0.10 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/odata2/api/exception/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/processor/feature/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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&nbsp;org.apache.olingo.odata2.api.processor</h1>
<div class="docSummary">
<div class="block">Data Processor</div>
</div>
<p>See:&nbsp;<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">&nbsp;</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/odata2/api/processor/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext</a></td>
<td class="colLast">
<div class="block">Compilation of generic context objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataContext.RuntimeMeasurement.html" title="interface in org.apache.olingo.odata2.api.processor">ODataContext.RuntimeMeasurement</a></td>
<td class="colLast">
<div class="block">Runtime measurements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataErrorCallback.html" title="interface in org.apache.olingo.odata2.api.processor">ODataErrorCallback</a></td>
<td class="colLast">
<div class="block">This interface is called if an error occurred and is process inside the exception mapper.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataProcessor.html" title="interface in org.apache.olingo.odata2.api.processor">ODataProcessor</a></td>
<td class="colLast">
<div class="block">An <code>ODataProcessor</code> is the root interface for processor implementation.</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">&nbsp;</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/odata2/api/processor/ODataErrorContext.html" title="class in org.apache.olingo.odata2.api.processor">ODataErrorContext</a></td>
<td class="colLast">
<div class="block">Error context information bean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataRequest.html" title="class in org.apache.olingo.odata2.api.processor">ODataRequest</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataRequest.ODataRequestBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataRequest.ODataRequestBuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse</a></td>
<td class="colLast">
<div class="block">An <code>ODataResponse</code> is usually created by an <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataProcessor.html" title="interface in org.apache.olingo.odata2.api.processor"><code>ODataProcessor</code></a> during request handling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.ODataResponseBuilder.html" title="class in org.apache.olingo.odata2.api.processor">ODataResponse.ODataResponseBuilder</a></td>
<td class="colLast">
<div class="block">Implementation of the builder pattern to create instances of this type of object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor">ODataSingleProcessor</a></td>
<td class="colLast">
<div class="block">A default <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataProcessor.html" title="interface in org.apache.olingo.odata2.api.processor"><code>ODataProcessor</code></a> that implements all processor features in a single class.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.api.processor Description">Package org.apache.olingo.odata2.api.processor Description</h2>
<div class="block">Data Processor<p>
A data processor implements all create, read, update and delete (CRUD) methods of an OData service. A processor as
part of a OData service implementation is created by the service factory and then called during request handling.
In dependency of the http context (http method, requestheaders ...) and the parsed uri semantic the OData Library
will call an appropriate processor method. Within this method a service can perform operations on data. In a final
step the data result can be transformed using a <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProvider.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProvider</code></a> (for Json,
Atom and XML) and is returned as
a <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataResponse.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataResponse</code></a>.
<p>
A processor gets access to context information either via method parameters or a
<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataContext.html" title="interface in org.apache.olingo.odata2.api.processor"><code>ODataContext</code></a> which is attached
to the processor object.
<p>
A processor can support optional features <a href="../../../../../../org/apache/olingo/odata2/api/processor/feature/package-summary.html"><code>org.apache.olingo.odata2.api.processor.feature</code></a> and implement
parts <a href="../../../../../../org/apache/olingo/odata2/api/processor/part/package-summary.html"><code>org.apache.olingo.odata2.api.processor.part</code></a> which is more or less a grouping for different OData CRUD
operations.
<p> <a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataSingleProcessor</code></a> is a convenience abstract class that
implements all interface parts and has default implementations
for handling OData service document and metadata. Usually the
<a href="../../../../../../org/apache/olingo/odata2/api/processor/ODataSingleProcessor.html" title="class in org.apache.olingo.odata2.api.processor"><code>ODataSingleProcessor</code></a> is used together with a
<code>ODataSingleService</code> default implementation.</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/odata2/api/exception/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/olingo/odata2/api/processor/feature/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/processor/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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 &#169; 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>