Welcome!

Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Understanding the Advisor Framework

Understanding the Advisor Framework

This series of articles focuses on demystifying the frameworks embedded in the BEA WebLogic Portal. The first framework that will be discussed in-depth is the Advisor Framework, followed in future articles by the Event Framework and the Portal Framework.

The Advisor Framework is designed to be an adaptable engine with plug-in points for extending WebLogic Portal's personalization functionality. The main components in the Advisor Framework are the Advisor, AdvisletRegistry, and Advislet classes; the JSP tags; and the Advislet XML Registry. This article will discuss each component, take you through the framework execution scenario, and explain how to implement and configure a custom Advislet.

Advisor Framework
The key Java components in the Advisor Framework are the Advisor stateless session EJB, the AdvisletRegistry static class, and the different types of Advislet objects (see Figures 1 and 2). At a high level, the personalization JSP tags or a fat Java client would invoke the Advisor with a personalization request; the Advisor would then request the appropriate Advislet from the AdvisletRegistry. After receiving the Advislet, the Advisor would validate the minimal existence and correctness of the request information to ensure that the required data is available to the Advislet. The knowledge concerning what data the Advislet requires is contained within the Advislet itself and is requested by the Advisor during the data validation check. After validating that sufficient data is available, the Advisor requests that the Advislet perform its specific personalization task and return an Advice object that contains the results of the processing. To accomplish the appropriate functionality, the executing Advislet would make use of the different portal services such as the Rules Manager, User Profile Management, and Content Manager.

Advisor
The Advisor is a stateless session EJB that implements the Session Facade J2EE pattern. The Advisor's main responsibility is to encapsulate the business processing required to implement the behavior requested by the personalization JSP tag or fat Java client. As shown in Figure 2, the Advisor gets the Advislet from the AdvisletRegistry, validates the minimal existence and correctness of the request data, and executes the Advislet. After successful completion of the process, an Advice object is returned to the calling client.

AdvisletRegistry
The AdvisletRegistry is a static class that contains the knowledge of how to parse the URI string being sent by the client and which AdvisletChainElement type to retrieve from its collection. The AdvisletRegistry class also performs the registering and unregistering of the Advislet and AdviceTransform types specified in the "advislet-registry.xml" file into its internal store. The registry pattern used here provides the flexibility of modifying personalization behavior assigned to specific "tags" without requiring the redevelopment of existing code.

Advislet
Advislets are command objects responsible for interacting with the appropriate services to perform the required personalization task. Out of the box, there are Advislets to classify users, perform documentation searches, and do rules-based matching of user profile information and tagged content. Custom Advislets can also be written to perform specific value-added actions. To write a custom Advislet, you have to implement the Advislet interface and provide implementations for the getAdvice, getRequiredAttributes, and validateAdviceRequest methods (see Figure 3). An abstract class, AbstractAdvislet, is provided to help in the development of custom Advislets. To use the AbstractAdvislet class, simply extend the class, override the getAdvice method, and implement a constructor that takes both the Advisor and metadata objects as arguments. The Advisor argument is a reference to the Advisor creating this Advislet, and the metadata argument is a reference to an object containing the Advislet's name, description, and version information as specified in the Advislet XML Registry.

CompoundAdvislet
Although the CompoundAdvislet interface is shown in Figure 3, you shouldn't implement this interface or extend the provided CompoundAdvislet implementation. This aspect of the Advislet hierarchy is included simply to inform you that Advislets and AdviceTransforms can be chained together to form a sequence of interlinking components. If executed, the CompoundAdvislet implementation would request the AdvisletRegistry for each Advislet and AdviceTransform, in the sequence specified in the "advislet-registry.xml" file. The pipe-and-filter pattern used here allows you to develop Advislet and AdviceTransform classes that are independent of each other and link them together to provide a complex personalization process. Additionally, this pattern increases the potential for reuse and adaptability.

AdviceTransform
AdviceTransforms are data-mapping objects responsible for mapping the output results from one Advislet to the input parameters for the next Advislet in the sequence. To write a custom AdviceTransform, a developer would have to implement the AdviceTransform interface and provide an implementation for the transform method (see Figure 3). An abstract class, AbstractAdviceTransform, is provided to help in the development of custom AdviceTransform implementations. To use the AbstractAdviceTransform class, simply extend the class, override the transform method, and implement a constructor that takes both the Advisor and metadata objects as arguments. The Advisor argument is a reference to the Advisor creating this AdviceTransform, and the metadata argument is a reference to an object containing the AdviceTransform's name, description, and version information as specified in the Advislet XML Registry. Out of the box, there are AdviceTransform types to transform standard objects into input objects for the rules engine, the output of the rules engine into the input object for content query, and the results of a classification into the input object for content selection.

Advislet XML Registry
The Advislet XML Registry contains a listing of all the required Advislet and AdviceTransform elements, their descriptive and configuration information, and the sequence logic for CompoundAdvislets. The information contained in the Advislet XML Registry file is the same information that's loaded in the local store of the AdvisletRegistry class and is scoped to the containing application. To register a custom Advislet in the XML file, simply open the "advislet-registry.xml" file found in the "ejbadvisor.jar" file and add the appropriate lines, making sure to follow the XML Schema provided. The example shown in Listing 1 adds a custom Advislet called MyAdvislet to the registry file.

To register a custom CompoundAdvislet in the XML file, open the same "advislet-registry.xml" file and add the appropriate lines, again making sure to follow the XML Schema provided. The example shown in Listing 2 first adds a custom AdviceTransform called MyAdviceTransform before adding a CompoundAdvislet called MyCompoundAdvislet to the registry file. Notice that the sequence elements of the CompoundAdvislet group list the Advislet and AdviceTransform classes to call and the sequence in which to execute them.

JSP Tag Library
Three JSP tags are pertinent to the Advisor Framework: <pz: div>, <pz:contentQuery>, and <pz:contentSelector>. These tags allow JSP developers to access the personalization features of WebLogic Portal without having to write EJB client code. (For more information on the parameters for each JSP tag and for the entire WebLogic Portal JSP tag library, visit the BEA online documentation Web site: http://edocs.bea.com.)

<pz:div>
The <pz:div> JSP tag provides the functionality to wrap JSP code segments within a business rule that is dependent upon profile information. That is, a business rule can be called to allow the execution of a JSP code segment within a JSP file only when the profile information matches the business rule requirements. In the example below, the JSP contents contained within the opening (i.e., <pz:div>) and closing (i.e., </pz:div>) tags will be executed only if the rule evaluates to TRUE.

<%@ taglibs URI="pz.tld" prefix="pz" %>
.
.
.

<pz:div rule="JavaDeveloper">
<p>This section will be displayed if the
user's profile has developer=java </p>
</pz:div>

This personalization feature allows the runtime dynamic determination of static content and functionality to be displayed to the user.

<pz:contentQuery>
The <pz:contentQuery> JSP tag provides the functionality to search for tagged content stored in the third-party content management system, which has been integrated into WebLogic Portal using a published content management system SPI. In the example shown in Listing 3, a result set of content objects will be returned that contains information matching the query string "title='WebLogic Developers Journal'"

This feature provides JSP developers with the ability to dynamically retrieve content contained within the integrated content management system.

<pz:contentSelector>
The <pz:contentSelector> JSP tag combines the functionality of the <pz:div> JSP tag with a content query rule. That is, two actions will occur in sequence when this JSP tag is used, where the second action is dependent upon the first action evaluating as TRUE. In the first action, the Advisor Framework will execute a classification rule that will determine if the profile requirements are met. In the second action, the Advisor Framework will execute a content query rule that will return a result set of content objects that match the query string contained within the rule. In the example shown in Listing 4, a result set of content objects will be returned if the personalization rule evaluates that the profile requirements have been met and that there is tagged content in the content management system that matches the rule's content query string.

This feature provides the ability to decouple the personalized content query logic from the JSP UI development layer. JSP developers can focus on developing UI logic, while the underlying Advisor Framework can focus on performing the required content personalization aspects.

Conclusion
The Advisor Framework enables the creation of an application that allows business rules to drive the presentation of content and functionality to the right person at the right time. The out-of-the-box Advisor Framework components include personalization JSP tags, a runtime engine, an XML Advislet configuration file, and components that classify users, enable documentation searches, and perform rules-based matching of user profile information and tagged content. In addition, the framework also provides an extendable interface that allows the easy inclusion of custom personalization components.

More Stories By Dwight Mamanteo

Dwight Mamanteo is a technical manager with the Global Alliances Technical Services
organization at BEA Systems. He has been with BEA since 1999 and his current
job responsibilities include providing technical enablement support to BEA's
strategic SI and ISV partners. He has
been involved with object-oriented programming, design and architecture since 1993.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
SYS-CON Events announced today that Evatronix will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
An increasing number of companies are creating products that combine data with analytical capabilities. Running interactive queries on Big Data requires complex architectures to store and query data effectively, typically involving data streams, an choosing efficient file format/database and multiple independent systems that are tied together through custom-engineered pipelines. In his session at @BigDataExpo at @ThingsExpo, Tomer Levi, a senior software engineer at Intel’s Advanced Analytics gr...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things’). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing? IoT is not about the devices, it’s about the data consumed and generated. The devices are tools, mechanisms, conduits. In his session at Internet of Things at Cloud Expo | DXWor...
Everything run by electricity will eventually be connected to the Internet. Get ahead of the Internet of Things revolution. In his session at @ThingsExpo, Akvelon expert and IoT industry leader Sergey Grebnov provided an educational dive into the world of managing your home, workplace and all the devices they contain with the power of machine-based AI and intelligent Bot services for a completely streamlined experience.
SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...