Monday, 12 December 2011

Liferay Portlet Configuration Files

Configuration file:

liferay-display.xml: This file describes for Liferay what category the portlet should appear under in the Add Application window.

liferay-portlet.xml: This file describes some optional Liferay-specific enhancements
     portlet-name      The portlet-name element contains the canonical name of the portlet. This needs to be
                                 the same as the portlet-name given in portlet.xml.
     icon                     Path to icon image for this portlet.
     instanceable      Indicates if multiple instances of this portlet can appear on the same page.
     struts-path        Tells the portal that all requests with the path ext/library/* are considered part of
                                this portlet's scope. For example, a struts-path of ext/library will give us access to
                                /ext/library/view in struts-config.xml, but not /ext/reports/view.
portlet.xml:  This files has the below configuration options.
      portlet-name      The portlet-name element contains the canonical name of the portlet.   Each portlet
                                  name is unique within the portlet application. (This is also referred within Liferay Portal
                                  as the portlet id).
      display-name    The display-name type contains a short name that is intended to be displayed by tools.
                                 It is used by display-name elements. The display name need not be unique.
      portlet-class     The portlet-class element contains the fully qualified class name of the portlet.
              init-param:    The init-param element contains a name/value pair as an initialization param of the
      expiration-cache: Expiration-cache defines expiration-based caching for this portlet. The parameter
                                 indicates the time in seconds after which the portlet output expires. -1 indicates that the
                                 output never expires.
      supports:     The supports element contains the supported mime-type. Supports also indicates the portlet
                          modes a portlet supports for a specific content type. All portlets must support the view
       portlet-info:    Portlet-info defines portlet information.

       security-role-ref : The securit-role-ref element contains the declaration of a security role reference in
                                      the code of the web application.

    Specifically in Liferay, the role-name references which role’s can access the portlet.(A Power User can personalize the portal, whereas a User cannot.)

No comments:

Post a Comment