<!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_05) on Wed May 28 15:24:52 PDT 2014 --> <title>P4Connection (p4java_ext 0.1.0 API)</title> <meta name="date" content="2014-05-28"> <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="P4Connection (p4java_ext 0.1.0 API)"; } } catch(err) { } //--> var methods = {"i0":18,"i1":18,"i2":17,"i3":17,"i4":18,"i5":6,"i6":6,"i7":17,"i8":17,"i9":6}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Configure.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Depot.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" target="_top">Frames</a></li> <li><a href="P4Connection.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">com.perforce.workshop.tjuricek.p4java_ext</div> <h2 title="Interface P4Connection" class="title">Interface P4Connection</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd>java.lang.AutoCloseable, java.io.Closeable</dd> </dl> <dl> <dt>All Known Subinterfaces:</dt> <dd><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Add.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Add</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Change.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Change</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Changes.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Changes</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Client.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Client</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4ClientConnection.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4ClientConnection</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Configure.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Configure</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Depot.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Depot</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Edit.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Edit</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Files.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Files</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Opened.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Opened</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Passwd.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Passwd</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Protect.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Protect</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Revert.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Revert</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Shelve.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Shelve</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Submit.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Submit</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Sync.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Sync</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Triggers.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Triggers</a>, <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4User.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4User</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">P4Connection</span> extends java.io.Closeable</pre> <div class="block">Represents a connection to the Perforce server. Every connection, when obtained, needs to be established to a particular user instance. You can obtain connections in different ways, which should be determined based on your application usage. In a web server, for example, you'll likely want to use the P4ConnectionPool. You can also use a P4ConnectionFactory to create connections "on the fly". IMPORTANTLY, if you connection requires the use of a client, your code should depend upon the P4ClientConnection.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#close--">close</a></span>()</code> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#connectAs-java.lang.String-">connectAs</a></span>(java.lang.String user)</code> <div class="block">Sets the user name of the underlying connection and ensures we're connected.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#create-com.perforce.p4java.server.IOptionsServer-">create</a></span>(com.perforce.p4java.server.IOptionsServer optionsServer)</code> <div class="block">Wraps an existing IOptionsServer instance.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Connection</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#create-java.lang.String-int-boolean-java.lang.String-java.lang.String-">create</a></span>(java.lang.String hostname, int port, boolean isSsl, java.lang.String progName, java.lang.String progVersion)</code> <div class="block">Generates a new IOptionsServer instance based on some common defaults.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#disconnect--">disconnect</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#getLogin--">getLogin</a></span>()</code> <div class="block">Each connection must have a logged in user ID.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>com.perforce.p4java.server.IOptionsServer</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#getOptionsServer--">getOptionsServer</a></span>()</code> <div class="block">The underlying P4Java interface used by our wrapping objects.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#getServerLocation-java.lang.String-int-boolean-">getServerLocation</a></span>(java.lang.String hostname, int port, boolean isSsl)</code> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static java.util.Properties</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#getServerProperties-java.lang.String-java.lang.String-">getServerProperties</a></span>(java.lang.String progName, java.lang.String progVersion)</code> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html#setLogin-java.lang.String-">setLogin</a></span>(java.lang.String login)</code> </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="create-java.lang.String-int-boolean-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>static <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Connection</a> create(java.lang.String hostname, int port, boolean isSsl, java.lang.String progName, java.lang.String progVersion)</pre> <div class="block">Generates a new IOptionsServer instance based on some common defaults.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>hostname</code> - Perforce hostname</dd> <dd><code>port</code> - Perforce server port</dd> <dd><code>isSsl</code> - If the Perforce server requires SSL</dd> <dd><code>progName</code> - A short ID of your application</dd> <dd><code>progVersion</code> - A short version string of your application</dd> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="create-com.perforce.p4java.server.IOptionsServer-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>static <a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext">P4Connection</a> create(com.perforce.p4java.server.IOptionsServer optionsServer)</pre> <div class="block">Wraps an existing IOptionsServer instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>optionsServer</code> - The optionsServer that should basically have been created by the ServerFactory</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>New P4Connection</dd> </dl> </li> </ul> <a name="getServerLocation-java.lang.String-int-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getServerLocation</h4> <pre>static java.lang.String getServerLocation(java.lang.String hostname, int port, boolean isSsl)</pre> </li> </ul> <a name="getServerProperties-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getServerProperties</h4> <pre>static java.util.Properties getServerProperties(java.lang.String progName, java.lang.String progVersion)</pre> </li> </ul> <a name="getOptionsServer--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOptionsServer</h4> <pre>com.perforce.p4java.server.IOptionsServer getOptionsServer()</pre> <div class="block">The underlying P4Java interface used by our wrapping objects.</div> </li> </ul> <a name="getLogin--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLogin</h4> <pre>java.lang.String getLogin()</pre> <div class="block">Each connection must have a logged in user ID. This is the login of that user.</div> </li> </ul> <a name="setLogin-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setLogin</h4> <pre>void setLogin(java.lang.String login)</pre> </li> </ul> <a name="connectAs-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>connectAs</h4> <pre>default void connectAs(java.lang.String user)</pre> <div class="block">Sets the user name of the underlying connection and ensures we're connected.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>user</code> - The perforce login</dd> </dl> </li> </ul> <a name="disconnect--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>disconnect</h4> <pre>default void disconnect()</pre> </li> </ul> <a name="close--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>default void close()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>close</code> in interface <code>java.io.Closeable</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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Configure.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/P4Depot.html" title="interface in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/perforce/workshop/tjuricek/p4java_ext/P4Connection.html" target="_top">Frames</a></li> <li><a href="P4Connection.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>