| <!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.exception (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.exception (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/ep/feed/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../org/apache/olingo/odata2/api/processor/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/exception/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.exception</h1> | |
| <div class="docSummary"> | |
| <div class="block">Exception Classes used in the OData library as well as the implementing application</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="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/exception/MessageReference.html" title="class in org.apache.olingo.odata2.api.exception">MessageReference</a></td> | |
| <td class="colLast"> | |
| <div class="block">APPLICATION DEVELOPERS: Please use <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataApplicationException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataApplicationException</code></a> to throw custom exceptions.</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/odata2/api/exception/ODataApplicationException.html" title="class in org.apache.olingo.odata2.api.exception">ODataApplicationException</a></td> | |
| <td class="colLast"> | |
| <div class="block">This class represents a translated application exception.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataBadRequestException.html" title="class in org.apache.olingo.odata2.api.exception">ODataBadRequestException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 400 bad request</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataConflictException.html" title="class in org.apache.olingo.odata2.api.exception">ODataConflictException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 409 Conflict</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception">ODataException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Base exception for all <code>OData</code>-related exceptions.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataForbiddenException.html" title="class in org.apache.olingo.odata2.api.exception">ODataForbiddenException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 403 forbidden</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataHttpException.html" title="class in org.apache.olingo.odata2.api.exception">ODataHttpException</a></td> | |
| <td class="colLast"> | |
| <div class="block"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataMessageException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataMessageException</code></a> with a HTTP status code.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataInternalServerErrorException.html" title="class in org.apache.olingo.odata2.api.exception">ODataInternalServerErrorException</a></td> | |
| <td class="colLast"> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataMessageException.html" title="class in org.apache.olingo.odata2.api.exception">ODataMessageException</a></td> | |
| <td class="colLast"> | |
| <div class="block">DO NOT EXTEND THIS EXCEPTION</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataMethodNotAllowedException.html" title="class in org.apache.olingo.odata2.api.exception">ODataMethodNotAllowedException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 405 (method not allowed).</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotAcceptableException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotAcceptableException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 406 not acceptable</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotFoundException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 404 not found</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotImplementedException.html" title="class in org.apache.olingo.odata2.api.exception">ODataNotImplementedException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 501 (Not implemented).</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataPreconditionFailedException.html" title="class in org.apache.olingo.odata2.api.exception">ODataPreconditionFailedException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP Status 412 Precondition Failed.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataPreconditionRequiredException.html" title="class in org.apache.olingo.odata2.api.exception">ODataPreconditionRequiredException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 428 precondition required</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataRuntimeApplicationException.html" title="class in org.apache.olingo.odata2.api.exception">ODataRuntimeApplicationException</a></td> | |
| <td class="colLast"> | |
| <div class="block">This class represents a translated application runtime exception.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataServiceUnavailableException.html" title="class in org.apache.olingo.odata2.api.exception">ODataServiceUnavailableException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 503 service unavailable</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataUnsupportedMediaTypeException.html" title="class in org.apache.olingo.odata2.api.exception">ODataUnsupportedMediaTypeException</a></td> | |
| <td class="colLast"> | |
| <div class="block">Exceptions of this class will result in a HTTP status 415 unsupported media type</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </li> | |
| </ul> | |
| <a name="package.description"> | |
| <!-- --> | |
| </a> | |
| <h2 title="Package org.apache.olingo.odata2.api.exception Description">Package org.apache.olingo.odata2.api.exception Description</h2> | |
| <div class="block">Exception Classes used in the OData library as well as the implementing application | |
| <p>APPLICATION DEVELOPERS: Please use <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataApplicationException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataApplicationException</code></a> for | |
| custom exceptions. | |
| <p><b>Exception handling:</b> | |
| <br>Inside the OData library an ExceptionMapper exists which can transform any exception into an OData error format. | |
| The ExceptionMapper behaves after the following algorithm: | |
| <br>1. The cause of the exception will be determined by looking into the stack trace. | |
| <br>1.1. If the cause is an ODataApplicationException meaning that somewhere in the stack an | |
| ODataApplicationException is found the | |
| ExceptionMapper will take the following information from the ApplicationException and transform it into an OData | |
| error: | |
| message text, Locale, Inner Error and Error Code. There will be no altering of information for the | |
| ODataApplicationException. | |
| <br>1.2. If no ODataApplicationException is found in the stack the cause can be three different types of exceptions: | |
| ODataHttpException, ODataMessageException or an uncaught RuntimeException. | |
| <br>The ExceptionMapper will process them in the following order: 1. ODataHttpException, 2. ODataMessageException, 3 | |
| Other Exceptions. | |
| <br>1.2.1. ODataHttpExceptions will be transformed as follows: If an error code is set it will be displayed. The HTTP | |
| status code will be derived from the ODataHttpException. The message text and its language depend on the | |
| AcceptLanguageHeaders. | |
| The first supported language which is found in the Headers will result in the language of the message and the | |
| response. | |
| <br>1.2.1. ODataMessageException will be transformed as follows: If an error code is set it will be displayed. The | |
| HTTP status code will be 500. | |
| The message text and its language depend on the AcceptLanguageHeaders. The first supported language which is found in | |
| the Headers will result in the language of the message and the response. | |
| <br>1.2.1 Runtime Exceptions will be transformed as follows: No error code will be set. HTTP status will be 500. | |
| Message text will be taken from the exception and the language for the response will be English as default. | |
| <p><b>Exception Hierarchy</b> | |
| <br> <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataException</code></a> <br> * | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataApplicationException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataApplicationException</code></a> <br> * | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataMessageException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataMessageException</code></a> <br> ** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/edm/EdmException.html" title="class in org.apache.olingo.odata2.api.edm"><code>EdmException</code></a> <br> ** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/ep/EntityProviderException.html" title="class in org.apache.olingo.odata2.api.ep"><code>EntityProviderException</code></a> <br> ** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/uri/expression/ExceptionVisitExpression.html" title="class in org.apache.olingo.odata2.api.uri.expression"><code>ExceptionVisitExpression</code></a> <br> ** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataHttpException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataHttpException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataConflictException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataConflictException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataForbiddenException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataForbiddenException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataMethodNotAllowedException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataMethodNotAllowedException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotAcceptableException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataNotAcceptableException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotImplementedException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataNotImplementedException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataPreconditionFailedException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataPreconditionFailedException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataPreconditionRequiredException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataPreconditionRequiredException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataServiceUnavailableException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataServiceUnavailableException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataUnsupportedMediaTypeException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataUnsupportedMediaTypeException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataNotFoundException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataNotFoundException</code></a> <br> **** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/uri/UriNotMatchingException.html" title="class in org.apache.olingo.odata2.api.uri"><code>UriNotMatchingException</code></a> <br> *** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/exception/ODataBadRequestException.html" title="class in org.apache.olingo.odata2.api.exception"><code>ODataBadRequestException</code></a> <br> **** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/uri/expression/ExpressionParserException.html" title="class in org.apache.olingo.odata2.api.uri.expression"><code>ExpressionParserException</code></a> <br> **** | |
| <a href="../../../../../../org/apache/olingo/odata2/api/uri/UriSyntaxException.html" title="class in org.apache.olingo.odata2.api.uri"><code>UriSyntaxException</code></a></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/ep/feed/package-summary.html">Prev Package</a></li> | |
| <li><a href="../../../../../../org/apache/olingo/odata2/api/processor/package-summary.html">Next Package</a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/odata2/api/exception/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> |