<!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>CustomETagSupport (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="CustomETagSupport (Olingo-OData 4.5.0 API)"; | |
} | |
} | |
catch(err) { | |
} | |
//--> | |
var methods = {"i0":6,"i1":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/CustomETagSupport.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 Class</li> | |
<li><a href="../../../../../../org/apache/olingo/server/api/etag/ETagHelper.html" title="interface in org.apache.olingo.server.api.etag"><span class="typeNameLink">Next Class</span></a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/etag/CustomETagSupport.html" target="_top">Frames</a></li> | |
<li><a href="CustomETagSupport.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>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </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.etag</div> | |
<h2 title="Interface CustomETagSupport" class="title">Interface CustomETagSupport</h2> | |
</div> | |
<div class="contentContainer"> | |
<div class="description"> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<dl> | |
<dt>All Superinterfaces:</dt> | |
<dd><a href="../../../../../../org/apache/olingo/server/api/OlingoExtension.html" title="interface in org.apache.olingo.server.api">OlingoExtension</a></dd> | |
</dl> | |
<hr> | |
<br> | |
<pre>public interface <span class="typeNameLabel">CustomETagSupport</span> | |
extends <a href="../../../../../../org/apache/olingo/server/api/OlingoExtension.html" title="interface in org.apache.olingo.server.api">OlingoExtension</a></pre> | |
<div class="block"><p>Processors that would like to support etags for certain entity sets can implement this | |
interface.</p> | |
<p>If implemented this interface can be registered at the ODataHttpHandler. This will result in change request to | |
require an if-match/if-none-match or an if-modified-since/if-unmodified-since header. Otherwise the request will | |
result in a "Precondition Required" response</p></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"> </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>boolean</code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/etag/CustomETagSupport.html#hasETag-org.apache.olingo.commons.api.edm.EdmBindingTarget-">hasETag</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm">EdmBindingTarget</a> entitySetOrSingleton)</code> | |
<div class="block">This method will be called for update requests which target an entity or a property of an entity.</div> | |
</td> | |
</tr> | |
<tr id="i1" class="rowColor"> | |
<td class="colFirst"><code>boolean</code></td> | |
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/server/api/etag/CustomETagSupport.html#hasMediaETag-org.apache.olingo.commons.api.edm.EdmBindingTarget-">hasMediaETag</a></span>(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm">EdmBindingTarget</a> entitySetOrSingleton)</code> | |
<div class="block">This method will be called for update requests which target a media entity value.</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="hasETag-org.apache.olingo.commons.api.edm.EdmBindingTarget-"> | |
<!-- --> | |
</a> | |
<ul class="blockList"> | |
<li class="blockList"> | |
<h4>hasETag</h4> | |
<pre>boolean hasETag(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm">EdmBindingTarget</a> entitySetOrSingleton)</pre> | |
<div class="block">This method will be called for update requests which target an entity or a property of an entity. | |
If this method returns true and an header is not specified we will return a "Precondition Required" response. | |
Validation has to be performed inside the processor methods after the dispatching. | |
If this method returns false and an header is specified we will ignore the header.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>entitySetOrSingleton</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>true if the entity set specified needs an if-match/if-none-match header</dd> | |
</dl> | |
</li> | |
</ul> | |
<a name="hasMediaETag-org.apache.olingo.commons.api.edm.EdmBindingTarget-"> | |
<!-- --> | |
</a> | |
<ul class="blockListLast"> | |
<li class="blockList"> | |
<h4>hasMediaETag</h4> | |
<pre>boolean hasMediaETag(<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmBindingTarget.html" title="interface in org.apache.olingo.commons.api.edm">EdmBindingTarget</a> entitySetOrSingleton)</pre> | |
<div class="block">This method will be called for update requests which target a media entity value. | |
If this method returns true and an header is not specified we will return a "Precondition Required" response. | |
Validation has to be performed inside the processor methods after the dispatching. | |
If this method returns false and an header is specified we will ignore the header.</div> | |
<dl> | |
<dt><span class="paramLabel">Parameters:</span></dt> | |
<dd><code>entitySetOrSingleton</code> - </dd> | |
<dt><span class="returnLabel">Returns:</span></dt> | |
<dd>true if the entity set specified needs an if-match/if-none-match header</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/CustomETagSupport.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 Class</li> | |
<li><a href="../../../../../../org/apache/olingo/server/api/etag/ETagHelper.html" title="interface in org.apache.olingo.server.api.etag"><span class="typeNameLink">Next Class</span></a></li> | |
</ul> | |
<ul class="navList"> | |
<li><a href="../../../../../../index.html?org/apache/olingo/server/api/etag/CustomETagSupport.html" target="_top">Frames</a></li> | |
<li><a href="CustomETagSupport.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>Field | </li> | |
<li>Constr | </li> | |
<li><a href="#method.summary">Method</a></li> | |
</ul> | |
<ul class="subNavList"> | |
<li>Detail: </li> | |
<li>Field | </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> |