Book Image

GateIn Cookbook

By : Ken Finnigan, Luca Stancapiano, Piergiorgio Lucidi
Book Image

GateIn Cookbook

By: Ken Finnigan, Luca Stancapiano, Piergiorgio Lucidi

Overview of this book

<p>Enterprises have websites constructed in different web frameworks and the need for them to work together cohesively. GateIn will provide the solution to effectively integrate them into a single website. GateIn is an open source website framework that does more than a web framework by letting you use your preferred one.<br /><br />This GateIn Cookbook provides solutions whether you're planning to develop a new GateIn portal, migrate a portal, or only need to answer a specific query. It is filled with bite-sized recipes for quick and easy problem resolution. From the beginning to the end it will guide you through the process of configuring and securing a portal, managing content and resources, and developing applications as you go.<br /><br />Beginning with installation and configuration, the book swiftly moves on to discussing content, users, and security. The second half covers all aspects of developing on a portal, such as portlets, gadgets, migration, and integration.<br /><br />The goal of the book is to show GateIn as an open source website framework piece by piece. Starting with simple recipes, you will see each step analyzed with code examples and images, before progressing to more advanced recipes.<br /><br />This GateIn Cookbook will help you with a quick approach to building portals.</p>
Table of Contents (19 chapters)
GateIn Cookbook
Credits
About the Authors
About the Reviewers
www.PacktPub.com
Preface
Index

Preface

Enterprises have websites constructed in different web frameworks and the need for them to work together cohesively. GateIn will provide the solution to effectively integrate them into a single website. GateIn is an open source website framework that does more than a web framework by letting you use your preferred one.

This GateIn Cookbook provides solutions whether you're planning to develop a new GateIn portal, migrate a portal, or only need to answer a specific query. It is filled with bite-sized recipes for quick and easy problem resolution. From the beginning to the end it will guide you through the process of configuring and securing a portal, managing content and resources, and developing applications as you go.

Beginning with installation and configuration, the book swiftly moves on to discussing content, users, and security. The second half covers all aspects of developing on a portal, such as portlets, gadgets, migration, and integration.

The goal of the book is to show GateIn as an open source website framework piece by piece. Starting with simple recipes, you will see each step analyzed with code examples and images, before progressing to more advanced recipes.

This GateIn Cookbook will help you with a quick approach to building portals.

What this book covers

Chapter 1, Getting Started, introduces the installation process of GateIn, using either a source code or the binary package. You will also learn how to configure storage and the email sender. Followed by how to set up the development environment for your customization.

Chapter 2, Managing Portal Contents Using the GUI, explains how to manage portal contents using the provided GUI. You will learn how to manipulate the core contents of the portal, starting with portal instances and continuing on to pages and portlets. You will then see how to configure the navigation tree of the portal and how to use dashboards.

Chapter 3, Managing Portal Contents Using XML, explores the same portal contents discussed in the previous chapter but shows how to manage everything through XML configuration. It will then guide you through implementing a separate portal instance with its own EAR.

Chapter 4, Managing Portal Users, introduces how to manage users and and how to setup an external LDAP store for managing authorities. It will show you how to extend and customize the default provider of the user profile and how to configure a Single Sign On (SSO) mechanism with some SSO providers.

Chapter 5, Securing Portal Contents, discusses how to configure portal security with Tomcat and JBoss, and explores all the JAAS modules available in GateIn. You will also learn how to set different roles and permissions for any portal contents.

Chapter 6, Developing Portlets, contains all the information you need to start implementing standard portlets. It will also cover the usage of the user locale, public render parameters and events.

Chapter 7, Developing Using Components API, introduces WebUI for creating new views and handling different skins in a portlet. You will also learn how to manage JavaScript and user locales.

Chapter 8, Migrating from Existing Portals, explains some methods for migrating existing portlets. You will see how to migrate transactional, authenticated, and JCR-based portlets. You will then learn how to import a skin from an existing website.

Chapter 9, Managing Gadgets, demonstrates how to import, remove, and create gadgets, and how to categorize them in the portal. You will see how to expose a gadget as a portlet and how to set user preferences.

Chapter 10, Frameworks in a Portal, includes an overview of the framework that you can use to implement portlets. You will learn how to implement a portlet using JSF 2, jQuery, and RichFaces 4.

Chapter 11, Managing Portal Resources with the Management Component, covers how to manage portal contents using the REST API and Command Line Interfaces (CLI).

Chapter 12, Managing Documents Using External ECM Systems, explores how to implement portlets for integrating some ECM systems such as any CMIS-compliant repository, JBoss ModeShape, Apache JackRabbit, and Alfresco. You will also see how to implement portlets using Spring WebScripts in Alfresco.

What you need for this book

In Chapter 1, Getting Started, you will see all the required components for building and executing GateIn. In summary, you should have:

  • Any operating system based on Linux, Mac OS X, or Windows

  • Java Development Kit (JDK) 1.6

  • Eclipse IDE

  • Apache Subversion (latest version)

  • Apache Maven (latest version)

  • GateIn Portal 3.2.0 and beyond

Who this book is for

This book is for anyone who needs to administer or develop applications on GateIn. Java and RESTful architecture skills are suggested but not needed.

Conventions

In this book, you will find a number of styles of text that distinguish between different kinds of information. Here are some examples of these styles, and an explanation of their meaning.

Code words in text are shown as follows: "We can include other contexts through the use of the include directive."

A block of code is set as follows:

<object type=
"org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">
 <field name="groupId">
   <string>/platform/users</string></field>
 <field name="membership">
   <string>member</string></field> 
</object>

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

<object type=
"org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup">
 <field name="groupId">
   <string>/platform/users</string></field>
 <field name="membership">
   <string>member</string></field> 
</object>

Any command-line input or output is written as follows:

>mvn clean package

New terms and important words are shown in bold. Words that you see on the screen, in menus or dialog boxes for example, appear in the text like this: "clicking the Next button moves you to the next screen".

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.

Reader feedback

Feedback from our readers is always welcome. Let us know what you think about this book—what you liked or may have disliked. Reader feedback is important for us to develop titles that you really get the most out of.

To send us general feedback, simply send an e-mail to , and mention the book title through the subject of your message.

If there is a topic that you have expertise in and you are interested in either writing or contributing to a book, see our author guide on www.packtpub.com/authors.

Customer support

Now that you are the proud owner of a Packt book, we have a number of things to help you to get the most from your purchase.

Downloading the example code

You can download the example code files for all Packt books you have purchased from your account at http://www.packtpub.com. If you purchased this book elsewhere, you can visit http://www.packtpub.com/support and register to have the files e-mailed directly to you.

Errata

Although we have taken every care to ensure the accuracy of our content, mistakes do happen. If you find a mistake in one of our books—maybe a mistake in the text or the code—we would be grateful if you would report this to us. By doing so, you can save other readers from frustration and help us improve subsequent versions of this book. If you find any errata, please report them by visiting http://www.packtpub.com/support, selecting your book, clicking on the errata submission form link, and entering the details of your errata. Once your errata are verified, your submission will be accepted and the errata will be uploaded to our website, or added to any list of existing errata, under the Errata section of that title.

Piracy

Piracy of copyright material on the Internet is an ongoing problem across all media. At Packt, we take the protection of our copyright and licenses very seriously. If you come across any illegal copies of our works, in any form, on the Internet, please provide us with the location address or website name immediately so that we can pursue a remedy.

Please contact us at with a link to the suspected pirated material.

We appreciate your help in protecting our authors, and our ability to bring you valuable content.

Questions

You can contact us at if you are having a problem with any aspect of the book, and we will do our best to address it.