/usr/share/doc/libolap4j-java/api/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html is in libolap4j-java-doc 1.0.1.500-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 | <!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 (version 1.7.0_25) on Sat Aug 17 11:43:52 UTC 2013 -->
<title>XmlaOlap4jCache (olap4j, version 1.0.1.500)</title>
<meta name="date" content="2013-08-17">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XmlaOlap4jCache (olap4j, version 1.0.1.500)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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/olap4j/driver/xmla/cache/XmlaOlap4jInvalidStateException.html" title="class in org.olap4j.driver.xmla.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html" target="_top">Frames</a></li>
<li><a href="XmlaOlap4jCache.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.olap4j.driver.xmla.cache</div>
<h2 title="Interface XmlaOlap4jCache" class="title">Interface XmlaOlap4jCache</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/olap4j/driver/xmla/cache/XmlaOlap4jNamedMemoryCache.html" title="class in org.olap4j.driver.xmla.cache">XmlaOlap4jNamedMemoryCache</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#line.41">XmlaOlap4jCache</a></pre>
<div class="block">XMLA driver cache. Implementations will have to declare those methods.
<p>The XMLA driver will call the cache before each SOAP request to see
if it wasn't sent previously and if a SOAP response doesn't already
exist in it.
<p>Any implementations have to declare a constructor which takes a String
as a parameter. This string value is the unique name of the connection
which triggered the request.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Id: XmlaOlap4jCache.java 482 2012-01-05 23:27:27Z jhyde $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Luc Boudreau</dd></dl>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#flushCache()">flushCache</a></strong>()</code>
<div class="block">Tells the cache to flush all cached entries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#get(java.lang.String, java.net.URL, byte[])">get</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
byte[] request)</code>
<div class="block">Fetches a SOAP response from the cache.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#put(java.lang.String, java.net.URL, byte[], byte[])">put</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
byte[] request,
byte[] response)</code>
<div class="block">Adds a SOAP response to the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#setParameters(java.util.Map, java.util.Map)">setParameters</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config,
<a href="/usr/share/doc/default-jdk-doc/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props)</code>
<div class="block">Convenience method to receive custom properties.</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="get(java.lang.String, java.net.URL, byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>byte[] <a href="../../../../../src-html/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#line.59">get</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
byte[] request)
throws <a href="../../../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Fetches a SOAP response from the cache. Returns null
if there are no cached response corresponding to the SOAP
message and the URL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The connection unique name which called this cache.</dd><dd><code>url</code> - The URL where the SOAP message was sent.</dd><dd><code>request</code> - The SOAP complete message.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The SOAP response, null if there are no corresponding
response in the cache.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - when operations to the cache are
performed but it hasn't been initialized. Make sure you
call the setParameters(Map, Map) method.</dd></dl>
</li>
</ul>
<a name="put(java.lang.String, java.net.URL, byte[], byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>void <a href="../../../../../src-html/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#line.79">put</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
<a href="/usr/share/doc/default-jdk-doc/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url,
byte[] request,
byte[] response)
throws <a href="../../../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></pre>
<div class="block">Adds a SOAP response to the cache. It has to be relative to the
URL of the SOAP service.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The connection unique name which called this cache.</dd><dd><code>url</code> - The URL of the SOAP endpoint.</dd><dd><code>request</code> - The full SOAP message from which we want to cache its
response.</dd><dd><code>response</code> - The response to cache.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/olap4j/OlapException.html" title="class in org.olap4j">OlapException</a></code> - when operations to the cache are
performed but it hasn't been initialized. Make sure you
call the setParameters(Map, Map) method.</dd></dl>
</li>
</ul>
<a name="flushCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushCache</h4>
<pre>void <a href="../../../../../src-html/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#line.89">flushCache</a>()</pre>
<div class="block">Tells the cache to flush all cached entries.</div>
</li>
</ul>
<a name="setParameters(java.util.Map, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setParameters</h4>
<pre><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html#line.109">setParameters</a>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config,
<a href="/usr/share/doc/default-jdk-doc/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props)</pre>
<div class="block">Convenience method to receive custom properties.
<p>The XMLA driver takes cache properties as
"<code>Cache.[property name]=[value]</code>" in its JDBC url. All those
properties should be striped of their "<code>Cache.</code>" prefix and
sent to this method as the props parameter.
<p>Also, the complete map of the current connection
should be passed as the config parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The complete configuration parameters which were used to
create the current connection.</dd><dd><code>props</code> - The properties received from the JDBC url.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns a string object which gives a reference id to the
caller for future use. This id has to be passed along with any future
get and put requests.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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 class="aboutLanguage"><em><a href="http://sourceforge.net/projects/olap4j"><img src="http://sourceforge.net/sflogo.php?group_id=168953&type=1" width="88" height="31" border="0" alt="SourceForge.net_Logo"></a></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/olap4j/driver/xmla/cache/XmlaOlap4jInvalidStateException.html" title="class in org.olap4j.driver.xmla.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/olap4j/driver/xmla/cache/XmlaOlap4jCache.html" target="_top">Frames</a></li>
<li><a href="XmlaOlap4jCache.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 ======= -->
</body>
</html>
|