| <!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>DebugSupport (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="DebugSupport (Olingo-OData 4.5.0 API)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":6,"i2":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/DebugSupport.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/debug/DebugResponseHelper.html" title="interface in org.apache.olingo.server.api.debug"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/server/api/debug/DefaultDebugSupport.html" title="class in org.apache.olingo.server.api.debug"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/debug/DebugSupport.html" target="_top">Frames</a></li> | |
| <li><a href="DebugSupport.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> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li>Nested | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li>Constr | </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.debug</div> | |
| <h2 title="Interface DebugSupport" class="title">Interface DebugSupport</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Known Implementing Classes:</dt> | |
| <dd><a href="../../../../../../org/apache/olingo/server/api/debug/DefaultDebugSupport.html" title="class in org.apache.olingo.server.api.debug">DefaultDebugSupport</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">DebugSupport</span></pre> | |
| <div class="block">Register this interface to add debug support to your service.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> | |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Field and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#ODATA_DEBUG_DOWNLOAD">ODATA_DEBUG_DOWNLOAD</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#ODATA_DEBUG_HTML">ODATA_DEBUG_HTML</a></span></code> </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#ODATA_DEBUG_JSON">ODATA_DEBUG_JSON</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#ODATA_DEBUG_QUERY_PARAMETER">ODATA_DEBUG_QUERY_PARAMETER</a></span></code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#createDebugResponse-java.lang.String-org.apache.olingo.server.api.debug.DebugInformation-">createDebugResponse</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> debugFormat, | |
| <a href="../../../../../../org/apache/olingo/server/api/debug/DebugInformation.html" title="class in org.apache.olingo.server.api.debug">DebugInformation</a> debugInfo)</code> | |
| <div class="block">Creates a debug response and delivers it back to the Olingo library.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#init-org.apache.olingo.server.api.OData-">init</a></span>(<a href="../../../../../../org/apache/olingo/server/api/OData.html" title="class in org.apache.olingo.server.api">OData</a> odata)</code> | |
| <div class="block">Initializes the debug support implementation.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#isUserAuthorized--">isUserAuthorized</a></span>()</code> | |
| <div class="block">Ensures that the user that requested the debug output is authorized to see this output.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Detail</h3> | |
| <a name="ODATA_DEBUG_QUERY_PARAMETER"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ODATA_DEBUG_QUERY_PARAMETER</h4> | |
| <pre>static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ODATA_DEBUG_QUERY_PARAMETER</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../../constant-values.html#org.apache.olingo.server.api.debug.DebugSupport.ODATA_DEBUG_QUERY_PARAMETER">Constant Field Values</a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="ODATA_DEBUG_JSON"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ODATA_DEBUG_JSON</h4> | |
| <pre>static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ODATA_DEBUG_JSON</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../../constant-values.html#org.apache.olingo.server.api.debug.DebugSupport.ODATA_DEBUG_JSON">Constant Field Values</a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="ODATA_DEBUG_HTML"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ODATA_DEBUG_HTML</h4> | |
| <pre>static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ODATA_DEBUG_HTML</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../../constant-values.html#org.apache.olingo.server.api.debug.DebugSupport.ODATA_DEBUG_HTML">Constant Field Values</a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="ODATA_DEBUG_DOWNLOAD"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>ODATA_DEBUG_DOWNLOAD</h4> | |
| <pre>static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ODATA_DEBUG_DOWNLOAD</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../../../constant-values.html#org.apache.olingo.server.api.debug.DebugSupport.ODATA_DEBUG_DOWNLOAD">Constant Field Values</a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ 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-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>init</h4> | |
| <pre>void init(<a href="../../../../../../org/apache/olingo/server/api/OData.html" title="class in org.apache.olingo.server.api">OData</a> odata)</pre> | |
| <div class="block">Initializes the debug support implementation. | |
| Is called before <a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#isUserAuthorized--"><code>isUserAuthorized()</code></a> and <a href="../../../../../../org/apache/olingo/server/api/debug/DebugSupport.html#createDebugResponse-java.lang.String-org.apache.olingo.server.api.debug.DebugInformation-"><code>createDebugResponse(String, DebugInformation)</code></a>.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>odata</code> - related OData/Olingo service factory</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isUserAuthorized--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isUserAuthorized</h4> | |
| <pre>boolean isUserAuthorized()</pre> | |
| <div class="block">Ensures that the user that requested the debug output is authorized to see this output.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true if the current user is authorized</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="createDebugResponse-java.lang.String-org.apache.olingo.server.api.debug.DebugInformation-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>createDebugResponse</h4> | |
| <pre><a href="../../../../../../org/apache/olingo/server/api/ODataResponse.html" title="class in org.apache.olingo.server.api">ODataResponse</a> createDebugResponse(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> debugFormat, | |
| <a href="../../../../../../org/apache/olingo/server/api/debug/DebugInformation.html" title="class in org.apache.olingo.server.api.debug">DebugInformation</a> debugInfo)</pre> | |
| <div class="block">Creates a debug response and delivers it back to the Olingo library. | |
| This method MUST NEVER throw an exception.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>debugFormat</code> - the value of the odata-debug query parameter</dd> | |
| <dd><code>debugInfo</code> - all necessary information to construct debug output</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a new debug response which will be sent to the client</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/DebugSupport.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/debug/DebugResponseHelper.html" title="interface in org.apache.olingo.server.api.debug"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../../../org/apache/olingo/server/api/debug/DefaultDebugSupport.html" title="class in org.apache.olingo.server.api.debug"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../../../index.html?org/apache/olingo/server/api/debug/DebugSupport.html" target="_top">Frames</a></li> | |
| <li><a href="DebugSupport.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> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li>Nested | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li>Constr | </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 © 2013–2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |