<!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_40) on Fri Oct 18 06:47:25 UTC 2013 -->
<title>ConnectionManager (MX4J API)</title>
<meta name="date" content="2013-10-18">
<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="ConnectionManager (MX4J API)";
}
//-->
</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="class-use/ConnectionManager.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><a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../mx4j/tools/remote/JMXConnection.html" title="interface in mx4j.tools.remote"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/remote/ConnectionManager.html" target="_top">Frames</a></li>
<li><a href="ConnectionManager.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">mx4j.tools.remote</div>
<h2 title="Interface ConnectionManager" class="title">Interface ConnectionManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../mx4j/tools/remote/AbstractConnectionManager.html" title="class in mx4j.tools.remote">AbstractConnectionManager</a>, <a href="../../../mx4j/tools/remote/http/HTTPConnectionManager.html" title="class in mx4j.tools.remote.http">HTTPConnectionManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ConnectionManager</span></pre>
<div class="block">A ConnectionManager is a server-side object that acts as the factory for new connections and
manages the authentication details.
A JMXConnectorServer delegates a ConnectionManager for the creation of connections, and a
ConnectionManager interacts with the JMXConnectorServer to emit connection notifications.
It is the first object contacted by a remote client to obtain a client-specific connection, that is,
a connection with a specific connection ID.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1.4 $</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="../../../mx4j/tools/remote/ConnectionManager.html#close()">close</a></strong>()</code>
<div class="block">Closes this ConnectionManager and all the opened connections it manages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/remote/ConnectionManager.html#closeConnection(mx4j.tools.remote.Connection)">closeConnection</a></strong>(<a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote">Connection</a> connection)</code>
<div class="block">Closes the given Connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote">Connection</a></code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/remote/ConnectionManager.html#connect(java.lang.Object)">connect</a></strong>(java.lang.Object credentials)</code>
<div class="block">Factory method that creates connections that are specific to the client that invoked this method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../mx4j/tools/remote/ConnectionManager.html#getProtocol()">getProtocol</a></strong>()</code>
<div class="block">Returns the protocol used by the corrispondent JMXConnectorServer.</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="connect(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre><a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote">Connection</a> connect(java.lang.Object credentials)
throws java.io.IOException,
java.lang.SecurityException</pre>
<div class="block">Factory method that creates connections that are specific to the client that invoked this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>credentials</code> - The credentials sent by the client to authenticate a subject.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A new client-specific connection.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If the connection cannot be created.</dd>
<dd><code>java.lang.SecurityException</code> - If the authentication fails.</dd></dl>
</li>
</ul>
<a name="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre>java.lang.String getProtocol()</pre>
<div class="block">Returns the protocol used by the corrispondent JMXConnectorServer.</div>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void close()
throws java.io.IOException</pre>
<div class="block">Closes this ConnectionManager and all the opened connections it manages.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../mx4j/tools/remote/ConnectionManager.html#closeConnection(mx4j.tools.remote.Connection)"><code>closeConnection(mx4j.tools.remote.Connection)</code></a></dd></dl>
</li>
</ul>
<a name="closeConnection(mx4j.tools.remote.Connection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>closeConnection</h4>
<pre>void closeConnection(<a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote">Connection</a> connection)
throws java.io.IOException</pre>
<div class="block">Closes the given Connection.
This method is called by the connection manager when it is closing the connections it manages,
or as a consequence of the fact that the client end of the connection has been closed.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../mx4j/tools/remote/Connection.html#close()"><code>Connection.close()</code></a>,
<a href="../../../mx4j/tools/remote/ConnectionManager.html#close()"><code>close()</code></a></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="class-use/ConnectionManager.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><a href="../../../mx4j/tools/remote/Connection.html" title="interface in mx4j.tools.remote"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../mx4j/tools/remote/JMXConnection.html" title="interface in mx4j.tools.remote"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?mx4j/tools/remote/ConnectionManager.html" target="_top">Frames</a></li>
<li><a href="ConnectionManager.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><center><small>Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.</small></center></small></p>
</body>
</html>
