The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. As in any JSF application, the file faces-config. It must contain the following information:. The other difference compare to a regular portlet application, can be found in the portlet descriptor. All JSF portlets define javax. GenericFacesPortlet as portlet class. This class is part of the JBoss Portlet Bridge.
Chapter 4. Portlet development. Portlet Primer 4. Portlet Primer. Portal Pages. Rendering Modes. View Generates markup reflecting the current state of the portlet. Edit Allows a user to customize the behavior of the portlet. Help Provides information to the user as to how to use the portlet.
Window States. Normal A portlet shares this page with other portlets. Minimized A portlet may show very little information, or none at all. Maximized A portlet may be the only portlet displayed on this page.
Maven This example is using Maven to compile and build the web archive. Deploying your first Portlet. Start JBoss Application Server if it is not already running.
Create a new portal page and add the portlet to it. Package Structure. GenericPortlet This is the mandatory descriptor files for portlets. It is used during deployment.. This is the mandatory descriptor for web applications. Portlet Class.
IOException ; import java. PrintWriter ; import javax. You can create themes using modules to contribute to separate areas of pages to provide flexibility, enhance the user experience, and maximize performance. To optimize themes on your website, use the theme optimization module framework.
The framework separates feature-specific logic and capabilities from the theme code. The following section introduces the programming tools available and discusses when it is most appropriate to use each of the tools. Models provide information that is needed by HCL Digital Experience to perform tasks such as content aggregation or building navigation to browse the aggregated content.
The information that is aggregated is represented through models that can be accessed programmatically by using the Model SPI read-only. The information of a model is usually persistent stored in a database but can also be transient computed and stored only in memory. Models can be represented by using a tree structure nodes have a parent-child relationship , a list structure, or a selection structure a selected element in a tree structure.
You can use the Controller SPI for portal administration. It allows you to modify portal resources. It enhances the read-only portal Model SPI by adding writable aspects. Portal Access Control provides interfaces for retrieving and modifying and access control information of portal resources, such as portlets or pages. Learn about portlets from a user's and an application developer's perspective. View a brief comparison between a portlet and a servlet and understand basic portlet concepts; know the effect of Java 2 security enablement on the operation of portlets that rely on certain privileges for processing.
The Java Portlet Specification addresses the requirements of aggregation, personalization, presentation, and security for portlets running in a portal environment. Portlet services are used to provide common functionality to portlets. Each portlet service has its own service-specific interface for the functionality that it offers. Learn about portal features that pertain to the Web 2. Refer to programming model guidelines for client-side mode or server-side mode. HCL Digital Experience supports multiple ways for portlets to exchange or share information.
Learn about dynamic user interfaces that include dynamic pages, dynamic portlets, dynamic UI configuration, dynamic UI properties, and shared dynamic UIs. Get an overview of how to develop a dynamic UI configuration. Collaborative Services are a set of methods and JavaServer Page tags that allow developers who are writing portlets for HCL Portal or other application servers to add Lotus collaborative functionality to their portlets.
The services can be used to develop new custom portlets, or to add collaborative functionality for example, menus or person links indicating online status to existing portlets. View important information and concepts related to portlet development. HCL Portal defines a set of portal-specific public render parameters, which can be used to work with portal-specific state information within portlets. HCL Digital Experience 8. The bridge provides customers an interface to developing and running JSF Portlets.
You can search HCL Digital Experience to find content that contains a specific text string in its title or content, or is tagged with a specific tag.
Developers can enhance and extend the tagging and rating features of the portal. For this purpose the portal tagging and rating feature provides service APIs that you can use to enhance tagging and rating by your requirements. You can configure an authoring portlet to use a launch page of your own design instead of the default user interface. Custom HTML fields are used to integrate third-party editors into the authoring interface.
A custom plug-in is a reusable Java class that you create to run a task. You can create custom plug-ins such as custom workflow actions, plug-ins to run when a page is rendered, plug-ins to store multi-locale text strings and plug-ins to run when a file is uploaded.
For example, you can use DDC to render social data that you have on your HCL Connections server or on other social platforms in the context of your portal pages. Other possible data sources include news feeds, task lists, product catalog information, to name just a few. This service provides the ID of the currently rendered item of a page or portlet. The API design for version 2. You display data from external sources, such as SQL databases, by using the same methods as you would when you create a website.
You can collect information from web content for Active Site Analytics. Web Content Manager supports for the notification of events such as item state changes, or services starting and stopping. These notifications can be delivered as messages to the Java messaging service. The advanced PAA file contains custom content. Learn to configure the sequence, transitions, and workflow of a set of screens. This section helps you resolve problems, use diagnostic tools and tracing to capture HCL Digital Experience system errors.
Reference View information that can help you use our product documentation including terms of use, trademarks, and more. Creating your own portlet service HCL Digital Experience Write a portlet service by defining the interface, writing the service implementation, making the service accessible, and registering the service. Writing a portlet service consists of four steps: The service provider interfaces can be used to write portlet services for Standard portlets.
Defining the interface This step is not required if you want to implement your service against an existing interface. Defining a portlet service interface requires the same careful considerations as defining any public API interface. A portlet service interface must extend the PortletService interface defined in the com.
The following is an example interface for the HelloWorldService. Figure 1. Extending the PortletService interface package sample. IOException; import javax.
RenderRequest; import javax. RenderResponse; import com. The service implementation must implement the PortletServiceProvider interface of the com. The PortletServiceConfig parameter of the init method allows you, for example, to access the configuration of the service see Registering the service for more information. Figure 2. Implementing the PortletServiceProvider interface package sample. IOException; import java.
PrintWriter; import java. Preferences; import javax. This step is optional. If you want your portlet service to be available for HCL portlets, you need to create an additional service interface that extends org. PortletService and provides the same functionality.
Figure 3. IOException; import org. PortletRequest; import org. PortletResponse; import org. In the following example, HelloService is the name of the portlet service, HelloServiceIBM is the name of the interface for HCL portlets, and the message configuration parameter is set with the value Greetings.
Use jndi. Property name Value jndi. HelloService sample. HelloServiceImpl2 sample. HelloServiceIBM sample. Tip: To check whether your service has been registered successfully, use the application server dumpNamespace tool. Rate this topic 5 stars 4 stars 3 stars 2 stars 1 star. Comment on this topic. By clicking this box, you acknowledge that you are NOT a U.
Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U. Federal Government customers through its partners immixGroup, Inc. Do not include any personal data in this Comment box. There are different portals out there with commercial and non-commercial licences. In this chapter we will briefly describe such portlets but for more details you should read the specifications available on the web.
A portal can be seen as pages with different areas and inside areas, different windows and each window having one portlet. A porlet can have different view modes, three modes are defined by the specification but a portal can extend those modes. The 3 modes are:.
Window states are an indicator of how much page real-estate a portlet should consume on any given page. There are 3 states defined by the specification:. The tutorials contained in this chapter are targetted toward portlet developers. Although they are a good starting and reference point, we do heavily recommend that portlet developers read and understand the Portlet Specification JSR This section will introduce the reader to deploying his first portlet in JBoss Portal.
Portlets are packaged in war files, just like other JEE applications. A typical portlet war file can also include servlets, resource bundles, images, html, jsps, and other static or dynamic files you would commonly include. GenericPortlet Interface. Just like in the servlet-world, you must declare what content-type the portlet will be responding in. Here we output the text Hello World! JBoss Portal requires certain descriptors be included in your portlet war, for different reasons.
Some of these descriptors are defined by the Portlet Specification, and some are specific to JBoss Portal. This file must adhere to its definition in the Portlet Specification. You may define more than one portlet application in this file.
Define your portlet name. It does not have to be the Class name. The supports attributes allow you to declare extra vital information about the portlet. The portlet's title will be displayed as the header in the portlet window, when rendered, unless it is overridden programatically.
This is a JBoss Portal specific descriptor that allows you create an instance of a portlet. The portlet-ref value must match the portlet-name value given in the packaged portlet. In our example, we are creating a portlet window, assigning it to a page, and specifying where it should appear on that page.
This is a specific descriptor to JBoss Portal.
0コメント