/usr/share/doc/starlink-connect-java-doc/api/uk/ac/starlink/connect/Connection.html is in starlink-connect-java-doc 0.1+2016.05.03-1.
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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>Connection (Starjava CONNECT API)</title>
<meta name="date" content="2017-04-08">
<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="Connection (Starjava CONNECT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":6,"i4":6,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../uk/ac/starlink/connect/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><a href="../../../../uk/ac/starlink/connect/BranchComboBox.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/connect/Connection.html" target="_top">Frames</a></li>
<li><a href="Connection.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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">uk.ac.starlink.connect</div>
<h2 title="Class Connection" class="title">Class Connection</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>uk.ac.starlink.connect.Connection</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Connection</span>
extends java.lang.Object</pre>
<div class="block">Represents a connection to a remote resource.
Currently this resource is defined to provide access to a virtual
filesystem as provided by the <a href="../../../../uk/ac/starlink/connect/Connection.html#getRoot--"><code>getRoot()</code></a> method.
This functionality may be broadened or narrowed in the future.
<p>When constructed, a Connection should be live, and hopefully remain
so until <a href="../../../../uk/ac/starlink/connect/Connection.html#logOut--"><code>logOut()</code></a> is called.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>18 Feb 2005</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Taylor (Starlink)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#Connection--">Connection</a></span>()</code>
<div class="block">Constructs a connection with no information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#Connection-uk.ac.starlink.connect.Connector-java.util.Map-">Connection</a></span>(<a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect">Connector</a> connector,
java.util.Map keys)</code>
<div class="block">Constructs a connection recording the circumstances under which
it was created.</div>
</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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#getAuthValue-uk.ac.starlink.connect.AuthKey-">getAuthValue</a></span>(<a href="../../../../uk/ac/starlink/connect/AuthKey.html" title="class in uk.ac.starlink.connect">AuthKey</a> key)</code>
<div class="block">Returns the value for a given authorization key used when opening
this connection, if known</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect">Connector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#getConnector--">getConnector</a></span>()</code>
<div class="block">Returns the connector which generated this connection, if known.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#getRoot--">getRoot</a></span>()</code>
<div class="block">Returns the root of the remote filesystem provided by this connection.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#isConnected--">isConnected</a></span>()</code>
<div class="block">Indicates whether this connection is currently up and running.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#logOut--">logOut</a></span>()</code>
<div class="block">Closes this connection.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#setLogoutOnExit-boolean-">setLogoutOnExit</a></span>(boolean tidy)</code>
<div class="block">Controls whether an attempt is made to shut down this connection
when the JVM exits if it has not been done within the program.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../uk/ac/starlink/connect/Connection.html#toString--">toString</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="Connection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Connection</h4>
<pre>protected Connection()</pre>
<div class="block">Constructs a connection with no information.</div>
</li>
</ul>
<a name="Connection-uk.ac.starlink.connect.Connector-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Connection</h4>
<pre>protected Connection(<a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect">Connector</a> connector,
java.util.Map keys)</pre>
<div class="block">Constructs a connection recording the circumstances under which
it was created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connector</code> - Connector which generated this connection</dd>
<dd><code>keys</code> - <a href="../../../../uk/ac/starlink/connect/AuthKey.html" title="class in uk.ac.starlink.connect"><code>AuthKey</code></a> -> value map giving the set of
authorization values used when opening this connection</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="getAuthValue-uk.ac.starlink.connect.AuthKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthValue</h4>
<pre>public java.lang.Object getAuthValue(<a href="../../../../uk/ac/starlink/connect/AuthKey.html" title="class in uk.ac.starlink.connect">AuthKey</a> key)</pre>
<div class="block">Returns the value for a given authorization key used when opening
this connection, if known</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - authorization key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value for <tt>key</tt> (of type <tt>key.getValueType()</tt>),
or null</dd>
</dl>
</li>
</ul>
<a name="getConnector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre>public <a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect">Connector</a> getConnector()</pre>
<div class="block">Returns the connector which generated this connection, if known.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>connector, or null</dd>
</dl>
</li>
</ul>
<a name="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>public abstract boolean isConnected()</pre>
<div class="block">Indicates whether this connection is currently up and running.
Hopefully it will return true until <a href="../../../../uk/ac/starlink/connect/Connection.html#logOut--"><code>logOut()</code></a> has been called,
but it's possible that the connection may expire for some reason
before that.</div>
</li>
</ul>
<a name="logOut--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logOut</h4>
<pre>public abstract void logOut()
throws java.io.IOException</pre>
<div class="block">Closes this connection.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getRoot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoot</h4>
<pre>public abstract <a href="../../../../uk/ac/starlink/connect/Branch.html" title="interface in uk.ac.starlink.connect">Branch</a> getRoot()</pre>
<div class="block">Returns the root of the remote filesystem provided by this connection.
This method should not do work, but only return an existing branch
(acquired at login time); that is the root branch should not
be constructed lazily.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>root of the virtual filesystem associated with this connection</dd>
</dl>
</li>
</ul>
<a name="setLogoutOnExit-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogoutOnExit</h4>
<pre>public void setLogoutOnExit(boolean tidy)</pre>
<div class="block">Controls whether an attempt is made to shut down this connection
when the JVM exits if it has not been done within the program.
If set true, at system exit if <a href="../../../../uk/ac/starlink/connect/Connection.html#isConnected--"><code>isConnected()</code></a> returns true
an attempt is made to call <a href="../../../../uk/ac/starlink/connect/Connection.html#logOut--"><code>logOut()</code></a>. Note this might
cause JVM shutdown to be prolonged. This is set false by
default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tidy</code> - true if you want this connection to be shut down on exit</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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="../../../../uk/ac/starlink/connect/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><a href="../../../../uk/ac/starlink/connect/BranchComboBox.html" title="class in uk.ac.starlink.connect"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../uk/ac/starlink/connect/Connector.html" title="interface in uk.ac.starlink.connect"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/connect/Connection.html" target="_top">Frames</a></li>
<li><a href="Connection.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><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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><i>Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>
|