GateIn Documentation

GateIn

This is a very rough documentation issued from the merge, content still has to be validated, we still hope that it can help the beta testers. Thanks !


1. Introduction
1.1. Links
2. Configuration
2.1. PicketLink IDM integration
2.1.1. Configuration files
2.2. Default Portal Configuration
2.2.1. Overview
2.2.2. Configuration
2.3. Portal Navigation Configuration
2.3.1. Overview
2.3.2. Portal Navigation
2.3.3. Portal.xml
2.3.4. Navigation.xml
2.3.5. Pages.xml
2.3.6. Portlet-preferences.xml
2.3.7. Group Navigation
2.3.8. User Navigation
2.3.9. Tips
2.4. Predefined User Configuration
2.4.1. Overview
2.4.2. Plugin for adding users, groups and membership types
2.4.3. Membership types
2.4.4. Groups
2.4.5. Users
2.4.6. Plugin for monitoring user creation
2.5. Portal Default Permission Configuration
2.5.1. Overview
2.5.2. Overwrite Portal Default Permissions
2.6. Database Configuration
2.6.1. Overview
2.6.2. DB and datasource configuration
2.6.3. JCR database configuration
2.7. Data Injector Configuration
2.7.1. Data Injector
2.7.2. OrganizationInitializer
2.7.3. Service configuration file
2.7.4. Parameters for Group
2.7.5. Parameters for User
2.8. Skin Configuration
2.8.1. Overview
2.8.2. Skin Switching
2.8.3. Skins in Page Markups
2.8.4. Types of Styles
2.8.5. Portlet Styles
2.8.6. How to Configure a Portal Skin
2.8.7. Tips and Tricks
2.8.8. How to create a new skin
2.8.9. How to create new themes
2.9. Javascript Configuration
2.10. Dashboard configuration
2.10.1. Parameters (in edit mode)
2.11. Authentication Token Configuration
2.11.1. Overview
2.11.2. What is token service
2.11.3. Implement token service's API
2.11.4. Configure token services
3. Integration
4. Single Sign On
4.1. Overview of SSO
4.2. CAS - Central Authentication Service
4.2.1. Integration
4.2.2. CAS Server Plugin Configuration
4.2.3. GateIn Agent Configuration
5. Development
5.1. Portal Lifecycle
5.1.1. Overview
5.1.2. Application Server start and stop
5.1.3. The Command Servlet
5.2. RTL (Right To Left) Framework
5.2.1. Overview
5.2.2. Direction
5.2.3. Groovy templates
5.2.4. Stylesheet
5.2.5. Images
5.2.6. Client side JavaScript
5.3. Internationalization Configuration
5.3.1. Overview
5.3.2. Locales configuration
5.3.3. ResourceBundleService
5.3.4. Navigation Resource Bundles
5.3.5. Portlets
5.4. XML Resources Bundles
5.4.1. Motivation
5.4.2. Portal support
5.4.3. XML format
5.5. Dynamic Layouts
5.5.1. Overview
5.5.2. Advanced Drag and Drop mechanism
5.5.3. Summary
5.6. JavaScript Inter Application Communication
5.6.1. Overview
5.6.2. /eXo
5.6.3. /eXo/portal/notification
5.6.4. Library
5.6.5. Syntax
5.6.6. Example
5.7. Upload Component
5.7.1. Overview
5.7.2. Upload Service
5.7.3. How to use the upload component in your application
5.8. Deactivation of the Ajax Loading Mask Layer
5.8.1. Overview
5.8.2. Purpose of requirement
5.8.3. How to deactivate ajax-loading mask in your code
5.8.4. Synchronous issue
5.9. Accessing User Profile
6. Portlet development
6.1. Web User Interface - WebUI
6.1.1. Resources
6.2. AJAX in GateIn Framework
6.2.1. Overview
6.2.2. Portlet Preparation
6.2.3. AJAX in the Groovy template
6.2.4. How JavaScript works
6.2.5. PortletResponse
6.2.6. PortalResponse
6.2.7. AjaxRequest
6.2.8. HttpResponseHandler
6.2.9. Portal Ajax Response Data Structure
6.2.10. Manage Several Popups
6.3. Groovy Templates
6.3.1. Overview
6.3.2. Basic structure
6.3.3. Groovy language
6.3.4. Linking a portlet with a template
6.4. Portlet Lifecycle
6.4.1. Overview
6.4.2. Portlet init
6.4.3. Portlet request handler
6.4.4. ProcessAction phase
6.4.5. Render phase
6.5. Portlet Primer
6.5.1. JSR-168 and JSR-286 overview
6.5.2. Tutorials
6.6. Create a WebUI Portlet
6.6.1. Overview
6.6.2. Configure the portlet
6.6.3. Use the Portlet
6.6.4. Add a "HelloWorld" popup
7. Gadget development
7.1. Gadgets
7.1.1. Overview
7.1.2. Existing Gadgets
7.1.3. Create a new Gadget
7.1.4. Remote Gadget
7.1.5. Gadget Importing
7.1.6. Gadget Web Editing
7.1.7. Gadget IDE Editing
7.1.8. Dashboard Viewing
7.2. Setup a Gadget Server
7.2.1. Setup virtual servers for the gadget rendering
7.2.2. Configuration
8. Single Sign On
8.1. Overview of SSO
8.2. CAS - Central Authentication Service
8.2.1. Integration
8.2.2. CAS Server Plugin Configuration
8.2.3. GateIn Agent Configuration