<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<body link="#355491" alink="#4262a1" vlink="#355491" style="background: #e2e2e2; margin: 0; padding: 20px;">
<div>
<table cellpadding="0" bgcolor="#FFFFFF" border="0" cellspacing="0" style="border: 1px solid #dadada; margin-bottom: 30px; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td>
<table border="0" cellpadding="0" cellspacing="0" bgcolor="#FFFFFF" style="border: solid 2px #ccc; background: #dadada; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td bgcolor="#000000" valign="middle" height="58px" style="border-bottom: 1px solid #ccc; padding: 20px; -moz-border-radius-topleft: 3px; -moz-border-radius-topright: 3px; -webkit-border-top-right-radius: 5px; -webkit-border-top-left-radius: 5px;">
<h1 style="color: #333333; font: bold 22px Arial, Helvetica, sans-serif; margin: 0; display: block !important;">
<!-- To have a header image/logo replace the name below with your img tag -->
<!-- Email clients will render the images when the message is read so any image -->
<!-- must be made available on a public server, so that all recipients can load the image. -->
<a href="https://community.jboss.org/index.jspa" style="text-decoration: none; color: #E1E1E1">JBoss Community</a></h1>
</td>
</tr>
<tr>
<td bgcolor="#FFFFFF" style="font: normal 12px Arial, Helvetica, sans-serif; color:#333333; padding: 20px; -moz-border-radius-bottomleft: 4px; -moz-border-radius-bottomright: 4px; -webkit-border-bottom-right-radius: 5px; -webkit-border-bottom-left-radius: 5px;"><h3 style="margin: 10px 0 5px; font-size: 17px; font-weight: normal;">
Debugging and Browsing OpenShift Applications in Eclipse
</h3>
<span style="margin-bottom: 10px;">
modified by <a href="https://community.jboss.org/people/maxandersen">Max Rydahl Andersen</a> in <i>JBoss Tools</i> - <a href="https://community.jboss.org/community/tools/blog/2012/02/08/debugging-and-browsing-openshift-applications-in-eclipse">View the full blog post</a>
</span>
<hr style="margin: 20px 0; border: none; background-color: #dadada; height: 1px;">
<div class="jive-rendered-content"><p>Latest OpenShift enabled port-forwarding for your OpenShift applications.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>This enables you to use a debugger for your JBoss application and it allows you to connect to the database directly and use tools like Eclipse Database Browser instead of only using phpsqlmyadmin. </p><p>Of course once you have these things setup in your Eclipse you can use things like reverse engineering and even run your local app against the remote database.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>It all works by setting up an ssh tunnel that exposes the internal remote ports running on OpenShift servers on your local machine - this does require some manual steps which i'm outlining in this blog</p><p>together with how to configure the database setup in Eclipse and how to remote debug JBoss running on OpenShift.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>In future releases of JBoss Tools we'll be looking at simplifying these steps, but for now here are the fully manual steps.</p><h1 id="settingupportforward">Setting up port forward</h1><p>The simplest way to do this is to use the rhc command line tools.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Make sure you got the latest version - how to install/update these for various platforms is documented <a class="jive-link-external-small" href="https://openshift.redhat.com/app/express#quickstart">here</a>.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Once you have those run <code>rhc-port-forward -a <appname></code>.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>I have an app called ‘fonk’ of type ‘jboss-as7’ and with ‘mysql’ cartridge enabled. For such a setup you should see something like this:</p><pre><code>rhc-port-forward -a fonk
Password:
Checking available ports...
Binding httpd -> 127.1.255.130:8080...
Binding java -> 127.1.255.129:8080...
Binding mysqld -> 127.1.255.129:3306...
Use ctl + c to stop</code></pre><h1 id="osxgotcha">OSX gotcha</h1><p>In case you get an error print out similar to this:</p><pre><code>bind: Can't assign requested address
channel_setup_fwd_listener: cannot listen to port: 3306
bind: Can't assign requested address
channel_setup_fwd_listener: cannot listen to port: 8080
bind: Can't assign requested address
channel_setup_fwd_listener: cannot listen to port: 8080
Could not request local forwarding.</code></pre><p>You are most likely running OS X which unfortunately(?) does not automatically allow you to have all 127.x.x.x IP’s setup with a so called loopback alias.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>To fix this you need to add such alias manually for each IP you want to connect to. </p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>In my case that is <code>127.1.255.130</code> and <code>127.1.255.129</code> as seen in the first attempt of using rhc-port-forward. These IP’s will be different for each of your app, thus for `fonk’ app I enable loopback aliases by running the following:</p><pre><code>sudo ifconfig lo0 alias 127.1.255.130
sudo ifconfig lo0 alias 127.1.255.129</code></pre><p>Now when you run <code>rhc-port-forward</code> you should not be seeing any <code>bind: Can't assign requested address</code>. error messages.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Note: these alias’es does not survive reboots - if anyone know how to setup global loopback alias or make these persistent between reboots then I would love to hear about that in the comments <span> :) </span></p><h1 id="useopenshiftdatabaselocally">Use OpenShift database locally</h1><p>When port forwarding is enabled you can start using these, for example to setup and connect to MySql database via Eclipse DTP Tools.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>To do this open the Data Source Explorer:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17933/datasourceexplorer.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17933/260-176/datasourceexplorer.png </span></a></p><p>Click on the “New Connection Profile” and choose MySql and give it a name.</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17934/newconnectionprofile.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17934/310-282/newconnectionprofile.png </span></a></p><p>Click Next and if you do not have an existing driver for MySQL configured you will see an empty list:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17935/emptydriver.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17935/310-310/emptydriver.png </span></a></p><p>To add a driver click the + icon and setup a driver:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17936/mysqldrivermissingjar.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17936/310-258/mysqldrivermissingjar.png </span></a></p><p>For OpenShift MySQL the 5.1 option is best, and it just needs to be told where the driver is under the “Jar List” tab. Here you click the “Edit JAR/Zip” and point it to your downloaded mysql-connectoer-java-5.1.jar.</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17937/editedjarlist.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17937/310-258/editedjarlist.png </span></a></p><p>Once that is done you just need to fill in the right connection details:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17938/connectiondetails.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17938/310-310/connectiondetails.png </span></a></p><p>The important part for the connection details is that you set URL to match the pattern:</p><pre><code>jdbc:mysql://<forwarded-ip>:3306/<appname></code></pre><p>For my <code>fonk</code> application that would be:</p><pre><code>jdbc:mysql://127.1.255.129.3306/fonk</code></pre><p>And then set “User Name” to <code>admin</code> and type in your MySql password.</p><p>You can use the “Test Connection” button to verify you can connect.</p><p>When you press Finish you should be able to browse your remote mysql database hosted on OpenShift:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17940/datasourceexplorerconnected.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17940/259-239/datasourceexplorerconnected.png </span></a></p><p>From here on out you can now use this Eclipse dataconnection with any plugin that supports such connections. i.e. Hibernate Tools reverse engineering features.</p><h1 id="debugjbossas">Debug JBoss AS</h1><p>To enable debug with JBoss we need to add a <code>enable_jpda</code> marker file to <code>.openshift/markers</code>.</p><p>This is done by simply executing the following:</p><pre><code>cd git/fonk
touch .openshift/markers/enable_jpda
git add .openshit/markers/enable_jpda
git commit -a -m "enable jpda"
[master 6f7197c] enable jpda
0 files changed, 0 insertions(+), 0 deletions(-)
create mode 100644 .openshift/markers/enable_jpda
git push
<openshift remote build output></code></pre><p>Note: you can of course also do this all from within Eclipse via EGit integration if you prefer that.</p><p>When this have been enabled you need to start/restart port-forwarding to get it to pick up the java jpda port.</p><pre><code>rhc-port-forward -a fonk
Password:
Checking available ports...
Binding httpd -> 127.1.255.130:8080...
Binding java -> 127.1.255.129:8080...
Binding java -> 127.1.255.129:8787...
Binding mysqld -> 127.1.255.129:3306...
Use ctl + c to stop</code></pre><p>Notice the <code>Binding java -> 127.1.255.129:8787....</code> line, that is the jpda ip and port you are going to use.</p><p>Now to set this up in Eclipse JDT debugger you need to create a ‘Remote Java Application’ under “Debug Configurations”</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17941/debugconfigurations.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17941/208-121/debugconfigurations.png </span></a></p><p>And here you select ‘Remote Java Application’ and fill in the connection details:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17944/setupremotedebug.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17944/450-303/setupremotedebug.png </span></a></p><p>The important pieces here are to set Host: to the ip number (in my case <code>127.1.255.129</code>) and the port wich for JBoss AS on OpenShift is <code>8787</code> by default.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>The Project part is optional, but its useful to point it to the matching Eclipse project which will allow it to find the proper source and let you place breakpoints.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Once you press “Debug” it should go and connect to the running server. It might take a while, it is after all going into the Cloud <span> :) </span></p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>And if you now set breakpoints and use a browser to trigger them you get something like this:</p><p><a href="https://community.jboss.org/servlet/JiveServlet/showImage/38-4525-17943/debugjsp.png"><span> https://community.jboss.org/servlet/JiveServlet/downloadImage/38-4525-17943/450-473/debugjsp.png </span></a></p><p>This showing the remote debugger hitting the breapoint in a jsp page named <code>snoop.jsp</code>.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><h1 id="conclusion">Conclusion</h1><p>I hope I showed you how powerful OpenShift’s latest release with port-forwarding is and how (fairly) easy it is to setup once you get the port-forwarding working.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Being able to connect directly to the remote database and debug you JBoss server makes for a whole new world of possibilities and productivity boost with OpenShift.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>Hope you like it and continues to have fun exploring OpenShift and JBoss Tools.</p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>/max </p></div>
<div style="background-color: #f4f4f4; padding: 10px; margin-top: 20px;">
<p style="margin: 0;">Comment by <a href="https://community.jboss.org/community/tools/blog/2012/02/08/debugging-and-browsing-openshift-applications-in-eclipse">going to Community</a></p>
</div></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>