Google Git
Sign in
apache / olingo-site / refs/heads/preview/release-staging / . / output / javadoc / odata4 / org / apache / olingo / server / api / processor / Processor.html
blob: 1275859ba0c4941e28267e5a9277e8315d3b424f [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 Mon Aug 13 15:36:34 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>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="Processor (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Processor.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/processor/PrimitiveValueProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.olingo.server.api.processor</div>
<h2 title="Interface Processor" class="title">Interface Processor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../org/apache/olingo/server/api/processor/ActionComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionComplexCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionComplexProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionComplexProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionEntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionEntityCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionEntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionEntityProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionPrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionPrimitiveCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionPrimitiveProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionPrimitiveProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ActionVoidProcessor.html" title="interface in org.apache.olingo.server.api.processor">ActionVoidProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/BatchProcessor.html" title="interface in org.apache.olingo.server.api.processor">BatchProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ComplexCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ComplexProcessor.html" title="interface in org.apache.olingo.server.api.processor">ComplexProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/CountComplexCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountComplexCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/CountEntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountEntityCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/CountPrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">CountPrimitiveCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/DeltaProcessor.html" title="interface in org.apache.olingo.server.api.processor">DeltaProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/EntityCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">EntityCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/EntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">EntityProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ErrorProcessor.html" title="interface in org.apache.olingo.server.api.processor">ErrorProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/MediaEntityProcessor.html" title="interface in org.apache.olingo.server.api.processor">MediaEntityProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/MetadataProcessor.html" title="interface in org.apache.olingo.server.api.processor">MetadataProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/PrimitiveValueProcessor.html" title="interface in org.apache.olingo.server.api.processor">PrimitiveValueProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor">ReferenceCollectionProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceProcessor.html" title="interface in org.apache.olingo.server.api.processor">ReferenceProcessor</a>, <a href="../../../../../../org/apache/olingo/server/api/processor/ServiceDocumentProcessor.html" title="interface in org.apache.olingo.server.api.processor">ServiceDocumentProcessor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/olingo/server/api/processor/DefaultProcessor.html" title="class in org.apache.olingo.server.api.processor">DefaultProcessor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Processor</span></pre>
<div class="block"><p>Base interface for all processor types.</p>
<p>Processors are responsible to read and write data and marshalling content
within a request - response cycle.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/processor/Processor.html#init-org.apache.olingo.server.api.OData-org.apache.olingo.server.api.ServiceMetadata-">init</a></span>(<a href="../../../../../../org/apache/olingo/server/api/OData.html" title="class in org.apache.olingo.server.api">OData</a>&nbsp;odata,
<a href="../../../../../../org/apache/olingo/server/api/ServiceMetadata.html" title="interface in org.apache.olingo.server.api">ServiceMetadata</a>&nbsp;serviceMetadata)</code>
<div class="block">Initializes the processor for each HTTP request - response cycle.</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="init-org.apache.olingo.server.api.OData-org.apache.olingo.server.api.ServiceMetadata-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="../../../../../../org/apache/olingo/server/api/OData.html" title="class in org.apache.olingo.server.api">OData</a>&nbsp;odata,
<a href="../../../../../../org/apache/olingo/server/api/ServiceMetadata.html" title="interface in org.apache.olingo.server.api">ServiceMetadata</a>&nbsp;serviceMetadata)</pre>
<div class="block">Initializes the processor for each HTTP request - response cycle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>odata</code> - Olingo's root object, acting as a factory for various object types</dd>
<dd><code>serviceMetadata</code> - metadata of the OData service like the EDM that have to be created
before the OData request handling takes place</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>
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Processor.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/processor/PrimitiveValueProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/server/api/processor/ReferenceCollectionProcessor.html" title="interface in org.apache.olingo.server.api.processor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/processor/Processor.html" target="_top">Frames</a></li>
<li><a href="Processor.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>