| <!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_21) on Wed Jun 12 19:57:03 BST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> |
| <title>IRemoteUIConnectionManager (PTP API Specification)</title> |
| <meta name="date" content="2013-06-12"> |
| <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="IRemoteUIConnectionManager (PTP API Specification)"; |
| } |
| //--> |
| </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/IRemoteUIConnectionManager.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/AbstractRemoteUIConnectionManager.html" title="class in org.eclipse.ptp.remote.ui"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConstants.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html" target="_top">Frames</a></li> |
| <li><a href="IRemoteUIConnectionManager.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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.eclipse.ptp.remote.ui</div> |
| <h2 title="Interface IRemoteUIConnectionManager" class="title">Interface IRemoteUIConnectionManager</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/eclipse/ptp/remote/ui/AbstractRemoteUIConnectionManager.html" title="class in org.eclipse.ptp.remote.ui">AbstractRemoteUIConnectionManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">IRemoteUIConnectionManager</span></pre> |
| <div class="block">Interface for providing connection management operations in the UI. Clients can call these methods to open generic dialogs for |
| operations on connections.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/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/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#CONNECTION_ADDRESS_HINT">CONNECTION_ADDRESS_HINT</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/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/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#CONNECTION_PORT_HINT">CONNECTION_PORT_HINT</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/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/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#CONNECTION_TIMEOUT_HINT">CONNECTION_TIMEOUT_HINT</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/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/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#LOGIN_USERNAME_HINT">LOGIN_USERNAME_HINT</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#newConnection(Shell)">newConnection</a></strong>(Shell shell)</code> |
| <div class="block">Create a new connection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#newConnection(Shell, java.lang.String[], java.lang.String[])">newConnection</a></strong>(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] attrHints, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] attrHintValues)</code> |
| <div class="block">Create a new connection using the remote service provider new connection |
| dialog.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#openConnectionWithProgress(Shell, IRunnableContext, org.eclipse.ptp.remote.core.IRemoteConnection)">openConnectionWithProgress</a></strong>(Shell shell, |
| IRunnableContext context, |
| <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</code> |
| <div class="block">Attempt to open a connection using a progress monitor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html#updateConnection(Shell, org.eclipse.ptp.remote.core.IRemoteConnection)">updateConnection</a></strong>(Shell shell, |
| <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</code> |
| <div class="block">Change a connection configuration.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CONNECTION_ADDRESS_HINT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONNECTION_ADDRESS_HINT</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONNECTION_ADDRESS_HINT</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.ui.IRemoteUIConnectionManager.CONNECTION_ADDRESS_HINT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="CONNECTION_PORT_HINT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONNECTION_PORT_HINT</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONNECTION_PORT_HINT</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.ui.IRemoteUIConnectionManager.CONNECTION_PORT_HINT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="CONNECTION_TIMEOUT_HINT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONNECTION_TIMEOUT_HINT</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONNECTION_TIMEOUT_HINT</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.ui.IRemoteUIConnectionManager.CONNECTION_TIMEOUT_HINT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="LOGIN_USERNAME_HINT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LOGIN_USERNAME_HINT</h4> |
| <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LOGIN_USERNAME_HINT</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.eclipse.ptp.remote.ui.IRemoteUIConnectionManager.LOGIN_USERNAME_HINT">Constant Field Values</a></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="newConnection(Shell)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newConnection</h4> |
| <pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> newConnection(Shell shell)</pre> |
| <div class="block">Create a new connection. The implementation can choose to do this in any |
| way, but typically will use a dialog or wizard.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - shell used to display dialogs</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>newly created remote connection or null if none created</dd></dl> |
| </li> |
| </ul> |
| <a name="newConnection(Shell, java.lang.String[], java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newConnection</h4> |
| <pre><a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> newConnection(Shell shell, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] attrHints, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] attrHintValues)</pre> |
| <div class="block">Create a new connection using the remote service provider new connection |
| dialog. If attrHints and attrHintValues are provided then the dialog will |
| attempt to use these values as the default values for the appropriate |
| dialog fields.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - shell used to display dialog</dd><dd><code>attrHints</code> - array containing attribute hints</dd><dd><code>attrHintValues</code> - array containing default values for each attribute specified |
| in attrHints</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created connection or null if none created</dd><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="openConnectionWithProgress(Shell, IRunnableContext, org.eclipse.ptp.remote.core.IRemoteConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openConnectionWithProgress</h4> |
| <pre>void openConnectionWithProgress(Shell shell, |
| IRunnableContext context, |
| <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</pre> |
| <div class="block">Attempt to open a connection using a progress monitor. Can be called on either open or closed connections, and will |
| initialize the remote services if necessary. Users should check connection.isOpen() on return to determine if the connection |
| was actually opened.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - shell used to display dialogs</dd><dd><code>context</code> - runnable context for displaying progress indicator. Can be null.</dd><dd><code>connection</code> - connection to open</dd><dt><span class="strong">Since:</span></dt> |
| <dd>5.0</dd></dl> |
| </li> |
| </ul> |
| <a name="updateConnection(Shell, org.eclipse.ptp.remote.core.IRemoteConnection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>updateConnection</h4> |
| <pre>void updateConnection(Shell shell, |
| <a href="../../../../../org/eclipse/ptp/remote/core/IRemoteConnection.html" title="interface in org.eclipse.ptp.remote.core">IRemoteConnection</a> connection)</pre> |
| <div class="block">Change a connection configuration. The implementation can chose to do |
| this in any way, but typically will use a dialog or wizard.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>shell</code> - shell used to display dialogs</dd><dd><code>connection</code> - connection to modify</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/IRemoteUIConnectionManager.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><b>PTP</b><br>Release 7.0</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/AbstractRemoteUIConnectionManager.html" title="class in org.eclipse.ptp.remote.ui"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/ptp/remote/ui/IRemoteUIConstants.html" title="interface in org.eclipse.ptp.remote.ui"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/ptp/remote/ui/IRemoteUIConnectionManager.html" target="_top">Frames</a></li> |
| <li><a href="IRemoteUIConnectionManager.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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 (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p> |
| </body> |
| </html> |
