blob: ea71712a9024b130b3f87ecb0006f3ebad73cb36 [file] [log] [blame]
<!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:33 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Configuration (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="Configuration (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":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/Configuration.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="../../../../../org/apache/olingo/client/api/EdmEnabledODataClient.html" title="interface in org.apache.olingo.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/olingo/client/api/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">org.apache.olingo.client.api</div>
<h2 title="Interface Configuration" class="title">Interface Configuration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Configuration</span></pre>
<div class="block">Configuration wrapper.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultBatchAcceptFormat--">getDefaultBatchAcceptFormat</a></span>()</code>
<div class="block">Gets the configured default <tt>Accept</tt> header value format for a batch request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultFormat--">getDefaultFormat</a></span>()</code>
<div class="block">Gets the configured OData format.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultMediaFormat--">getDefaultMediaFormat</a></span>()</code>
<div class="block">Gets the configured OData media format.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultPubFormat--">getDefaultPubFormat</a></span>()</code>
<div class="block">Gets the configured OData format for AtomPub exchanges.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultValueFormat--">getDefaultValueFormat</a></span>()</code>
<div class="block">Gets the configured OData value format.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getExecutor--">getExecutor</a></span>()</code>
<div class="block">Retrieves request executor service.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/client/api/http/HttpClientFactory.html" title="interface in org.apache.olingo.client.api.http">HttpClientFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getHttpClientFactory--">getHttpClientFactory</a></span>()</code>
<div class="block">Gets the HttpClient factory to be used for executing requests.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/olingo/client/api/http/HttpUriRequestFactory.html" title="interface in org.apache.olingo.client.api.http">HttpUriRequestFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getHttpUriRequestFactory--">getHttpUriRequestFactory</a></span>()</code>
<div class="block">Gets the HttpUriRequest factory for generating requests to be executed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isAddressingDerivedTypes--">isAddressingDerivedTypes</a></span>()</code>
<div class="block">Gets whether query URIs in request should contain fully qualified type name.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isContinueOnError--">isContinueOnError</a></span>()</code>
<div class="block">When processing a set of requests (in batch requests, for example), checks if the execution will be aborted after
first error encountered or not.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isGzipCompression--">isGzipCompression</a></span>()</code>
<div class="block">Checks whether Gzip compression (e.g.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isKeyAsSegment--">isKeyAsSegment</a></span>()</code>
<div class="block">Checks whether URIs contain entity key between parentheses (standard) or instead as additional segment
(non-standard).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isUseChuncked--">isUseChuncked</a></span>()</code>
<div class="block">Checks whether chunk HTTP encoding is being used.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isUseUrlOperationFQN--">isUseUrlOperationFQN</a></span>()</code>
<div class="block">Checks whether operation name in request URI should be fully qualified name, which is required by OData V4
protocol, but some service may still choose to support shorter name.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#isUseXHTTPMethod--">isUseXHTTPMethod</a></span>()</code>
<div class="block">Gets whether <tt>PUT</tt>, <tt>MERGE</tt>, <tt>PATCH</tt>, <tt>DELETE</tt> HTTP methods need to be translated to
<tt>POST</tt> with additional <tt>X-HTTTP-Method</tt> header.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setAddressingDerivedTypes-boolean-">setAddressingDerivedTypes</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets whether query URIs in request should contain fully qualified type name.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setContinueOnError-boolean-">setContinueOnError</a></span>(boolean&nbsp;value)</code>
<div class="block">When processing a set of requests (in batch requests, for example), sets if the execution will be aborted after
first error encountered or not.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setDefaultBatchAcceptFormat-org.apache.olingo.commons.api.format.ContentType-">setDefaultBatchAcceptFormat</a></span>(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;contentType)</code>
<div class="block">Set the default <tt>Accept</tt> header value format for a batch request.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setDefaultMediaFormat-org.apache.olingo.commons.api.format.ContentType-">setDefaultMediaFormat</a></span>(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Sets the default OData media format.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setDefaultPubFormat-org.apache.olingo.commons.api.format.ContentType-">setDefaultPubFormat</a></span>(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Sets the default OData format for AtomPub exchanges.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setDefaultValueFormat-org.apache.olingo.commons.api.format.ContentType-">setDefaultValueFormat</a></span>(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</code>
<div class="block">Sets the default OData value format.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setExecutor-java.util.concurrent.ExecutorService-">setExecutor</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService)</code>
<div class="block">Sets request executor service.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setGzipCompression-boolean-">setGzipCompression</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets Gzip compression (e.g.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setHttpClientFactory-org.apache.olingo.client.api.http.HttpClientFactory-">setHttpClientFactory</a></span>(<a href="../../../../../org/apache/olingo/client/api/http/HttpClientFactory.html" title="interface in org.apache.olingo.client.api.http">HttpClientFactory</a>&nbsp;factory)</code>
<div class="block">Sets the HttpClient factory to be used for executing requests.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setHttpUriRequestFactory-org.apache.olingo.client.api.http.HttpUriRequestFactory-">setHttpUriRequestFactory</a></span>(<a href="../../../../../org/apache/olingo/client/api/http/HttpUriRequestFactory.html" title="interface in org.apache.olingo.client.api.http">HttpUriRequestFactory</a>&nbsp;factory)</code>
<div class="block">Sets the HttpUriRequest factory generating requests to be executed.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setKeyAsSegment-boolean-">setKeyAsSegment</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets whether URIs shall be built with entity key between parentheses (standard) or instead as additional segment
(non-standard).</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setUseChuncked-boolean-">setUseChuncked</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets chunk HTTP encoding enabled or disabled.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setUseUrlOperationFQN-boolean-">setUseUrlOperationFQN</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets whether operation name in request URI should be fully qualified name, which is required by OData V4 protocol,
but some service may still choose to support shorter name.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/olingo/client/api/Configuration.html#setUseXHTTPMethod-boolean-">setUseXHTTPMethod</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets whether <tt>PUT</tt>, <tt>MERGE</tt>, <tt>PATCH</tt>, <tt>DELETE</tt> HTTP methods need to be translated to
<tt>POST</tt> with additional <tt>X-HTTTP-Method</tt> header.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDefaultBatchAcceptFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultBatchAcceptFormat</h4>
<pre><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;getDefaultBatchAcceptFormat()</pre>
<div class="block">Gets the configured default <tt>Accept</tt> header value format for a batch request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured default <tt>Accept</tt> header value for a batch request.</dd>
</dl>
</li>
</ul>
<a name="setDefaultBatchAcceptFormat-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultBatchAcceptFormat</h4>
<pre>void&nbsp;setDefaultBatchAcceptFormat(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;contentType)</pre>
<div class="block">Set the default <tt>Accept</tt> header value format for a batch request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contentType</code> - default <tt>Accept</tt> header value.</dd>
</dl>
</li>
</ul>
<a name="getDefaultPubFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultPubFormat</h4>
<pre><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;getDefaultPubFormat()</pre>
<div class="block">Gets the configured OData format for AtomPub exchanges. If this configuration parameter doesn't exist the
JSON_FULL_METADATA format will be used as default.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured OData format for AtomPub if specified; JSON_FULL_METADATA format otherwise.</dd>
</dl>
</li>
</ul>
<a name="setDefaultPubFormat-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultPubFormat</h4>
<pre>void&nbsp;setDefaultPubFormat(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</pre>
<div class="block">Sets the default OData format for AtomPub exchanges.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>format</code> - default format.</dd>
</dl>
</li>
</ul>
<a name="getDefaultFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultFormat</h4>
<pre><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;getDefaultFormat()</pre>
<div class="block">Gets the configured OData format. This value depends on what is returned from <tt>getDefaultPubFormat()</tt>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured OData format</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/olingo/client/api/Configuration.html#getDefaultPubFormat--"><code>getDefaultPubFormat()</code></a></dd>
</dl>
</li>
</ul>
<a name="getDefaultValueFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultValueFormat</h4>
<pre><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;getDefaultValueFormat()</pre>
<div class="block">Gets the configured OData value format. If this configuration parameter doesn't exist the TEXT format will be used
as default.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured OData value format if specified; TEXT_PLAIN format otherwise.</dd>
</dl>
</li>
</ul>
<a name="setDefaultValueFormat-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultValueFormat</h4>
<pre>void&nbsp;setDefaultValueFormat(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</pre>
<div class="block">Sets the default OData value format.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>format</code> - default format.</dd>
</dl>
</li>
</ul>
<a name="getDefaultMediaFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultMediaFormat</h4>
<pre><a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;getDefaultMediaFormat()</pre>
<div class="block">Gets the configured OData media format. If this configuration parameter doesn't exist the APPLICATION_OCTET_STREAM
format will be used as default.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured OData media format if specified; APPLICATION_OCTET_STREAM format otherwise.</dd>
</dl>
</li>
</ul>
<a name="setDefaultMediaFormat-org.apache.olingo.commons.api.format.ContentType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultMediaFormat</h4>
<pre>void&nbsp;setDefaultMediaFormat(<a href="../../../../../org/apache/olingo/commons/api/format/ContentType.html" title="class in org.apache.olingo.commons.api.format">ContentType</a>&nbsp;format)</pre>
<div class="block">Sets the default OData media format.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>format</code> - default format.</dd>
</dl>
</li>
</ul>
<a name="getHttpClientFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpClientFactory</h4>
<pre><a href="../../../../../org/apache/olingo/client/api/http/HttpClientFactory.html" title="interface in org.apache.olingo.client.api.http">HttpClientFactory</a>&nbsp;getHttpClientFactory()</pre>
<div class="block">Gets the HttpClient factory to be used for executing requests.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>provided implementation (if configured via <tt>setHttpClientFactory</tt> or default.</dd>
</dl>
</li>
</ul>
<a name="setHttpClientFactory-org.apache.olingo.client.api.http.HttpClientFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHttpClientFactory</h4>
<pre>void&nbsp;setHttpClientFactory(<a href="../../../../../org/apache/olingo/client/api/http/HttpClientFactory.html" title="interface in org.apache.olingo.client.api.http">HttpClientFactory</a>&nbsp;factory)</pre>
<div class="block">Sets the HttpClient factory to be used for executing requests.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - implementation of <tt>HttpClientFactory</tt>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/olingo/client/api/http/HttpClientFactory.html" title="interface in org.apache.olingo.client.api.http"><code>HttpClientFactory</code></a></dd>
</dl>
</li>
</ul>
<a name="getHttpUriRequestFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpUriRequestFactory</h4>
<pre><a href="../../../../../org/apache/olingo/client/api/http/HttpUriRequestFactory.html" title="interface in org.apache.olingo.client.api.http">HttpUriRequestFactory</a>&nbsp;getHttpUriRequestFactory()</pre>
<div class="block">Gets the HttpUriRequest factory for generating requests to be executed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>provided implementation (if configured via <tt>setHttpUriRequestFactory</tt> or default.</dd>
</dl>
</li>
</ul>
<a name="setHttpUriRequestFactory-org.apache.olingo.client.api.http.HttpUriRequestFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHttpUriRequestFactory</h4>
<pre>void&nbsp;setHttpUriRequestFactory(<a href="../../../../../org/apache/olingo/client/api/http/HttpUriRequestFactory.html" title="interface in org.apache.olingo.client.api.http">HttpUriRequestFactory</a>&nbsp;factory)</pre>
<div class="block">Sets the HttpUriRequest factory generating requests to be executed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - implementation of <tt>HttpUriRequestFactory</tt>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/olingo/client/api/http/HttpUriRequestFactory.html" title="interface in org.apache.olingo.client.api.http"><code>HttpUriRequestFactory</code></a></dd>
</dl>
</li>
</ul>
<a name="isUseXHTTPMethod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseXHTTPMethod</h4>
<pre>boolean&nbsp;isUseXHTTPMethod()</pre>
<div class="block">Gets whether <tt>PUT</tt>, <tt>MERGE</tt>, <tt>PATCH</tt>, <tt>DELETE</tt> HTTP methods need to be translated to
<tt>POST</tt> with additional <tt>X-HTTTP-Method</tt> header.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether <tt>X-HTTTP-Method</tt> header is to be used</dd>
</dl>
</li>
</ul>
<a name="setUseXHTTPMethod-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseXHTTPMethod</h4>
<pre>void&nbsp;setUseXHTTPMethod(boolean&nbsp;value)</pre>
<div class="block">Sets whether <tt>PUT</tt>, <tt>MERGE</tt>, <tt>PATCH</tt>, <tt>DELETE</tt> HTTP methods need to be translated to
<tt>POST</tt> with additional <tt>X-HTTTP-Method</tt> header.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - 'TRUE' to use tunneling.</dd>
</dl>
</li>
</ul>
<a name="isGzipCompression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGzipCompression</h4>
<pre>boolean&nbsp;isGzipCompression()</pre>
<div class="block">Checks whether Gzip compression (e.g. support for <tt>Accept-Encoding: gzip</tt> and
<tt>Content-Encoding: gzip</tt> HTTP headers) is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether HTTP Gzip compression is enabled</dd>
</dl>
</li>
</ul>
<a name="setGzipCompression-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGzipCompression</h4>
<pre>void&nbsp;setGzipCompression(boolean&nbsp;value)</pre>
<div class="block">Sets Gzip compression (e.g. support for <tt>Accept-Encoding: gzip</tt> and
<tt>Content-Encoding: gzip</tt> HTTP headers) enabled or disabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - whether to use Gzip compression.</dd>
</dl>
</li>
</ul>
<a name="isUseChuncked--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseChuncked</h4>
<pre>boolean&nbsp;isUseChuncked()</pre>
<div class="block">Checks whether chunk HTTP encoding is being used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether chunk HTTP encoding is being used</dd>
</dl>
</li>
</ul>
<a name="setUseChuncked-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseChuncked</h4>
<pre>void&nbsp;setUseChuncked(boolean&nbsp;value)</pre>
<div class="block">Sets chunk HTTP encoding enabled or disabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - whether to use chunk HTTP encoding.</dd>
</dl>
</li>
</ul>
<a name="isKeyAsSegment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isKeyAsSegment</h4>
<pre>boolean&nbsp;isKeyAsSegment()</pre>
<div class="block">Checks whether URIs contain entity key between parentheses (standard) or instead as additional segment
(non-standard).
<br/>
Example: http://services.odata.org/V4/OData/OData.svc/Products(0) or
http://services.odata.org/V4/OData/OData.svc/Products/0</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether URIs shall be built with entity key between parentheses (standard) or instead as additional
segment.</dd>
</dl>
</li>
</ul>
<a name="setKeyAsSegment-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeyAsSegment</h4>
<pre>void&nbsp;setKeyAsSegment(boolean&nbsp;value)</pre>
<div class="block">Sets whether URIs shall be built with entity key between parentheses (standard) or instead as additional segment
(non-standard).
<br/>
Example: http://services.odata.org/V4/OData/OData.svc/Products(0) or
http://services.odata.org/V4/OData/OData.svc/Products/0</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - 'TRUE' to use this feature.</dd>
</dl>
</li>
</ul>
<a name="isAddressingDerivedTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAddressingDerivedTypes</h4>
<pre>boolean&nbsp;isAddressingDerivedTypes()</pre>
<div class="block">Gets whether query URIs in request should contain fully qualified type name. - OData Intermediate Conformance
Level: MUST support casting to a derived type according to [OData-URL] if derived types are present in the model.
<br/>
Example: http://host/service/Customers/Model.VipCustomer(102) or http://host/service/Customers/Model.VipCustomer</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether query URIs in request should contain fully qualified type name. segment.</dd>
</dl>
</li>
</ul>
<a name="setAddressingDerivedTypes-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAddressingDerivedTypes</h4>
<pre>void&nbsp;setAddressingDerivedTypes(boolean&nbsp;value)</pre>
<div class="block">Sets whether query URIs in request should contain fully qualified type name. - OData Intermediate Conformance
Level: MUST support casting to a derived type according to [OData-URL] if derived types are present in the model.
<br/>
Example: http://host/service/Customers/Model.VipCustomer(102) or http://host/service/Customers/Model.VipCustomer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - 'TRUE' to use this feature.</dd>
</dl>
</li>
</ul>
<a name="isUseUrlOperationFQN--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseUrlOperationFQN</h4>
<pre>boolean&nbsp;isUseUrlOperationFQN()</pre>
<div class="block">Checks whether operation name in request URI should be fully qualified name, which is required by OData V4
protocol, but some service may still choose to support shorter name.
<br/>
Example: http://host/service/Customers(2)/NS1.Model.IncreaseSalary VS
http://host/service/Customers(2)/IncreaseSalary</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>wheter operation name in request URI should be fully qualified name. segment.</dd>
</dl>
</li>
</ul>
<a name="setUseUrlOperationFQN-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseUrlOperationFQN</h4>
<pre>void&nbsp;setUseUrlOperationFQN(boolean&nbsp;value)</pre>
<div class="block">Sets whether operation name in request URI should be fully qualified name, which is required by OData V4 protocol,
but some service may still choose to support shorter name.
<br/>
Example: http://host/service/Customers(2)/NS1.Model.IncreaseSalary VS
http://host/service/Customers(2)/IncreaseSalary</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - 'TRUE' to use this feature.</dd>
</dl>
</li>
</ul>
<a name="isContinueOnError--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isContinueOnError</h4>
<pre>boolean&nbsp;isContinueOnError()</pre>
<div class="block">When processing a set of requests (in batch requests, for example), checks if the execution will be aborted after
first error encountered or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether execution of a set of requests will be aborted after first error</dd>
</dl>
</li>
</ul>
<a name="setContinueOnError-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContinueOnError</h4>
<pre>void&nbsp;setContinueOnError(boolean&nbsp;value)</pre>
<div class="block">When processing a set of requests (in batch requests, for example), sets if the execution will be aborted after
first error encountered or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - 'TRUE' to use this feature.</dd>
</dl>
</li>
</ul>
<a name="getExecutor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutor</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;getExecutor()</pre>
<div class="block">Retrieves request executor service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>request executor service.</dd>
</dl>
</li>
</ul>
<a name="setExecutor-java.util.concurrent.ExecutorService-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setExecutor</h4>
<pre>void&nbsp;setExecutor(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService)</pre>
<div class="block">Sets request executor service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executorService</code> - new executor services.</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/Configuration.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="../../../../../org/apache/olingo/client/api/EdmEnabledODataClient.html" title="interface in org.apache.olingo.client.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/olingo/client/api/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>