Liferay IDE Remote Server Adapter
Requirements For Tutorial #
- Liferay IDE 1.6.2
- Liferay Portal Server 6.1.1 CE GA2
- Liferay Portal Server 6.1.x running remotely (Tomcat, JBoss, Glassfish servers supported, Proxies and SSL connections not supported at this time)
- OmniAdmin username/password for remote Liferay Portal instance
The Remote Server Adapter is a feature of Liferay IDE where you can deploy your Liferay projects to a remote Liferay Portal instead of using a locally launched and managed Portal server. The remote instance of Liferay Portal must have the Remote IDE Connector application installed from Liferay marketplace. This application installs the server-manager-web plugin for Liferay that provides an API for Liferay IDE's Remote Server Adapter to use for all its remote operations.
Configure the Remote Server Adapter #
You can configure both the remote server adapter and optionally installing the Remote IDE Connector into the remote Liferay Portal instance all through the Remote Server Wizard in Liferay IDE. Below are the steps to follow:
- Ensure that the remote Liferay Portal instance is running and you can login using OmniAdmin username/password
- In Eclipse with Liferay IDE plugins installed, go to new Server wizard File > New > Other > Server > Liferay > Remote Liferay Server
- Select Next
- The next page of remote server configuration remote server is to define the Liferay Portal Runtime Stub. This will allow projects created for this server to use this runtime stub for statisfying jar dependencies needed to compile various Liferay projects. Select bundle type based on your local Liferay Portal Tomcat bundle, then browse to the bundle installation directory.
- Select Next
- The next page is for configuring the connection to the remote Liferay Portal instance. Enter in the host, port and OmniAdmin username/password. The next two fields can be left as the defaults unless you have made changes to your remote Portal environment.
- In order for this connection to the remote Liferay Portal to work, the Remote IDE Connector application must be installed in the remote Portal. If you have not installed that application, you can click the link at the bottom of the page to jump to the marketplace control panel to install the Remote IDE connector.
- Click the Free button to purchase the Remote IDE Connector application and follow the onscreen prompts.
- Once it is purchase select the Purchased page in the control panel.
- Download and install the Remote IDE Connector, once it is installed return to Eclipse and the Remote Server config wizard
- Select Validate connection and no warnings or errors should be displayed if you have supplied the correct OmniAdmin username/password.
- Select Finish
- Once you select Finish, the new Remote Server will be available in the Servers view and if the connection settings were correct, Eclipse will connect to the remote server. Then the remote liferay logs will be displayed in Eclipse's console. If your remote server is in debug mode, the Eclipse java debugger will be attached to the remote process automatically.
- If the settings are invalid and the connection can't be established, you can modify the Remote Server settings at any time by double-clicking the server instance in the Servers view and modify the settings in the configuration editor.
Using the Remote Server Adapter #
Once you have the Remote Server correctly configured and connected in Eclipse, you can begin using it as you would a local Liferay Portal Tomcat server, publishing projects to the server.
- Right-click the server and choose Add and Remove modules...
- Select Liferay projects you wish to publish to the remote server, select Finish
- The deployment process should start and after it is published to remote server you should see a message saying plugin is deployed
- After you have made the initial remote deployment, if you make any changes to your project, you will need to publish these changes (or have them published automatically in the settings). To invoke a publish operation (after having modified some project files) right click on the server in the Servers view and select Publish
- If you want to modify the publish operation behavior, you can do that in the server configuration editor (double-click server in Servers view)
#If you receive errors, visit the Liferay IDE forums and post the warning/error to try to get help.