| <!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:37 CEST 2018 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>org.apache.olingo.server.api (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 (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/netty/server/core/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../org/apache/olingo/server/api/batch/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/apache/olingo/server/api/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</h1> | |
| <div class="docSummary"> | |
| <div class="block">Olingo Server API</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/ODataContent.html" title="interface in org.apache.olingo.server.api">ODataContent</a></td> | |
| <td class="colLast"> | |
| <div class="block">Contains the response content for the OData request.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataContentWriteErrorCallback.html" title="interface in org.apache.olingo.server.api">ODataContentWriteErrorCallback</a></td> | |
| <td class="colLast"> | |
| <div class="block">The ODataContentWriteErrorCallback is called when during the <a href="../../../../../org/apache/olingo/server/api/ODataContent.html#write-java.io.OutputStream-"><code>ODataContent.write(OutputStream)</code></a> | |
| or the <a href="../../../../../org/apache/olingo/server/api/ODataContent.html#write-java.nio.channels.WritableByteChannel-"><code>ODataContent.write(WritableByteChannel)</code></a> an error occurs.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataContentWriteErrorContext.html" title="interface in org.apache.olingo.server.api">ODataContentWriteErrorContext</a></td> | |
| <td class="colLast"> | |
| <div class="block">The WriteContentErrorErrorContext is the parameter for the WriteContentErrorCallback.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataHandler.html" title="interface in org.apache.olingo.server.api">ODataHandler</a></td> | |
| <td class="colLast"> | |
| <div class="block">Handles requests as OData requests.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataHttpHandler.html" title="interface in org.apache.olingo.server.api">ODataHttpHandler</a></td> | |
| <td class="colLast"> | |
| <div class="block">Handles HTTP requests as OData requests.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataLibraryException.MessageKey.html" title="interface in org.apache.olingo.server.api">ODataLibraryException.MessageKey</a></td> | |
| <td class="colLast"> | |
| <div class="block">Key for the exception text in the resource bundle.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/OlingoExtension.html" title="interface in org.apache.olingo.server.api">OlingoExtension</a></td> | |
| <td class="colLast"> | |
| <div class="block">Marker interface for all possible Olingo extensions.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ServiceMetadata.html" title="interface in org.apache.olingo.server.api">ServiceMetadata</a></td> | |
| <td class="colLast"> | |
| <div class="block">Metadata of an OData service like the Entity Data Model.</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/OData.html" title="class in org.apache.olingo.server.api">OData</a></td> | |
| <td class="colLast"> | |
| <div class="block">Root object for serving factory tasks and support loose coupling of implementation (core) from the API.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataLibraryException.ODataErrorMessage.html" title="class in org.apache.olingo.server.api">ODataLibraryException.ODataErrorMessage</a></td> | |
| <td class="colLast"> | |
| <div class="block">Error message text and <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util"><code>Locale</code></a> used for it.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataRequest.html" title="class in org.apache.olingo.server.api">ODataRequest</a></td> | |
| <td class="colLast"> | |
| <div class="block">Request object to carry HTTP information optimized for and required to handle OData requests only.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a></td> | |
| <td class="colLast"> | |
| <div class="block">Response object to carry OData-relevant HTTP information (status code, response headers, and content).</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataServerError.html" title="class in org.apache.olingo.server.api">ODataServerError</a></td> | |
| <td class="colLast"> | |
| <div class="block">Class to hold all server relevant error information.</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| <li class="blockList"> | |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> | |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Exception</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tbody> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataApplicationException.html" title="class in org.apache.olingo.server.api">ODataApplicationException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exception thrown by OData service implementations.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/server/api/ODataLibraryException.html" title="class in org.apache.olingo.server.api">ODataLibraryException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Abstract superclass of all translatable server exceptions.</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| </ul> | |
| <a name="package.description"> | |
| <!-- --> | |
| </a> | |
| <h2 title="Package org.apache.olingo.server.api Description">Package org.apache.olingo.server.api Description</h2> | |
| <div class="block">Olingo Server API | |
| <p>The OData Library is a protocol implementation of the OData V4.0 standard. | |
| For details of this standard see <a href="http://odata.org">odata.org</a>.</p> | |
| <p>This API is intended to help implementing an OData service. | |
| An OData service consists of a metadata provider implementation and an | |
| OData processor implementation.</p> | |
| <p>An OData service can be exposed by a web application using the standard java servlet API. | |
| For further information, see the <a href="http://olingo.apache.org/doc/odata4/">Olingo | |
| tutorials</a> on how to implement an OData service.</p> | |
| <p>The main entry point is the org.apache.olingo.server.api.OData class. | |
| Use the newInstance() method to create a new object and | |
| start providing your service from there.</p></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/netty/server/core/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../org/apache/olingo/server/api/batch/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/apache/olingo/server/api/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> |