| <!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:23 CET 2017 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>org.apache.olingo.odata2.api (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 (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/annotation/processor/ref/model/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../org/apache/olingo/odata2/api/annotation/edm/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/apache/olingo/odata2/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.odata2.api</h1> | |
| <div class="docSummary"> | |
| <div class="block">OData Library 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/odata2/api/ODataCallback.html" title="interface in org.apache.olingo.odata2.api">ODataCallback</a></td> | |
| <td class="colLast"> | |
| <div class="block">Common OData callback interface.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/odata2/api/ODataDebugCallback.html" title="interface in org.apache.olingo.odata2.api">ODataDebugCallback</a></td> | |
| <td class="colLast"> </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/odata2/api/ODataDebugResponseWrapperCallback.html" title="interface in org.apache.olingo.odata2.api">ODataDebugResponseWrapperCallback</a></td> | |
| <td class="colLast"> | |
| <div class="block">Debug handler.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/odata2/api/ODataService.html" title="interface in org.apache.olingo.odata2.api">ODataService</a></td> | |
| <td class="colLast"> | |
| <div class="block">Root interface for a custom OData service.</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/odata2/api/ODataServiceFactory.html" title="class in org.apache.olingo.odata2.api">ODataServiceFactory</a></td> | |
| <td class="colLast"> | |
| <div class="block">Creates instance of custom OData service.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../org/apache/olingo/odata2/api/ODataServiceVersion.html" title="class in org.apache.olingo.odata2.api">ODataServiceVersion</a></td> | |
| <td class="colLast"> | |
| <div class="block">This class is a container for the supported ODataServiceVersions.</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| </ul> | |
| <a name="package.description"> | |
| <!-- --> | |
| </a> | |
| <h2 title="Package org.apache.olingo.odata2.api Description">Package org.apache.olingo.odata2.api Description</h2> | |
| <div class="block">OData Library API | |
| <p> | |
| OData Library is a protocol implementation of the OData V2.0 standard. For details of this standard | |
| see <a href="http://odata.org">odata.org</a>. | |
| <p> | |
| This API is intended to implement an OData service. An OData service consists of a metadata provider | |
| implementation and an OData processor implementation. | |
| <p> | |
| An OData service can be exposed by a web application. For the runntime one JAX-RS | |
| implementation is needed and the core implementation library of this API. Apache CXF for example is | |
| one such JAX-RS implementation. | |
| <p> | |
| Entry point to the service is a JAX-RS servlet. At this servlet init parameters for a | |
| <code>ODataServiceFactory</code> | |
| is configured. The parameter <code>javax.ws.rs.Application</code> is a default by JAX-RS and has to be present | |
| always. | |
| <p> | |
| <pre> <code> | |
| <?xml version="1.0" encoding="UTF-8"?> | |
| <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
| xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" | |
| xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" | |
| id="WebApp_ID" version="2.5"> | |
| <display-name>Example OData Service</display-name> | |
| <servlet> | |
| <servlet-name>MyODataServlet</servlet-name> | |
| <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class> | |
| <init-param> | |
| <param-name>javax.ws.rs.Application</param-name> | |
| <param-value>org.apache.olingo.odata2.core.rest.app.ODataApplication</param-value> | |
| </init-param> | |
| <init-param> | |
| <param-name>org.apache.olingo.odata2.service.factory</param-name> | |
| <param-value>com.sample.service.MyServiceFactory</param-value> | |
| </init-param> | |
| <load-on-startup>1</load-on-startup> | |
| </servlet> | |
| <servlet-mapping> | |
| <servlet-name>MyODataServlet</servlet-name> | |
| <url-pattern>/MyService.svc/*</url-pattern> | |
| </servlet-mapping> | |
| </web-app> | |
| </code> </pre> | |
| <p> | |
| This factory produces the service, a metadata provider and the data processor. The provider, typically | |
| a derivative of the class <code>EdmProvider</code> provides the metadata of the service. The processor implements a | |
| variety of service interfaces, and provides the data of the service. The processor is typically | |
| a derivative of the class <code>ODataSingleProcessor</code> which can be used together with the class | |
| <code>ODataSingleService</code>.</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/annotation/processor/ref/model/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../org/apache/olingo/odata2/api/annotation/edm/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../index.html?org/apache/olingo/odata2/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-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> | |
| </body> | |
| </html> |