SercurityUnknown Author2011-04-30T11:57:00Unknown Author2011-04-30T08:39:00Unknown Author2011-04-30T08:40:00Unknown Author2011-10-11T10:39:00Unknown Author2011-10-11T10:40:00Greg 2011-10-11T16:28:00

Unknown Author2011-10-12T13:01:00

Eclipse Greg 2011-10-11T16:28:00

packageGreg 2011-10-11T16:30:00

Java EE for developers Greg 2011-10-11T16:27:00

HeliosUnknown Author2011-10-12T13:00:00

Indigo Java EE for developers Unknown Author2011-10-12T13:00:00Unknown Author2011-10-12T13:01:00

(3.7.x)Unknown Author2011-10-12T13:01:00

Greg 2011-10-11T16:28:00Unknown Author2011-10-12T13:03:00

Eclipse Helios Java EE for developersUnknown Author2011-10-12T13:02:00

(3.6.x)Unknown Author2011-10-12T13:03:00Greg 2011-10-11T16:30:00

HeliosGreg 2011-10-11T16:30:00Greg 2011-10-11T16:30:00

GalileoGreg 2011-10-11T16:30:00Greg 2011-10-11T16:32:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:05:00

uUnknown Author2011-10-12T13:05:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:05:00

sUnknown Author2011-10-12T13:05:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:05:00

sUnknown Author2011-10-12T13:07:00

http:/Unknown Author2011-10-12T13:06:00

/releases.liferay.com/tools/ide/eclipse/Greg 2011-10-11T16:31:00

heliosUnknown Author2011-10-12T13:06:00

indigoUnknown Author2011-10-12T13:06:00

/stable/Unknown Author2011-10-12T13:07:00Unknown Author2011-10-12T13:08:00Greg 2011-10-11T16:31:00

heliosGreg 2011-10-11T16:31:00Unknown Author2011-10-12T13:08:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:09:00

uUnknown Author2011-10-12T13:09:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:09:00

sUnknown Author2011-10-12T13:09:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:09:00

sGreg 2011-10-11T16:33:00Unknown Author2011-10-12T13:09:00

http://releases.liferay.com/tools/ide/eclipse/helios/stable/Unknown Author2011-10-12T13:10:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:10:00

http://releases.liferay.com/tools/ide/eclipse/helios/nightly/Unknown Author2011-10-12T13:10:00Greg 2011-10-11T16:33:00Unknown Author2011-10-12T13:13:00

liferay-ide-eclipse-updatesite-1.Greg 2011-10-11T16:35:00

2.2Unknown Author2011-10-12T13:13:00

4.0Unknown Author2011-10-12T13:13:00

.zipUnknown Author2011-10-12T13:13:00Unknown Author2011-10-11T10:55:00

HeliosUnknown Author2011-10-11T10:55:00Unknown Author2011-10-11T10:54:00

Unknown Author2011-10-11T10:55:00Unknown Author2011-10-11T10:54:00Unknown Author2011-10-11T11:07:00

coorespondingUnknown Author2011-10-11T11:07:00Unknown Author2011-10-11T11:20:00Jorge Ferrer2011-04-30T13:02:00Unknown Author2011-04-30T08:34:00

Jorge Ferrer2011-04-30T13:03:00Unknown Author2011-04-30T08:18:00

getPUnknown Author2011-04-30T08:18:00Jorge Ferrer2011-04-30T13:16:00

()Jorge Ferrer2011-04-30T13:07:00Jorge Ferrer2011-04-30T13:08:00

()Unknown Author2011-04-30T08:19:00Unknown Author2011-04-30T08:21:00Unknown Author2011-04-30T08:20:00Unknown Author2011-04-30T08:20:00

nUnknown Author2011-04-30T08:20:00

…Unknown Author2011-04-30T08:20:00Unknown Author2011-04-30T08:20:00Unknown Author2011-04-30T08:22:00Unknown Author2011-04-30T08:26:00Unknown Author2011-04-30T08:26:00Unknown Author2011-04-30T08:27:00Unknown Author2011-04-30T08:28:00Unknown Author2011-04-30T08:28:00Unknown Author2011-04-30T08:28:00Unknown Author2011-04-30T08:29:00Unknown Author2011-04-30T08:28:00Unknown Author2011-04-30T08:29:00Unknown Author2011-04-30T08:29:00Unknown Author2011-04-30T08:29:00

pUnknown Author2011-04-30T08:29:00Unknown Author2011-04-30T08:29:00Unknown Author2011-04-30T08:30:00Unknown Author2011-04-30T08:30:00Unknown Author2011-04-30T08:30:00Unknown Author2011-04-30T08:30:00Unknown Author2011-04-30T08:30:00

Unknown Author2011-04-30T08:31:00Unknown Author2011-04-30T08:31:00

h

c

p

c

Unknown Author2011-04-30T08:33:00

Liferay Developer's Guide

Liferay Developer's Guide

Connor McKay, Editor

Jorge Ferrer, Editor

Copyright © 2011 by Liferay, Inc.

This work is offered under the Creative Commons Attribution-Share Alike Unported license.

You are free:

• to share—to copy, distribute, and transmit the work

• to remix—to adapt the work

Under the following conditions:

• Attribution. You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).

• Share Alike. If you alter, transform, or build upon this work, you may distribute the resulting work only under the same, similar or a compatible license.

The full version of this license appears in the appendix of this book, or you may view it online here:

http://creativecommons.org/licenses/by-sa/3.0

Contributors:

Joseph Shum, Alexander Chow, Redmond Mar, Ed Shin, Rich Sezov, Samuel Kong, Connor McKay, Jorge Ferrer, Julio Camarero, Daniel Sanz, Juan Fernández, Sergio González, Miguel Pastor, Jim Hinkey, Greg Amerson

Table of Contents

Table of Contents

Conventions    6

Publisher Notes    7

Updates    7

November 3rd 2010    7

February 27th 2011    7

March 9th 2011    7

April 7th 2011    8

April 29th 2011    8

October 11th 2011    8

1. Introduction    9

Developing applications for Liferay    9

Portlets    10

OpenSocial Gadgets    10

Reusing existing web applications    11

Supported Technologies    12

Extending and customizing Liferay    13

Customizing the look and feel: Themes    13

Adding new predefined page layouts: Layout Templates    13

Customizing or extending the out of the box functionalities: Hook plugins    13

Advanced customization: Ext plugins    14

Choosing the best tool for the job    14

2. The Plugins SDK    17

Initial Setup    17

Ant Configuration    18

Plugins SDK Configuration    19

Structure of the SDK    19

3. Portlet Development    21

Creating a Portlet    21

Deploying the Portlet    22

Anatomy of a Portlet    23

A Closer Look at the My Greeting Portlet    24

Writing the My Greeting Portlet    27

Understanding the Two phases of Portlet Execution    29

Passing Information from the Action Phase to the Render Phase    33

Developing a Portlet with Multiple Actions    36

Optional: Adding Friendly URL Mapping to the Portlet    37

4. Creating Liferay Themes    39

Introduction    39

Creating a Theme    40

Deploying the Theme    40

Anatomy of a Theme    40

Thumbnails    42

JavaScript    42

Settings    43

Color Schemes    44

Portal Predefined Settings    45

Theme inheritance    46

5. Hooks    49

Creating a Hook    49

Deploying the Hook    49

Overriding a JSP    50

Customizing JSPs without overriding the original    50

Performing a Custom Action    51

Extending and Overriding portal.properties    52

Overriding a Portal Service    52

Overriding a Language.properties File    54

6. Ext plugins    55

Creating an Ext plugin    56

Developing an Ext plugin    58

Set up    58

Initial deployment    58

Redeployment    61

Advanced customization techniques    62

Advanced configuration files    62

Changing the API of a core service    64

Replacing core classes in portal-impl    65

Licencing and Contributing    65

Deploying in production    65

Method 1: Redeploying Liferay's web application    66

Method 2: Generate an aggregated WAR file    66

Migrating old extension environments    68

Conclusions    68

7. Liferay IDE    69

Installation    70

Requirements    70

Installation steps    70

Alternative installation    72

Set up    72

Requirements    72

Liferay Plugins SDK Setup    72

Liferay Portal Tomcat Runtime / Server Setup    74

Testing/Launching Liferay Tomcat Server    78

Creating New Liferay Projects    79

Deploying New Liferay Projects to Liferay Server    81

Importing Existing Projects into Liferay IDE    83

Importing existing Liferay Project from a Plugins SDK    83

Create one single project from one plugin in an existing sources    83

Create multiple projects for all plugins in a Plugins SDK    85

Importing an existing Eclipse Project that is not aware of the Liferay IDE    87

Importing an existing Liferay IDE project    88

Verifying that the import has succeeded    89

8. Liferay APIs and Frameworks    91

Security and Permissions    91

JSR Portlet Security    91

Liferay's Permission System Overview    93

Implementing Permissions    93

Permission Algorithms    97

Adding a Resource    97

Adding Permission    98

Checking Permissions    99

Creating Helper Classes for Permission Checking    101

Asset Framework    102

Adding, updating and deleting assets    103

Entering and displaying tags and categories    105

Publishing assets with Asset Publisher    106

Service Builder    111

Define the Model    112

Overview of service.xml    112

Generate the Service    113

Write the Local Service Class    114

Built-In Liferay Services    115

Other frameworks    115

9. Resources for Liferay Developers    119

10. Conclusions    123

Preface

This guide was written as a quick reference to getting started developing on the Liferay Portal platform. It is a guide for those who want to get their hands dirty using Liferay's framework and APIs to create fantastic websites.

For a more exhaustive view into Liferay development, we encourage you to check out the complete, official guide to Liferay development, Liferay in Action, published by Manning Publications. You can find this book online at http://manning.com/sezov.

The information contained herein has been organized in a format similar to a reference, so that it will be easier to find specific details later.