Patent Grant
7809837
The present invention incorporates by reference in its entirety the Web Services for Remote Portlets standard version 1.0, by the OASIS Group, available at http://www.oasis-open.org.
The present application relates to U.S. patent application Ser. No. 10/969,598, filed Oct. 20, 2004, entitled MESSAGE INTERFACE FOR CONFIGURING WEB SERVICES FOR REMOTE PORTLETS, inventors Subbu Allamaraju and Alexander Toussaint.
The present invention relates broadly to the delivery of web portal content. The present invention relates more particularly to systems, methods, and computer readable media for implementing the delivery of portal services from producer systems to consumer systems.
Since its inception in 1995, the Java programming language has become increasingly popular. Java, which is an interpreted language, enabled the creation of applications which could be run on a wide variety of platforms. This ability to function across a variety of different client platforms and Java's relatively easy implementation of network applications has resulted in its use in endeavors as basic as personal webpages to endeavors as complex as large business-to-business enterprise systems.
As Java has become more commonplace, a wide variety of tools and development platforms have been created to assist developers in the creation and implementation of Java applications and portals, which provide a way to aggregate content and integrate applications, allowing a visitor to a Web site to access everything via a user interface.
One ongoing need has been the ability for providers of web applications to prepare functional content that can be implemented through outside sites. Often providers will wish to offer web services without setting up the front-end interface elements that are necessary to implement the web services.
The Web Services for Remote Portlets (WSRP) standard by the OASIS group has enabled the delivery of functional applications from producer sites to consumer sites. However, the implementation of WSRP has presented considerable difficulties.
Additionally, current implementations of WSRP are somewhat difficult to configure. An administrator of a consumer system must obtain configuration information for a portlet and a producer and a submit the information to a configuration utility. Doing so often requires a prohibitively high level of expertise for a user of a consumer system. What is needed is an improved interface for configuring consumer systems to utilize remote portlets.
A web services system enables web servers to serve pages that utilize remote portlets. A consumer system serves pages that utilize remote portlets stored on one or more producer systems. An improved user interface enables a user to select a portlet from a page on a producer system and drag the portlet to a page on a consumer system. This action causes configuration information for the portlet to be transferred to the consumer system, which can then utilize the portlet as a remote portlet. When a user accesses a page utilizing a remote portlet, the consumer system contacts the producer system, obtains content for the page and presents the page to the user.
The consumer 115 is a network accessible system that serves web pages, content, and applications to other parties. The consumer 115 can serve its own content in addition to content stored on the producers 120, 125. The consumer 115 presents a web interface to the user systems that utilizes applications stored both locally and on the producers 120, 125. The consumer serves pages that utilize remote portlets on the producers through proxy portlets and allow the consumer to utilize the remote portlets' functionality. The proxy portlets are references to remote portlets that are stored within the web pages on the consumer that cause the portlets to appear within the consumer web pages.
During a registration phase, the consumer 115 registers with a producer 120. In one embodiment, the producer 120 identifies each consumer with a unique handle that enables the producer 120 to identify what portlets are available to a particular consumer. In some embodiments, the consumer does not register with the producer 120. The producer can provide a service description to the consumer 115 that indicates properties of the producer 120 and lists the available portlets that are stored on the producer 120. During a description phase, the producer 115 also provides a Web Services Description Language (WSDL) file indicating data types and message protocols to be used for interacting with the producer 120. This process is described in greater detail with respect to
When a user system 105 establishes contact with the consumer 115, the consumer aggregates pages, and stores proxy portlets in the pages that access remote portlets on the producer 120. The user system 105 can send a page request to the consumer 115 for a page that includes remote portlets that utilize the producer. When such a request is received by the consumer 115 from the user system 105, the consumer 115 sends a request for the data that appears in the page to the producer 120. The producer 120 returns the data, which the consumer integrates into a single user interface and presents to the end user system 105.
The producer core 205 is an application such as a servlet that is configured to reside on the producer and communicates with the consumer 115. The producer core 205 generates the WSDL files that indicate the parameters of communication between the producer 125 and the consumer 115 and transmits a file to the consumer 115 or otherwise provides the parameters to the consumer. These parameters can include data types and messaging protocols and can be preconfigured or user-selected.
The producer 205 additionally includes a service description handler 210. The service description handler 210 is responsible for providing a listing of portlets 224 that are available to consumers. The service description handler utilizes the portlet loaders 215 to load the portlet files 222. The portlet files 222, which define the available portlets, are either portlet files or files created from a deployment descriptor such as a portlet.xml file. In some embodiments, the portlet loaders 215 include separate loaders for different types of portlets such as Java Page Flow (JPF) portlets, Struts portlets, Java Specification Request (JSR) 168 base portlets, and Java portlets. Struts portlets are portlets that utilize the Struts framework layer from the Apache Software Foundation. JPF portlets are portlets that utilize Page Flows to separate interface content from navigation control and other functional logic. In some embodiments, the JPF portlets on the producer can support nested page flows. Nested page flows are page flows that can be utilized temporarily without discarding a currently executing page flow. While the above portlets types are used as examples throughout this application, it should be understood that any portlet type is supported.
The service description handler 210, through the producer core returns to the consumer 115 a list of available portlets in the form of an array of PortletDefinition classes or some other format. The PortletDefinition classes include a portletHandle identifier that identifies the portlet and modes, states, MIME types, a title, and a description for each portlet. Other information can also be provided.
A registration handler 270 registers consumers with the producer 125 so that the consumers can access portlets on the producer 125. The registration process entails the consumer 115 providing certain predetermined identification information to the producer 125. In some embodiments, the producer does not register the consumer. The consumer registration information can be stored in the database 270 through the persistence adapters 255 and persistence layer 265.
The portlet management handler 240 is responsible for storing, modifying, and retrieving portlet preferences and modifying or deleting portlets. The WSRP persistence adapters 255 are configured to receive requests to generate, modify, and read information stored in the database 270 from the registration handler 230 and portlet management handler 240. In one embodiment, the WSRP persistence adapters 255 include separate adapters for the registration handler 230 and the portlet management handler 240. The persistence layer 260 manages access to the database by representing data in the database as objects, and allows particular data types to be accessed as such without requiring that the accessing entity have any knowledge about how said data is stored in the database. When a request to modify data, such as modifying the registration information of a consumer is received from the registration handler 230 through its persistence adapter 255, the persistence layer 265 receives the request in the form of an object modification request. The persistence layer 265 locates the various instances in the database associated with the registration information and modifies them appropriately.
The markup handler 225 is responsible for processing markup requests for the portlets 224 (requests for the visual representation of the portlets within the page). When a request from a user system is received at the consumer, for example, a page is loaded that utilizes a remote portlet, the consumer 115 requests the appropriate render data from the producer. This request includes an identity of the portlet and a listing of capabilities of the user system. The markup handler 225 receives this request and determines an appropriate portlet adapter 220 to access the referenced portlet. The portlet adapters 220 are adapters that enable portlets 224 to be accessed as remote portlets. The portlet adapters can include portlet adapters for multiple portlet types, such as JPF, Java, JSR168, and Struts portlets. In some embodiments, a portlet adapter can comprise a Java ARchive (JAR) file that is inserted into a producer to enable it to interact with remote consumers in a manner similar to how the portlet would interact with a local portal.
A server module 242 generates an user interface layer that enables a user selecting a portlet on a displayed page on a producer portal to obtain configuration information for utilizing the portlet as a remote portlet. This information can be obtained by selecting the portlet with a mouse, dragging the portlet to an email window or web browser window, or through some other means such as a voice interface or touchscreen. In some embodiments, the server module 242 performs other portal display/management functions as well.
The consumer 115 includes a consumer core 275 which manages communication with the producer 125, one or more persistence adapters 288, administration tools 294, proxy portlet controls 292, a WSRP persistence layer 285, one or more pages 296 that reference the remote portlets 224 through included proxy portlets, a server module 276, and framework tables 280.
The consumer core 275 communicates with the producer core 205 using the Simple Object Access Protocol (SOAP) or another suitable protocol. In some embodiments, the consumer and producer cores use a variant of SOAP, known as SOAP With Attachments (SWA) that enables binary files to be attached to SOAP messages. In some embodiments, the producer and consumer use HyperText Transport Protocol (HTTP) compression to reduce the size of transmitted data. The consumer core 275 receives a WSDL file from the producer 125 that it uses to configure its interaction with the producer 125. While in the present embodiment a file is used, in alternate embodiments, the configuration information can be provided in a different manner.
The framework tables 280 store information about the portlets available on the producer 125 and other portlets, that is received from the service handler 210 of the producers. This information can include identifying information for the portlets, identifying information for the producer 125, capacities of the producer 125, and the types of functionality provided by the portlets. The framework table 280 also can include information about instances of proxy portlets stored on the consumer 115. When a portlet is first identified during registration/discovery a proxy portlet control 292 is created for the proxy that can be used to configure how the proxy is utilized on the consumer side.
A set of administration tools 294 enable a user or administrator of the consumer to create web pages 296 that access the remote portlets on the producer. The administrative tools insert a proxy portlet associated with a remote portlet on the producer into a created page 296 in a location that would normally refer to a portlet local to the consumer.
A server module 276 generates a user interface layer which enables a user selecting a section on one of the pages 296 to receive configuration information for utilizing a portlet on the producer 125 as a remote portlet. This information can be obtained by selecting a portlet 125 on the producer with a mouse and dragging the portlet to one of the pages 296 or through some other means such as a voice interface, touchscreen interface, or custom means. In some embodiments, the server module 276 performs other portal display/management functions as well.
A persistence layer 285 enables the admin tools and the proxy portlet controls 292 to store information about proxy portlet instances, including configuration information through their respective persistence adapters 288. This information can be retrieved, created, or modified by submitting actions to be performed on data objects to the persistence layer 285. The persistence layer receives the actions, locates the data corresponding to the objects on the framework tables 280 and retrieves and/or modifies the tables accordingly.
When a user system attempts to render a page 296 on the consumer that includes one of the remote portlets 224, the consumer transmits a GetMarkup request to the producer 125 to obtain the rendered content that should appear in the page. The request includes a handle for the portlet and capabilities of the client on the user system 105. The producer 125 utilizes one of the portlet adapters 220 to obtain the rendered content for the page from the portlet and returns the content to the consumer 115, which renders the page.
If a user system initiates an interaction with a page utilizing a remote portlet, for example by submitting a form, the consumer 115 sends to the producer the handle for the portlet, the form data storing the information stored on the form, query data indicating a requested response from the portlet, and any uploaded information. The producer 125 utilizes one of the portlet adapters 220 to submit this information to the portlet as if it had been submitted locally to the portlet. The portlet processes the request and changes its current mode/window state in response. The mode/window state indicates a state/mode for the window displaying the portlet, such as minimized, maximized, hidden, or normal.
The producer then returns to the consumer the new window state and a new navigational state for the portlet indicating a new page to be rendered on the main page on the consumer 115. When the consumer 115 subsequently requests markup, this new page, which presumably includes the response to the submitted form, is displayed inside the viewed portal page on the consumer.
In various embodiments, the producer system 125 utilizes templates for various types of Uniform Resource Locators (URLs). The templates include embedded fields for different types of information to be provided by the producer or consumer. When URLs are passed between the producer and the consumer, they may be rewritten by the consumer or producer to reflect differences in how the URLs would be accessed from either system. For example, URL designed to be utilized by the producer might not include the domain of the producer and would only include a location in a local file system. The consumer could rewrite such a URL with a global address that included the domain of the producer. Alternately, when the consumer submits a markup or other page request to the producer, it embeds blank fields into the URL for information such as markup state, window state, interaction state, and other information. The producer then rewrites the URL with this information included.
In some embodiments, page flow portlets and struts portlets can interact directly with a user system rather than working through the consumer. As mentioned above, the producer can utilize a URL writing framework based on templates. When portlets are interacting directly with a user, one set of templates is used. When portlets interact through a consumer a separate set of templates are used. For example, when a portlet is being accessed directly by a user, a template is used that does not require rewriting by the consumer.
In step 315, an administrator of the consumer aggregates pages that utilize remote portlets on the producer. This step can be performed by inserting code referencing the remote portlets into web pages. In an alternate embodiment, the consumer system is a host site that enables non-administrators to design web content and the pages are aggregated by a user of the host site.
In step 320 the completed page is presented to an end user. The consumer sends a request for markup to the producer 125, which returns the rendered content to the consumer, which then integrates the rendered content into a completed page.
In alternate embodiments, the page is stored on a functional portal. In such embodiments, the portlets 405, 410, 415, 420 provide information and other services for visiting users, while still remaining available for utilization by consumer systems. While in the present embodiment, the page is stored on the producer system 125 of
The page 400 is configured to provide information for utilizing the portlet 415 as a remote portlet by selecting the portlet with a mouse or other pointing device. In some embodiments, a user can click on a portlet 415 and either through a menu or other mechanism, receive configuration information for enabling a consumer to utilize the portlet 415 as a remote portlet.
The page 505 on the consumer system also includes one or more portlets that are utilized by users interacting with the consumer system 115. The portlets can be local portlets stored on the consumer 115 or remote portlets stored on a producer system.
A user can add remote portlets to the page 505 by selecting a portlet 415 with a mouse or other pointing device and dragging the portlet 415 to a location on the consumer page. Alternately, a keyboard, voice interface, touchscreen, or any other manner of user interface can be used. This action causes the portlet 415 to appear on the page 515 on the consumer system 115 as a remote portlet.
When this action is initiated, the server module 242 on the producer 125 passes configuration information for the portlet to the desktop 500. The information is then passed to the server module 276 on the consumer system 115, which accepts the configuration information. The configuration information preferably includes an identifier for the producer system and an identifier for the portlet. The consumer system 115 uses this information to configure itself to utilize the portlet 415 as a remote portlet and to display the portlet on the page 505, preferably at the location to which the portlet was dragged.
In alternate embodiments, this transfer can be performed by selecting the portlet on the producer page 400, selecting a transfer or copy option from a popup or pull-down menu and then selecting a location on the consumer page 505.
In step 610 a portlet is selected from the available portlets. While in the present embodiment, the portlet is selected using a mouse or other pointing device, in other embodiments, devices such as keyboards, voice-recognition systems or touchscreens can be used to select the portlet. This step entails receiving information from the producer system for configuring the portlet to be utilized as a remote portlet. This information can include an identifier for the producer displaying the portlet and an identifier for the portlet. In some embodiments the information is provided in the form of an eXtensible Markup Language file.
In step 615 a portlet or portlet representation is moved to the consumer system by moving the portlet to a browser window displaying the page on the consumer system. While in the present embodiment, the portlet is selected using a mouse or other pointing device, in other embodiments, devices such as keyboards, voice-recognition systems or touchscreens can be used to select the portlet. This step entails providing the consumer system with the information received from the producer for configuring the portlet to be utilized as a remote portlet. In some embodiments, authentication information must be provided to the consumer before this manner of information can be submitted to the consumer 115 through a drag and drop interface. As described above, the portlet information can be transmitted to the consumer 115 through alternate interface mechanisms, such as the use of popup or pull-down menus on both pages or additional means.
In step 620, the updated page on the consumer 115 is displayed. A representation of the portlet is displayed on the page on the consumer system. In one embodiment, the portlet representation is displayed at a location where it was dragged on the consumer page. In an alternate embodiment, the portlet appears at a default location.
In step 710 the producer system displays the available portlets on a page. The portlets can be arranged according to certain types of classifications, with portlets performing certain functions, or relating to certain types of data, grouped together.
In some embodiments, a user must submit authentication information before viewing the displayed portlets. In alternate embodiments, no authentication information is needed if the system viewing the page is in an authorized domain or has an authorized Internet Protocol (IP) address. In further embodiments, the page can be viewed from any system without authentication.
In step 715 a portlet selection is accepted. The portlet selection can be performed through a pointing device or some other mechanism. The selection can include dragging a portlet representation to another browser window or selecting it and then choosing an action item from a menu. In response to the selection, the producer system provides, in step 720, configuration information for the remote portlet.
In step 725 the producer serves the portlet for use by the consumer system on a consumer page. When a user attempts to view the modified page on the consumer system, the producer provides markup and interaction information for the consumer. This process is performed in the manner described in
In step 810 an interface component generated by the consumer accepts a submission of a portlet representation. This step can be initiated by dragging a representation of the portlet to the browser window displaying the consumer page, or by utilizing a menu item on the consumer after previously selecting a portlet. While in the present embodiment, the portlet is dragged using a mouse or other pointing device, in other embodiments, devices such as keyboards, voice-recognition systems or touchscreens can be used to move the portlet
In step 815 the consumer system accepts the configuration information. The configuration information preferably includes an identifier for the portlet and the producer system. In step 820 the consumer system stores a reference to the remote portlet in the selected page. This reference causes the remote portlet to be utilized when the page is next accessed. In some embodiments, the consumer system configures the page so that the portlet is displayed in the section of the page in which the representation was placed in step 810.
In step 825 the portlet is utilized in the page. When a user next views the page, a markup request is submitted to the producer system and the page, including the returned markup is displayed, as described in
Other features, aspects and objects of the invention can be obtained from a review of the figures and the claims. It is to be understood that other embodiments of the invention can be developed and fall within the spirit and scope of the invention and claims.
The foregoing description of preferred embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Obviously, many modifications and variations will be apparent to the practitioner skilled in the art. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalence.
In addition to an embodiment consisting of specifically designed integrated circuits or other electronics, the present invention may be conveniently implemented using a conventional general purpose or a specialized digital computer or microprocessor programmed according to the teachings of the present disclosure, as will be apparent to those skilled in the computer art.
Appropriate software coding can readily be prepared by skilled programmers based on the teachings of the present disclosure, as will be apparent to those skilled in the software art. The invention may also be implemented by the preparation of application specific integrated circuits or by interconnecting an appropriate network of conventional component circuits, as will be readily apparent to those skilled in the art.
The present invention includes a computer program product which is a non-transitory computer readable storage medium (media) having instructions stored thereon/in which can be used to program a computer to perform any of the processes of the present invention. The non-transitory computer readable storage medium can include, but is not limited to, any type of disk including floppy disks, optical discs, DVD, CD-ROMs, microdrive, and magneto-optical disks, ROMs, RAMs, EPROMs, EEPROMs, DRAMs, VRAMs, flash memory devices, magnetic or optical cards, nanosystems (including molecular memory ICs), or any type of media or device suitable for storing instructions and/or data.
Stored on any one of the non-transitory computer readable storage medium (media), the present invention includes software for controlling both the hardware of the general purpose/specialized computer or microprocessor, and for enabling the computer or microprocessor to interact with a human user or other mechanism utilizing the results of the present invention. Such software may include, but is not limited to, device drivers, operating systems, and user applications.
Included in the programming (software) of the general/specialized computer or microprocessor are software modules for implementing the teachings of the present invention.
| Number | Name | Date | Kind |
|---|---|---|---|
| 7370276 | Willis | May 2008 | B2 |
| 20020091836 | Moetteli | Jul 2002 | A1 |
| 20030055868 | Fletcher et al. | Mar 2003 | A1 |
| 20040003096 | Willis | Jan 2004 | A1 |
| 20040003097 | Willis et al. | Jan 2004 | A1 |
| 20040210658 | Guillermo et al. | Oct 2004 | A1 |
| 20050027869 | Johnson | Feb 2005 | A1 |
| 20050198196 | Bohn et al. | Sep 2005 | A1 |
| Number | Date | Country | |
|---|---|---|---|
| 20060085520 A1 | Apr 2006 | US |
