This wiki does not contain official documentation and is currently deprecated and read only. Please try reading the documentation on the Liferay Developer Network, the new site dedicated to Liferay documentation. DISCOVER Build your web site, collaborate with your colleagues, manage your content, and more. DEVELOP Build applications that run inside Liferay, extend the features provided out of the box with Liferay's APIs. DISTRIBUTE Let the world know about your app by publishing it in Liferay's marketplace. PARTICIPATE Become a part of Liferay's community, meet other Liferay users, and get involved in the open source project. Portlet Undeploy
Project Title #
Portlet Undeploy
Background #
Liferay Portal deployments consist of the base portal, plus small applications called portlets which conform to the JSR-168 or JSR-286 JCP standard. These portlets are packaged and deployed to the application server like any other web application.
Liferay provides a couple of ways to deploy these portlets:
- Hot-deploy, by copying the .war files to a special directory which is periodically scanned for new files
- Use the GUI to upload a .war file from your desktop.
- Configure Liferay to use JSR-88 for deploying portlets
To remove (undeploy) a portlet, an administrator must manually delete the files from the application server in an application-server specific way.
Use Cases #
- An administrator wants to test out a portlet by deploying, quickly testing, and undeploying. The admin is working remotely without access to the command line.
- An administrator wants to remove a poorly-behaving portlet easily through the GUI.
The Problem #
There are no interfaces in Liferay for easily and reliably undeploying portlets. Currently, the only way to undeploy is to delete the application or manually undeploy its representative web application from an application-server-specific API.
The Solution #
Provide administrators with an easy to use undeploy mechanism. For example, on the "Plugins Installation" screen within Liferay's Control Panel, there is a list of deployed portlets. Beside each one of these could be an "undeploy" button:
Skills Needed #
- Required: Java, JSP
- Nice to have: Struts, AlloyUI, Liferay
Prerequisites #
None.
Deliverables #
- Complete code changes to Liferay Portal 6.0.6 to allow administrators to undeploy portlets using Liferay-specific APIs or UI options.
- Unit tests for all new and changed code.
- Documentation required to configure this option..
References #
Related Issues #
External References #
None.
