Files
okhttp/3.x/logging-interceptor/okhttp3/logging/HttpLoggingInterceptor.html

373 lines
16 KiB
HTML

<!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_202) on Thu Mar 14 00:03:25 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HttpLoggingInterceptor (OkHttp Logging Interceptor 3.14.0 API)</title>
<meta name="date" content="2019-03-14">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="canonical" href="https://square.github.io/okhttp/4.x/okhttp-logging-interceptor/okhttp3.logging/-http-logging-interceptor/"/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HttpLoggingInterceptor (OkHttp Logging Interceptor 3.14.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../okhttp3/logging/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpLoggingInterceptor.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>Prev&nbsp;Class</li>
<li><a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?okhttp3/logging/HttpLoggingInterceptor.html" target="_top">Frames</a></li>
<li><a href="HttpLoggingInterceptor.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">okhttp3.logging</div>
<h2 title="Class HttpLoggingInterceptor" class="title">Class HttpLoggingInterceptor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>okhttp3.logging.HttpLoggingInterceptor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.html?is-external=true" title="class or interface in okhttp3">Interceptor</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">HttpLoggingInterceptor</span>
extends java.lang.Object
implements <a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.html?is-external=true" title="class or interface in okhttp3">Interceptor</a></pre>
<div class="block">An OkHttp interceptor which logs request and response information. Can be applied as an
<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/OkHttpClient.html?is-external=true#interceptors--" title="class or interface in okhttp3">application interceptor</a> or as a <a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/OkHttpClient.html?is-external=true#networkInterceptors--" title="class or interface in okhttp3">network interceptor</a>. <p> The format of the logs created by
this class should not be considered stable and may change slightly between releases. If you need
a stable logging format, use your own interceptor.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging">HttpLoggingInterceptor.Level</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.Logger.html" title="interface in okhttp3.logging">HttpLoggingInterceptor.Logger</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.okhttp3.Interceptor">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;okhttp3.<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.html?is-external=true" title="class or interface in okhttp3">Interceptor</a></h3>
<code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.Chain.html?is-external=true" title="class or interface in okhttp3">Interceptor.Chain</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#HttpLoggingInterceptor--">HttpLoggingInterceptor</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#HttpLoggingInterceptor-okhttp3.logging.HttpLoggingInterceptor.Logger-">HttpLoggingInterceptor</a></span>(<a href="../../okhttp3/logging/HttpLoggingInterceptor.Logger.html" title="interface in okhttp3.logging">HttpLoggingInterceptor.Logger</a>&nbsp;logger)</code>&nbsp;</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">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging">HttpLoggingInterceptor.Level</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#getLevel--">getLevel</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Response.html?is-external=true" title="class or interface in okhttp3">Response</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#intercept-okhttp3.Interceptor.Chain-">intercept</a></span>(<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.Chain.html?is-external=true" title="class or interface in okhttp3">Interceptor.Chain</a>&nbsp;chain)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#redactHeader-java.lang.String-">redactHeader</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../okhttp3/logging/HttpLoggingInterceptor.html" title="class in okhttp3.logging">HttpLoggingInterceptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../okhttp3/logging/HttpLoggingInterceptor.html#setLevel-okhttp3.logging.HttpLoggingInterceptor.Level-">setLevel</a></span>(<a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging">HttpLoggingInterceptor.Level</a>&nbsp;level)</code>
<div class="block">Change the level at which this interceptor logs.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HttpLoggingInterceptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HttpLoggingInterceptor</h4>
<pre>public&nbsp;HttpLoggingInterceptor()</pre>
</li>
</ul>
<a name="HttpLoggingInterceptor-okhttp3.logging.HttpLoggingInterceptor.Logger-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HttpLoggingInterceptor</h4>
<pre>public&nbsp;HttpLoggingInterceptor(<a href="../../okhttp3/logging/HttpLoggingInterceptor.Logger.html" title="interface in okhttp3.logging">HttpLoggingInterceptor.Logger</a>&nbsp;logger)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="redactHeader-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redactHeader</h4>
<pre>public&nbsp;void&nbsp;redactHeader(java.lang.String&nbsp;name)</pre>
</li>
</ul>
<a name="setLevel-okhttp3.logging.HttpLoggingInterceptor.Level-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLevel</h4>
<pre>public&nbsp;<a href="../../okhttp3/logging/HttpLoggingInterceptor.html" title="class in okhttp3.logging">HttpLoggingInterceptor</a>&nbsp;setLevel(<a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging">HttpLoggingInterceptor.Level</a>&nbsp;level)</pre>
<div class="block">Change the level at which this interceptor logs.</div>
</li>
</ul>
<a name="getLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre>public&nbsp;<a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging">HttpLoggingInterceptor.Level</a>&nbsp;getLevel()</pre>
</li>
</ul>
<a name="intercept-okhttp3.Interceptor.Chain-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>intercept</h4>
<pre>public&nbsp;<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Response.html?is-external=true" title="class or interface in okhttp3">Response</a>&nbsp;intercept(<a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.Chain.html?is-external=true" title="class or interface in okhttp3">Interceptor.Chain</a>&nbsp;chain)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.html?is-external=true#intercept-okhttp3.Interceptor.Chain-" title="class or interface in okhttp3">intercept</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/square/okhttp/okhttp/apidocs/okhttp3/Interceptor.html?is-external=true" title="class or interface in okhttp3">Interceptor</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></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="../../okhttp3/logging/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HttpLoggingInterceptor.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>Prev&nbsp;Class</li>
<li><a href="../../okhttp3/logging/HttpLoggingInterceptor.Level.html" title="enum in okhttp3.logging"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?okhttp3/logging/HttpLoggingInterceptor.html" target="_top">Frames</a></li>
<li><a href="HttpLoggingInterceptor.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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; 2019. All Rights Reserved.</small></p>
</body>
</html>