P. 1
prtguide60

prtguide60

|Views: 280|Likes:
Published by jorgeb1985

More info:

Published by: jorgeb1985 on Jan 18, 2011
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

11/12/2011

pdf

text

original

Sections

  • 1 Portal Runtime Technology
  • Introduction and Positioning
  • Concepts and Terminology
  • Portal Environment
  • Portal Application Archive (PAR files)
  • Portal Component Profile
  • Portal Component Config
  • Portal Runtime Mode
  • Portal Object Model (P.O.M.)
  • Application Repository
  • 2 Portal Infrastructure
  • Packaging
  • Core Applications
  • 3 Portal Runtime API
  • Component
  • IPortalComponent
  • AbstractPortalComponent
  • Service
  • IService
  • IServiceContext
  • Request/Response
  • IPortalComponentRequest
  • IPortalComponentResponse
  • 4 Portal Application Archives
  • PAR File format
  • Web Resources
  • Non-Web Resources
  • PAR Building
  • Structure of the Deployment Descriptor
  • Portal Application
  • Portal Application Configuration
  • Portal Components
  • Portal Component Configuration
  • Portal Component Profiles
  • Portal Services
  • Portal Service Configuration Properties
  • Portal Service Profiles
  • 5 Portal Application Life Cycle
  • Overview
  • Application Dependencies
  • Hot Deployment
  • 6 Portal Runtime Architecture
  • Request Dispatcher
  • Dispatcher API
  • Dispatching a Request
  • Portal Runtime API
  • Portal Runtime Core
  • Portal Registry
  • Central Configuration Storage
  • Portal Runtime Cache
  • Properties
  • Caching Expiration
  • Portal Application Repository
  • Portal Connection Framework
  • 7 Request Cycle
  • Node
  • Portal Component Mode
  • Accessing to a Mode
  • Mode Handling
  • Portal Hooks
  • Purpose
  • Adding a new Portal Hook
  • Default hooks
  • Event Handling
  • Internal Portal Runtime Events
  • Request Event API
  • Component Event API
  • 8 JNDI Support in PRT
  • PRT JNDI Support Package
  • JNDI Service Providers
  • JNDI Clients
  • JNDI Service Providers Packaging
  • JNDI Provider Resource File Sample
  • JNDI Concepts and Related Documents
  • JNDI Environment
  • JNDI Context
  • JNDI Context Factories
  • 9 WEB Services Support
  • Approach
  • Portal Services as WEB Services
  • Portal Applications and external WEB services
  • Concepts
  • Architecture
  • 10 PAR IDE
  • Additional Feature
  • 11 Compatibility Considerations
  • EP 5.0 Backward compatibility
  • EP50 Deployment Policy
  • EP50 Class Loading
  • EP50 Archives
  • List of Incompatibilities to EP 5.0
  • UNIX/Windows compatibility
  • 12 Additional PRT Services
  • Notification Service
  • Content Conversion Service
  • Content Converter Service
  • JCO Client Service
  • Service Description
  • Implementation
  • Security Open Issues
  • 13 Configuration Management in Portal Application
  • Create a Config Archive
  • Place your configuration files in folders
  • Important Points
  • Use Export PAR File of the PAR IDE
  • Config Archive properties file
  • Access data
  • Modify portalapp.xml
  • Virtual Components
  • Sharing Configuration between Applications
  • Use the Config Framework API
  • Configuration Event Subscription
  • Implement the interface IConfigEventListener
  • Add a listener
  • Remove listener
  • Start the Config Mode
  • 14 Exception Handling
  • Issue Overview
  • Coding Rules
  • Always pass the original exception
  • Always include a message
  • Always include a message
  • Do not make wrong assumptions
  • Do not have empty exception handlers
  • Do not only print the stack trace
  • Log Important Exception
  • Log important Exception
  • Adding Extra Information
  • Log Viewer
  • Exception Files
  • Exception Catalog
  • 15 Appendix
  • PAR Flow
  • Uploading a PAR File to the Application Repository
  • Deploying a PAR File on all PRT Nodes
  • Local Deployment Consistency
  • Deployment Policy
  • Deployment Hook
  • Text localization and Portal Components internationalization
  • Principle and approach
  • Resource Bundle Name
  • Locale lookup
  • Resource Bundle packaging
  • Portal Component Java Code
  • Request/Response handling
  • Permission model for Portal Components and Portal WEB Services
  • Security Zone
  • Safety level
  • Recommendations
  • Portal Object Name and Alias
  • Name
  • Alias
  • Example
  • Directory structure
  • Local Deployment Overview
  • Local Deployment of Portal Applications
  • Elements of a Portal Application
  • Class Loading in the Portal Runtime
  • Class Loading Examples
  • Deployment Descriptor example
  • Application Example
  • Central Configuration Storage – How to
  • How to get the sub context that belongs to the application?
  • How to store and retrieve config files to/from the central location?
  • SAP J2EE integration and interaction
  • Executing a Servlet as a Portal Component
  • Accessing to the Portal Service from a J2EE object
  • Portal Content Abstraction
  • JNDI Basis
  • Starting Portal Objects
  • Portal Runtime Help Mode
  • Portal Runtime Test Mode
  • Logger configuration
  • JSP Support
  • Declaring JSP as Portal Component
  • JSP selected programmatically
  • JSP packaging/Compilation
  • Class Loader consideration
  • Supported Features in the PRT
  • Portal Runtime extension
  • Tag lib packaging
  • Java Beans
  • Handling Request Events
  • Asynchronous Response API
  • Index

Portal Runtime – Release 6.

0

June, 2003

Table of Contents:
1 PORTAL RUNTIME TECHNOLOGY .........................................................................................................................6 INTRODUCTION AND POSITIONING ...........................................................................................................................................6 CONCEPTS AND TERMINOLOGY ...............................................................................................................................................7 Portal Environment ............................................................................................................................................................7 Portal Application ..............................................................................................................................................................7 Portal Application Archive (PAR files)...............................................................................................................................7 Portal Components .............................................................................................................................................................7 Portal Services....................................................................................................................................................................7 Portal Component Profile...................................................................................................................................................7 Portal Component Config...................................................................................................................................................7 Portal Runtime Mode..........................................................................................................................................................7 Portal Object Model (P.O.M.) ............................................................................................................................................7 Application Repository .......................................................................................................................................................8 2 PORTAL INFRASTRUCTURE .....................................................................................................................................9 PACKAGING .............................................................................................................................................................................9 CORE APPLICATIONS ...............................................................................................................................................................9 3 PORTAL RUNTIME API .............................................................................................................................................11 COMPONENT ..........................................................................................................................................................................11 IPortalComponent ............................................................................................................................................................11 AbstractPortalComponent ................................................................................................................................................12 SERVICE ................................................................................................................................................................................12 IService .............................................................................................................................................................................12 IServiceContext.................................................................................................................................................................12 REQUEST/RESPONSE ..............................................................................................................................................................13 IPortalComponentRequest................................................................................................................................................13 IPortalComponentResponse .............................................................................................................................................13 4 PORTAL APPLICATION ARCHIVES.......................................................................................................................14 PAR FILE FORMAT ................................................................................................................................................................14 Web Resources..................................................................................................................................................................14 Non-Web Resources..........................................................................................................................................................14 PAR BUILDING .....................................................................................................................................................................15 STRUCTURE OF THE DEPLOYMENT DESCRIPTOR....................................................................................................................16 PORTAL APPLICATION ...........................................................................................................................................................16 Portal Application Configuration.....................................................................................................................................16 PORTAL COMPONENTS ..........................................................................................................................................................18 Portal Component Configuration .....................................................................................................................................18 Portal Component Profiles ...............................................................................................................................................19 PORTAL SERVICES .................................................................................................................................................................21 Portal Service Configuration Properties ..........................................................................................................................22 Portal Service Profiles......................................................................................................................................................22 5 PORTAL APPLICATION LIFE CYCLE....................................................................................................................23 OVERVIEW ............................................................................................................................................................................23 APPLICATION DEPENDENCIES................................................................................................................................................24 HOT DEPLOYMENT ................................................................................................................................................................24 6 PORTAL RUNTIME ARCHITECTURE....................................................................................................................25 REQUEST DISPATCHER ..........................................................................................................................................................25 Dispatcher API .................................................................................................................................................................26 Dispatching a Request ......................................................................................................................................................26 PORTAL RUNTIME API ..........................................................................................................................................................27 PORTAL RUNTIME CORE........................................................................................................................................................27 PORTAL REGISTRY ................................................................................................................................................................30 Central Configuration Storage .........................................................................................................................................30

PORTAL RUNTIME CACHE .....................................................................................................................................................31 Properties .........................................................................................................................................................................31 API....................................................................................................................................................................................31 Caching Expiration...........................................................................................................................................................31 PORTAL APPLICATION REPOSITORY ......................................................................................................................................32 PORTAL CONNECTION FRAMEWORK .....................................................................................................................................32 7 REQUEST CYCLE ........................................................................................................................................................34 NODE.....................................................................................................................................................................................34 PORTAL COMPONENT MODE .................................................................................................................................................35 Accessing to a Mode .........................................................................................................................................................35 Mode Handling .................................................................................................................................................................35 PORTAL HOOKS .....................................................................................................................................................................37 Purpose.............................................................................................................................................................................37 Adding a new Portal Hook ...............................................................................................................................................38 Default hooks....................................................................................................................................................................39 EVENT HANDLING .................................................................................................................................................................40 Internal Portal Runtime Events ........................................................................................................................................40 Request Event API ............................................................................................................................................................40 Component Event API.......................................................................................................................................................41 Event Handling .................................................................................................................................................................41 8 JNDI SUPPORT IN PRT...............................................................................................................................................42 PRT JNDI SUPPORT PACKAGE..............................................................................................................................................42 JNDI Service Providers ....................................................................................................................................................42 JNDI Clients .....................................................................................................................................................................43 JNDI Service Providers Packaging ..................................................................................................................................43 JNDI Provider Resource File Sample...............................................................................................................................44 JNDI CONCEPTS AND RELATED DOCUMENTS .......................................................................................................................44 JNDI Environment............................................................................................................................................................44 JNDI Context ....................................................................................................................................................................44 JNDI Context Factories....................................................................................................................................................45 9 WEB SERVICES SUPPORT ........................................................................................................................................46 APPROACH ............................................................................................................................................................................46 Portal Services as WEB Services......................................................................................................................................46 Portal Applications and external WEB services ...............................................................................................................46 CONCEPTS .............................................................................................................................................................................47 ARCHITECTURE .....................................................................................................................................................................48 10 PAR IDE......................................................................................................................................................................53 APPROACH ............................................................................................................................................................................53 ADDITIONAL FEATURE ..........................................................................................................................................................53 11 COMPATIBILITY CONSIDERATIONS................................................................................................................56 EP 5.0 BACKWARD COMPATIBILITY ......................................................................................................................................56 EP50 Deployment Policy..................................................................................................................................................56 EP50 Class Loading .........................................................................................................................................................56 EP50 Archives ..................................................................................................................................................................56 LIST OF INCOMPATIBILITIES TO EP 5.0 ..................................................................................................................................57 UNIX/WINDOWS COMPATIBILITY .........................................................................................................................................57 12 ADDITIONAL PRT SERVICES ..............................................................................................................................58 NOTIFICATION SERVICE.........................................................................................................................................................58 CONTENT CONVERSION SERVICE ..........................................................................................................................................59 CONTENT CONVERTER SERVICE ............................................................................................................................................60 JCO CLIENT SERVICE ............................................................................................................................................................61 RFC ENGINE SERVICE (UNDER CONSTRUCTION) ..................................................................................................................63 Service Description...........................................................................................................................................................63 Implementation .................................................................................................................................................................64

................................................................................................................................................................................................................79 TEXT LOCALIZATION AND PORTAL COMPONENTS INTERNATIONALIZATION ...................................................................86 Alias..............66 Important Points ..................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................64 13 CONFIGURATION MANAGEMENT IN PORTAL APPLICATION..........................75 Log Viewer....................................................................................................72 14 EXCEPTION HANDLING..................................................................................................................................................................................................81 Resource Bundle packaging ..................73 Always pass the original exception..........80 API..............................................................Security Open Issues.........77 Deploying a PAR File on all PRT Nodes..........................................................................................................84 Implementation ...........................................................80 Resource Bundle Name.................82 Request/Response handling ...................................................................................................................68 Sharing Configuration between Applications ...................................................................................................................................................74 Do not only print the stack trace .........................................70 Implement the interface IConfigEventListener ..........................................................................................72 START THE CONFIG MODE....................................................................81 Portal Component Java Code................................................................................................................................................................................................................................................................................................................................80 Locale lookup ............................................................77 PAR FLOW ............................86 Name...................................................................................................................74 ADDING EXTRA INFORMATION .................80 Principle and approach .............................................................................................................................................................................................68 Virtual Components ...............................................65 CREATE A CONFIG ARCHIVE .................................................................................................................................................................................................................................................................................74 Log Important Exception .....................................66 Place your configuration files in folders ......................................................73 ISSUE OVERVIEW..................................................................................................76 15 APPENDIX..................................................................................................................................................................................................................................................................................................................................75 Exception Catalog ..................................................................................................................................................................................................................................84 Recommendations..........................................................................88 Local Deployment Overview.....86 Example ............................................................................................75 Exception Files .....................................................................................................................................................................................................77 Uploading a PAR File to the Application Repository............................................................................................................................................................88 ...........................................................................................73 Do not have empty exception handlers .................................................................................xml .......77 Deployment Policy...............................83 Safety level...................................................................73 CODING RULES ...........................................................................................................................................................................................................69 USE THE CONFIG FRAMEWORK API ..................................................67 ACCESS DATA ...............................................................................................................................................................................................................................................................................................................................................................................................................87 DIRECTORY STRUCTURE ................................................................................................................68 Modify portalapp......................................................................................................................................................................................................................................................78 DEPLOYMENT HOOK ................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................70 Add a listener..............................................................................................72 Remove listener....................................................................................................................................................................................................................................................77 Local Deployment Consistency................................................83 Security Zone .............................66 Use Export PAR File of the PAR IDE...................................................66 Config Archive properties file...................................................................................................................................................69 CONFIGURATION EVENT SUBSCRIPTION ..................................................................................................................................................................82 PERMISSION MODEL FOR PORTAL COMPONENTS AND PORTAL WEB SERVICES .............................................................................................................................................................................................................................................85 PORTAL OBJECT NAME AND ALIAS ...............................................................................................................73 Always include a message .................................................................................................................................................................................................................................73 Do not make wrong assumptions ......................................................................................................................................................................................................................................................................................................................................................................................................................82 JSP Support ...............................................................................................................................

..........................................................................................97 JNDI Basis....................................................................................................109 INDEX ...................................................................................90 Class Loading Examples.........................................................................................................................................................93 CENTRAL CONFIGURATION STORAGE – HOW TO....................................................................112 .........................................................................................................................................................................................................................................................................................................................................................101 JSP SUPPORT...........................102 JSP packaging/Compilation .....................................................................................................................................................96 PORTAL CONTENT ABSTRACTION ..................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................97 PORTAL RUNTIME HELP MODE ..............................................................................94 How to get the sub context that belongs to the application? ...........102 Declaring JSP as Portal Component...............................................................................................................................................107 Handling Request Events...................................................................................................................103 Supported Features in the PRT..............................................................................................................................................................................98 PORTAL RUNTIME TEST MODE ...................................................88 ELEMENTS OF A PORTAL APPLICATION ................................................96 Accessing to the Portal Service from a J2EE object...97 JNDI Service Providers ..........................................................................................................................Local Deployment of Portal Applications...94 SAP J2EE INTEGRATION AND INTERACTION ...........................................................................94 How to store and retrieve config files to/from the central location? ......................................................................................................96 Executing a Servlet as a Portal Component...........................................................................102 JSP selected programmatically ......108 ASYNCHRONOUS RESPONSE API..............................................................................................................................89 CLASS LOADING IN THE PORTAL RUNTIME .............................................................................................................................................................................................................................................................................................................................................................106 Java Beans..................................................................................................................................105 Tag lib packaging .....................................................................................................................................................................................103 Portal Runtime extension..............................................................................100 LOGGER CONFIGURATION ...........................................................................................................................................................................................................................................................................................................................97 Starting Portal Objects ....................................................................103 Class Loader consideration...................................................................................................................... .......................90 DEPLOYMENT DESCRIPTOR EXAMPLE ....................................................................................................................................................................................................................................92 Application Example.

The Portal Runtime Technology provides a Java based framework to define. They are: • Portal Components. The Portal Runtime defines and manages two kinds of objects that define a Portal Application. So. So the model proposed by the PRT can be extended to support. From a user point of view. a plug able component designed to be executed into a Portal environment. Portal Services. The motivation behind the design and the technical implementation of the Portal Runtime are the following: • • Area of concern: The goal of the PRT is very well identified and restricts itself to the life cycle of portal applications. different user interface models or different programming models. The portal runtime development model offers a way to implement a clear separation between a Service API and its implementation. for example. the Portal Runtime clearly positions itself as one of the key block used to build and execute any kind of Portal. build. xml. and execute Applications in a Portal Environment by allowing the aggregation and the display of various contents such as rich text. • Portal Runtime Technology Page 6 /113 . A Component offering a globally accessible function in the Portal. Open and Extensible: Many of the components of the PRT can be changed or customized to be adapted to the environment in which the PRT is executed. a component that can be displayed into a portal page. videos etc… The Portal Runtime Technology provides a runtime and its corresponding services as well as a development environment for Portal applications. From an application development perspective.1 Portal Runtime Technology Introduction and Positioning The Portal Runtime is one basic part of the SAP Enterprise Portal Environment integrated in the SAP J2EE environment.

It can also be a JSP. instantiated.Concepts and Terminology Portal Environment From the PRT perspective.O. The POM is only valid during one request. Portal Component Profile The component profile is a set of properties (name-value pairs) representing the dynamic part of a Portal Component that could be customized to change the behavior of a Portal Application. The Portal Runtime offers tools to facilitate the construction of Portal Applications. a Portal environment is a Web site that serves as a starting point to information. Portal Runtime Mode Portal Runtime Mode allows a Portal component to display a different user interface according to the specified mode. The state is not kept on the server side. services and applications on the Internet or the Intranet. It is a hierarchical representation of the components participating in the processing of a request and in the construction of a response. Portal Runtime Technology Page 7 /113 . It can be described as a Java Code defined by properties and executed in a particular mode. It is the underlying structure of all server-side eventing and it serves as a logical representation of the Portal structure for addressing the request events.) The Portal Object Model is a runtime representation of the portal structure at request time. Portal Application Archive (PAR files) A PAR file is an archive file containing a Portal Application. A PAR file contains the Portal Application Deployment Descriptor (portalapp.xml). Portal Component Config The component config is a set of properties which configures the Portal Component (class name etc…). Portal Services It is a service offering functionality to other applications of the portal. Portal Application The Portal Runtime technology defines an environment in which Portal Application are deployed. This file describes the portal application itself and provides information required at runtime. accessed and finally released. Portal Components This is an executable part of the Portal Application.M. Portal Object Model (P.

In its most basis form.Application Repository The Application repository is the persistence layer of the Portal Runtime. it offers a JNDI access to Portal Applications. It also takes into account the application distribution in a cluster installation. It contains every object persisted by the Portal. Portal Runtime Technology Page 8 /113 .

The main motivation behind the design of the Portal infrastructure is to isolate Portal Application from the environment. or because an element of the application is requested to be executed. the Portal Runtime infrastructure delivers a SAP J2EE service containing all the PRT functionalities and services relying on specific SAP J2EE implementation called PRT bridge as shown in the figure below. called core applications are ensured to be loaded before any other applications when the Portal is initialized. Portal Runtime Technology Page 9 /113 . The Portal Runtime and its configuration. Concerning the application storage. Packaging The Portal Runtime relies on the J2EE architecture implemented by the SAP J2EE Application Server. SAP J2EE Application Server SAP J2EE Services PRT Bridge Service Core Applications Servlet Container Portal Runtime Other servlets Applications Core Applications The Portal Infrastructure relies on a predefined set of applications to provide core functionalities in the Portal infrastructure. In addition to the IRJ file. The core services of the Portal Runtime. either because the application has been marked as “load on startup”.2 Portal Infrastructure This chapter describes the Portal Runtime Infrastructure. Applications. Additional Portal Applications. a regular application is started only when required. This set of applications. The IRJ file contains 3 main parts: • • • Libraries and configuration files. On the contrary. non-core applications are always loaded in the Application Repository. Those applications are also never loaded in the Application repository. As a result the Portal Runtime is packaged in an EAR file called IRJ (iView Runtime for Java). Core applications.

The runtime console giving access to administrative tools of the Portal Infrastructure the The notification service relies on the PRT Bridge to send and receive from one PRT to another Security functionalities to authenticate a user in the Portal.sap.system.portal.sap.sap.repository com.system.console com.authentication usermanagement Description The application repository itself. Portal Runtime Technology Page 10 /113 . User management implementation service.runtime.runtime.sap.portal.runtime.runtime.notification com.The table below shows the list of the main Portal Runtime core applications.portal.portal. Application name com.system.system.

The following table describes the main elements of the API. • Portal Runtime Technology Page 11 /113 . A set of properties attached to a Component or a Service. The configuration of a component or a service (static immutable). A view of the context in which the Portal Runtime runs Components and Services. API ELEMENTS Portal Component JAVA NAME IPortalComponent AbstractPortalComponent IPortalComponentInit Portal Service Profile Configuration IService IPortalComponentProfile IServiceProfile IPortalComponentConfig IServiceConfig Request Response IPortalComponentRequest IPortalComponentResponse DESCRIPTION The IPortalComponent is the central abstraction of the Portal Runtime API. The Portal always initializes one instance of the Portal Component and this instance is shared among different users and sessions. Portal Event IPortalRequestEvent IPortalComponentEvent Context IPortalComponentContext IServiceContext Component IPortalComponent This is the central abstraction of the Portal Component API. The complete API documentation can be found in the Portal Runtime javadoc. components. It defines a Portal Component included in a Portal Application A Portal Service included in a Portal Application. All Portal Components implement this interface either directly or by extending the AbstractPortalComponent helper class. Encapsulation of information sent to the client by a Portal Component. It contains Java interfaces that define the contract between the Portal objects (Applications. Service() The service() method is called when the Portal Component is asked to process the client’s request. The Component’s view on the request during Runtime. services) and the Runtime environment.3 Portal Runtime API The central piece of the Portal Runtime technology is the Portal Runtime API. The objective of this chapter is to describe the main important interfaces of the API. This is the API to receive and send events with the client’s request or between different components. The Portal Runtime calls the following methods during the Portal Component’s life cycle • Init() The Portal Component is created and loaded in the execution environment and then initialized with the init().

2. The Portal Runtime is responsible for the creation. getProfile() The getProfile() method returns a IServiceProfile instance representing the Profile of the Service. getConfiguration() The getConfiguration method provides a read-only access to the IServiceConfig of the Service. the Portal Runtime calls the following methods: • init(IServiceContext) The init method is called when the Portal Service is loaded in memory. to dispatch and handle portal events. The destroy() method is called when the Service is stopped and discarded • • IServiceContext The IServiceContext gives to the Portal Service a view on the Portal Environment in which it is executed. It also gains information about the application it belongs to. to handle the Portal Modes defined by the Portal Runtime like the Edit. Portal Runtime Technology Page 12 /113 . load and destroy of Objects implementing this interface. Service IService Every objects that want to act as a Portal Service must implement the IService interface. as well as request events. The profile can be customized by the administrator. The Portal Runtime calls then the following method • init(IPortalComponentInitContext) The Portal Component has an access to its configuration defined in the portalapp. The garbage collector then collects the Portal Component. the doEdit() method is bound to the Edit Mode. this service is then also loaded and initialized by calling its init() method. AbstractPortalComponent The AbstractPortalComponent provides default behavior for Portal Components. Help and About mode. Returns the ILogger implementation to log information. afterInit() The afterInit() method is called when the init method returns. In the same way. For example accessing a Portal Component in the default mode will invoke the doContent() method of the AbstractPortalComponent. destroy() from memory. During the life cycle of a Portal Service. In a situation where several init() methods are invoked.• Destroy() The Portal Runtime calls the destroy() method when the Portal Component is discarded from memory either because the Portal is terminating or because the Portal Runtime needs to free up some memory or during the release of its corresponding application when uploading a new one for example. the Portal Runtime ensures that the afterInit() method is called when all the init() methods are ended. The logic included in this class implements the default behavior 1. the Portal Runtime will never make the assumption that a Portal Component needs to be a subclass of the AbstractPortalComponent class. When a Portal Service is referencing another Service. The Abstract Portal Component implements also a interface called IPortalComponentInit to be notified of its initialization. It is recommended to inherit from this class when developing a Portal Component. The PortalServiceContext provides access to the Resources. However.xml file. This allows a Portal Service to be notified when the initialization chain is over. • • • • getResource() getLogger() Returns a IResource object representing a resource.

IPortalComponentSession. IRessource. HttpServletRequest. HttpServletResponse. the IPortalComponentRequest interface acts as a factory for URLs that the component would have to generate (create component URI.Request/Response IPortalComponentRequest This IPortalComponentRequest is passed to the PortalComponent thought the service() method or the doContent() method. The following operations are provided through the response: • • • addCookies() write() include() add a cookie in the response. Portal Runtime Technology Page 13 /113 . But it is still permitted for very specific actions. A ILogger implementation to write information to the logs of the Portal. IPortalComponentProfile. Write a string in a response Include the content of another Portal Component into the response or a resource. ILogger. returned to the client from the Portal Component. IPortalComponentContext. IUserContext. Locale. request events…). IPortalComponentResponse The IPortalComponentResponse is given to the Portal Component through the service() method or the through the specific mode handler methods. • • • • • The context in which the current Portal Component is executed A representation of an external resource. In addition. Objects offering user’s information. It contains request specific data and it provides access to the environment in which the Portal Component is running. Those objects are the original servlet objects. In general accessing those objects is not recommended. The profile of the component. The underlying default implementation of the request is thread safe. It encapsulates all the information. The following Objects are accessible through the request: • ServletConfig.

Resources of a Portal Application fall into the following two categories: Web Resources These are all file-based resources that are supposed to be accessible via http(s) requests to a web server that provides access to the Portal. This folder contains all class files and other files that define JAVA classes and other class loader relevant resources (e.g. PORTAL-INF/classes PORTALINF/private/lib PORTALINF/private/classes File PORTALINF/portalapp. ResourceBundles). It is described more precisely below. ResourceBundles) that can be shared by referencing Portal Applications. that are used exclusively by the application.g. This folder contains all class files and other files that define JAVA classes and other class loader relevant resources (e. A PAR file contains all the file-based resources that make up a Portal Application. The deployment descriptor describes all Application Entities of the application as far as the runtime is concerned. ResourceBundles). In a PAR file. ResourceBundles) are used exclusively by the application. that can be shared by referencing Portal Applications.g.mf Portal Runtime Technology Page 14 /113 .xml METAINF/manifest. Meaning The XML file containing the Deployment Descriptor of the Portal Application. The manifest file of the Portal Archive.g. It contains versioning and origin information. Within the non-web resources a few folders and files have a special meaning: Folder PORTAL-INF/lib meaning This folder contains all the library files (JAR) that contain definitions of JAVA classes and other class loader relevant resources (e. Non-Web Resources All files that are under the PORTAL-INF folder of the PAR file are not accessible via an http(s) request to the portal. all files that are NOT under PORTAL-INF fall into this category.4 Portal Application Archives PAR File format This chapter describes the Portal Application archive format and how the format is used and interpreted by the runtime. This folder contains all library files (JAR) that contain definitions of JAVA classes and other class loader relevant resources (e.

• A SAP Java IDE plugin called PAR Open Tool.MF +-.classes Non-WEB resources API: jar files only API: classes only CORE: jar files only CORE: classes only PAR Building The Portal Runtime offers two facilities to build a PAR file.classes | | +-.META-INF +-. Read a PAR file and create a project.portalapp. Portal Runtime Technology Page 15 /113 .. 2.PORTAL-INF | | | +-.lib +-.MANIFEST.The following picture shows an example of a typical PAR file structure: <Portal Archive> | +-. | +-.lib | +-. • An Ant task accessible from the SAP Java IDE or from the Ant command prompt. This tool allows to 1..scripts +-.images +-.xml | | | +-. Write a PAR file from a project..private +-.

.. For example <property name="myProperty" value="myPropertyValue"/> The following table describes currently meaningful application configuration properties: Name SharingReference Description This property allows references to other Portal Applications whose API definitions are to be used in this application's API definition. Admissible value comma-separated list of other Portal Application's names or aliases thereof. </components> </application> see Application Configuration Properties see Portal Components see Portal Services Portal Application Configuration The application-config element may contain as many number of property elements as you like.. </services> <components> .. The first thing to know is that the name of the application is the name of the PAR-file. Portal Application Within the application element the following child elements are allowed: Application-config Components Services Example: <?xml version="1. Note: The concept of aliases is meant to be used for backward compatibility reasons. The application element may have an attribute alias. the name of the containing PAR file.name"> <application-config> .0" encoding="iso-8859-1"?># <application alias="com. It effectively reserves a name some other application potentially would like to use.. These aliases can be used alternatively to the real application name. Portal Runtime Technology Page 16 /113 .a. See also Class Loading in the Portal Runtime. So use it with care. A property element declares a property by name and value. containing a comma-separated list of aliases on the portal application. when referencing the application (see Application Configuration Properties) and Portal Components (see Portal Components).Structure of the Deployment Descriptor The deployment descriptor (portalapp. The root element is the application element.abc. Default n. The properties specified in this section of the deployment descriptor affect the Portal Application as a whole.xml) is noted as an XML definition.my.other. </application-config> <services> ..

DeploymentPolicy This property affects how the Portal Application's resources are treated during local deployment. Default n. Amissable Values A comma-separated list of application local paths (e. ServicesReference see above see above Portal Runtime Technology Page 17 /113 .0 behavior. In general see also Compatibility Considerations. If set to "true". "false" True The following properties are mainly kept for backward compatibility with 5.0" or <empty> n. See also Class Loading in the Portal Runtime.0. "coreAccessInAPI".a. ClassLoadingPolicy "transitive" startup "true". "transitive" n. Comma-separated combination of "5.0". PORTALINF/mystuff).a. The values of this property affects the way class loader resources are exposed by this application to other applications and more. See also Compatibility Considerations This property is equivalent SharingReference property.a. See also Class Loading in the Portal Runtime. See also Compatibility Considerations. it is possible to specify a number of folders in the PAR that are to be preserved during local deployment.PrivateSharingReference This property allows references to other Portal Applications whose API definitions are to be used in this application's (nonpublic) implementation. They should then set this property to false. the application as a whole will be "started" (initialized) on startup of the server.g. comma-separated list of other Portal Application's names or aliases thereof. all applications are releasable and the application instance can be dropped at any time by the system. Nevertheless some critical applications may want to avoid the release of their instance when the system runs low in memory. In particular. See also Compatibility Considerations. to the "5. Name PreservedConfigPaths Description Depending on the deployment policy (see above). "false" False releasable "true". Because PRT allows hot deployment. this property is also used for backward compatibility since it can be used to enforce the 5. In particular this means that it will be locally deployed.

<none> Portal Runtime Technology Page 18 /113 . An absolute Portal Component Name is constructed as <application name>. Mandatory No No Default n. </components> . Mandatory yes Each component section may contain one component-config element and one component-profile element. "jspnative". The type of the component.a. Each property is declared as described in Application Configuration Properties.sapportals.component. </component-config> <component-profile> .IPortalComponentConfig.portal. For example: . The following XML attributes apply to the component section: Name Name Description The portal component name within the application. in which case an implementation of IPortalComponent has to be specified by the ClassName property.prt. This attribute specifies the <portal component name>. </component-profile> </component> .....Portal Components All Portal Components of a Portal Application are declared in component sections contained in the components section. Portal Component Configuration The component-config section within a component section of the deployment descriptor contains properties that enable the use of a Portal Component with the Portal Runtime... Admissible values are: "servlet"... <none>.. Default is <none>. The main properties the developer must be aware of are the following: Name ClassName ComponentType Description The name of the implementation class of the Portal Component.<portal component name>. The properties specified in this section are accessible to Portal Components via the interface com.. <components> <component name="myComponent"> <component-config> .

none: also anonymous users Role list : only the roles that are in the list SecurityZone String representing the security zone. The 6.IPortalComponentProfile interface at runtime. the component belongs to. This Property is only supported for backward compatibility reason.prt. the iView.JSP In the case of ComponentType=="jspnative". Some properties are PRT specific: Name ConfigRootFolder Description String representing the path within the overall configuration structure of the component specific configuration. ResourceBundleName no "localization" AuthRequirement no user: authenticated user admin: administrator only. See Permission Model for components for more details. See text localization for more details Initial minimal authentication requirements to execute the Portal Component.mycomponent Default Portal Runtime Technology Page 19 /113 . User: The content is private for each user Possible values /com. This bundle will be used to look for descriptive texts in generic personalization dialogs.sapportals. See Configuration management for Portal Application for more details. CachingLevel Shared : The cache content is shared among all users. The values of properties in this section define the default values. The profile is usually abstracted in a personalizable entity.myapplication.sap.0 version relies on the security zone concept to control access to the Portal Components.portal. By administrative modification or personalization. no Portal Component Profiles The component-profile section contains properties that make up the profile of the Portal Component as accessible from the com. no n. these values may be modified.component. the path of the JSP PageLet to implement the Portal Component. This path is relative to the private resources (under PORTAL-INF in PAR) of the Portal Application A Portal Component can specify the name of a distinguished resource bundle.a.

Default n. Attributes of profile properties are denoted by sub-properties.blue]"/> </property> 2 In this example the property “Color” has two sub properties. The second one “type” defines the relevant value for this property.a. The property attributes are basically used at design time (by administration tools) or during personalization. the property name. If two or more embedded iViews with different EPCFLevel values meet on one page (within the same frame).green. For example: <property name="Color" value="red"> <property name="personalization" value="dialog"/> <property name="type" value="select[red. Portal Runtime Technology Page 20 /113 . 2: This level includes all EPCF features that use pure JavaScript 3: This level includes all features of level 1 and additional features that use applets. This level is used to cache information related to the browser's sessions ValidityPeriod EPCFLevel Defines whether to use the Enterprise Portal Client Framework or not. the first one “personalization” defines that the property will be in the form during personalization. The following table describes the property attributes that the developer should be aware of: Name description Description A text token that can be resolved by accessing the component's resource bundle.a. A plain text that can be used in user interfaces to describe the property. whether or not a user is connected. It represents a locale sensitive descriptive text for the property that can be used in user interfaces.Session: The content of the component is cached all the time the (servlet) session is running.a. Time period in milliseconds 1: This component does not use the EPCF at all. This will be used if no description attribute is specified. plainDescription n. the effective level is computed as the maximum of all EPCFLevel values on this page. Additional attributes describe how to handle the properties with respect to personalization and meta-data handling. Admissible value n. Therefore neither script nor applets will be included. The portal runtime does not make any assumption concerning the semantic of those sub-properties. Each property in this section may have further attributes.

. select[<option>(.. This attribute specifies the <portal service name>. a name that can be used instead of the fully qualified service name (see above) when looking up the Portal Service.<option>)*]. A fully qualified Portal Service Name is constructed as <application name>. not shown in personalization dialog: per-user storage and shown in personalization. <none> personalization dialog inheritance specifies whether the property can be overridden by a template derivation (e.. </service-config> <service-profile> .g.. final.. </services> Portal Runtime Technology Page 21 /113 .. <none> none: cross-user storage..<portal service name>. iView chain). </service-profile> </service> . For example . The following XML attributes apply to the service section: Name name Description The service name within the application. <services> <service name="myService"> <service-config> .. boolean. This attribute specifies how to treat this property with respect to personalization.type A "visual" type of the property to be respected as a hint by user interfaces. not shown in personalization no-dialog: per-user storage. Mandatory yes alias no Each component section may contain one service-config element and one service-profile element. non-final non-final Portal Services Portal Services are declared in service elements inside the services element.

IServiceConfig. Portal Runtime Technology Page 22 /113 . Mandatory Yes Default n.sapportals. If not. This class must implement the IService interface. If set to "true".Portal Service Configuration Properties The service-config section within a service section of the deployment descriptor contains properties that enable the use of a Portal Service with the Portal Runtime. the properties of the service profile may be modified by administrative environments and is available at next start of the service.service. the service will be started on demand.a. The properties specified in this section are accessible to a Portal Service via the interface com. In contrast to the service config. There are no predefined service profile properties.service.prt.sapportals. startup No false Portal Service Profiles The service-profile section contains properties that make up the profile of the Portal Service as accessible from the com.IServiceProfile interface at runtime. the service will be started at startup of the runtime.portal.prt.portal. Properties of reserved meaning are: Name className Description The name of the implementation class of the Portal Service.

In that sense the local deployment is a cached copy of the original version.5 Portal Application Life Cycle This section describes the application life cycle and explains how and when information contained in the PAR file is used to deploy Portal Applications and then to load the corresponding objects in memory. Overview DataBase server PAR Upload Application Repository / Database Web servers Local Deployment / File system HTTP Request Application Broker Object Instances Portal Runtime Technology Page 23 /113 . The Administrator will typically use admin tools to create the portal content. the local version should not be modified directly. First of all. There is only one Application Repository and all PRT nodes of the SAP J2EE cluster are sharing the same content. some of them (like the Archive Uploader” are used to upload portal applications into the application repository. it is important to understand that PAR files are stored in the application repository. Portal applications are also deployed locally (on each PRT node). The main purpose of the local deployment is to improve performance by providing fast access to resources and avoid too many accesses to the application repository.

Reload the application and the dependents that have been released. This step guarantees that the class loader of application it depends on is ready to use. the PAR Upload will notify all PRT nodes that a new version of the application is available. This space is divided into a public part corresponding to the API of the application and a private part corresponding to the core implementation. PRT tries to get it from the local deployment. Release this application and all elements (components. Restart load-on-startup services For further detail concerning the PAR Flow please check page 77. All applications it depends on are deployed and loaded first. Application Dependencies When loading the application. Each portal application is loaded in its own memory space (cf.: Class Loaders). The system can also discard Portal Application instances when the Java VM requires freeing some memory. Note: Application can be marked as non-releasable in their deployment descriptor. The deployment process gets the PAR File from the repository and deploys it on the file system.When a component or a service of a Portal Application is accessed for the first time (For instance upon an HTTP request) the Portal Runtime has to load the implementation class and instantiate the corresponding object. Afterwards. PRT checks the dependencies that are declared in the deployment descriptor thanks to the “SharingReference” and “PrivateSharingReference” properties. Portal Runtime Technology Page 24 /113 . services. Update the local deployment (like describe in step 3). If the object is not yet available. When a new version is available. the broker loads the class and instantiates the object. If a new version is available in the repository then step 3 is performed. This step checks the “revision number” of the application to make sure the local deployment is up-to-date. the local deployment is updated. and applications) depending on it. Hot Deployment In a cluster scenario (n PRT nodes sharing one repository). the application will be release in any case. The content of the PAR File is split into 2 parts. Upon the notification. each PRT node will perform the following operations: • • • • • Check if the application is already loaded and running. This flag has no impact during Hot Deployment. Internally the portal application broker checks whether the object is already available and returns it. The “non-releasable” property guarantees that PRT will keep the application instance even when the VM runs low in memory. For further details about the directory structure please check: Directory Structure page 88 The Portal Application runs and remains in memory unless a new version is deployed or the administrator decides to release the application.

contactinfo Description If this situation persists. True Servlet WEB-INF/portal system/properties/prtDefault. However the Portal Runtime must have a least the default servlet connection called portal installed and started to work properly.servlet.system.portal.prefix dispatcher. systemdefault. it is implemented as a Servlet running in the WEB Server environment.properties dispatcher.servlet.portal. The figure bellow shows the main blocks of the Portal Runtime Architecture Request Dispatcher Portal Connection Portal Registry Portal Component API Cache Portal Application Portal Runtime core Portal Service API Portal Application Repository Request Dispatcher This is the entry point of the Portal Runtime. please contact your system administrator.root dispatcher. The first role of the request dispatcher is to match the URL of the request to a Portal connection and forwards the request to this Portal Connection.6 Portal Runtime Architecture The objective of this chapter is to describe the architecture of the Portal Runtime by focusing on its configuration and customization. The reason of the exception is always displayed before or in the source code of the HTML page.propert ies system/properties/workplace.allow dispatcher.properties Property dispatcher. The Dispatcher can handle all the connections needed.portal. In the SAP J2EE environment. The Request Dispatcher reads the following configuration files from the file installation: WEB-INF/conf/dispatcher. At startup the role of the request dispatcher is to cover the following functionalities: • Initializing the Portal Runtime Environment. dispatcher.proper Portal Runtime Technology Page 25 /113 .properties This defines whether an automatic forward to another servlet is allowed This defines the pathinfo prefix to be used defines the portal root directory defines the portal default properties the portal properties Default value Default information message displayed when a dispatcher exception occurs.

the dispatcher analyses the incoming URL and find the corresponding connection in order to forward the message. javax.properties file: Description The directory below WEBINF/portal containing the public library of the Portal Runtime Same for the public classes The directory below WEBINF/portal containing the nonpublic library of the Portal Runtime Same for the non-public classes Prefixes for class names that will not be seen from the dispatcher and below Same for resources Default value lib Property Name portal. Portal Runtime Technology Page 26 /113 . Those libraries are packaged into the WEB-INF/lib directory.sun.resources Dispatcher API The dispatcher contains a set of API that could be accessed from an external Servlet to communicate with the dispatcher. META-INF portal.version The default connection console mode for the dispatcher Automatically generated version information ties portal Verbose • Setup the class loader hierarchy. javax.activation localization. The different levels of libraries are read from the file installation and the corresponding class loaders are created in memory.jar prtutil.jar prtjndisupport..defaultconnection dispatcher.classes system/classes com..classes system/lib classes system/lib system/classes portal.dispatcher. The name is used as the key to perform a lookup in the connection bound of the Portal Registry.libs portal. This phase can also be customized with the following parameters of the prtDefault.jar Description The code of the dispatcher itself JDNI support in PRT. API of the Portal Registry Utility classes of the Portal Runtime.xml.jar prtregistry.mail.console dispatcher.mail.protected. Library name prtdispatcher.sun.. The name of the connection is passed in the URL as follow: /irj/servlet/prt/<Connection Name>.com.log.portal.protected. Dispatching a Request When a request comes in.

jar prtconnection. File name prtDefault. Default logger implementation.jar Description The Portal Application API.jar Description The Portal Runtime core.jar prtdeployment.jar prtdeploymentapi. It also manages the Portal Application life cycle and isolates Portal Application between them by implementing the class loader separation. JSP support in Portal Runtime. Internal Portal Runtime file. Portal Runtime Testing Framework API.properties prtCentral. The Portal Runtime API is delivered in a set of 5 JAR files. When this operation finishes successfully. Concurrent thread access.jar concurrency.bak extension. This is the API to build Portal Components and Portal Services. Helper class implementation to handle the format of PAR Files and the deployment descriptor Utility classes of the Portal Runtime. used to manage upgrade of the version of the Runtime.properties Portal Runtime Technology Page 27 /113 .jar prtgluer. During its first startup.jar prtlogger.jar prttest. prtUpdate. This file contains Properties that are going to be stored in the Portal Registry. prtDelete. API to handle the format of PAR Files and the deployment descriptor. the Portal Runtime reads this file and stores the corresponding objects into the registry. JAR name prtcore.properties.jar prt_jspapi. Portal Runtime Core The Portal Runtime Core offers one implementation of the API. Changing the two following files located in the WEB-INF/portal/system/properties can customize some of the functionality of the Portal Runtime Core.Portal Runtime API It defines the contract between the Portal Application and the Portal Runtime. The Portal Connection API to develop and install a new connection in the Portal. The Core implementation is delivered in a set of JAR files described in the table below and packaged by default in the WEB-INF/portal/lib directory. JAR name prtapi.properties Description Default value for the properties of the PRT. the file is renamed with a . but also the API to cooperate with the infrastructure to extend it and customize it.

encoding async. Name runtime.doubleByteSupport Description Indicates if the Runtime will support double byte encoding in the request and the response The type of encoding to use when double byte support is activated in the PRT The pool size asynchronous mechanism for the response Default Value true runtime.response. If set to development prtroot access is allowed for every component.component.mode -1 production Portal Runtime Technology Page 28 /113 . Timeout for the components participating in the construction of the asynchronous response.default loadlimit.The following table gives a list of the most important properties that can be changed to customize the Portal Runtime behavior.permission.timeout 10000 request.size UTF-8 100 async.response. The default Portal Component to start when none is specified.requests portal. the access to the security zone is tested. If set to test prtroot access is allowed for every component that doesn’t belong to a specified zone.pool.off connection. This is the default language to be used when none is specified Same for the country.timeout. If sets to true. See Security Zone in PRT.defaultDelegate caching.off Monitor.defaultcountry personalization.doubleByteSupport. In that. 100 default.runtime. If set to production prtroot access is not allowed unless the component belongs to a security zone.pool.addclasspath En us StandardEditDialog false True PortalAnywhere. Classpath element to add when compiling a JSP in the Portal Runtime Number of maximum concurrent requests managed by the PRT.defaultcomponent jsp. monitoring is switched off.defaultlanguage request. Default delegate for the personalization of a component If the PRT cache must be turned off by default.size The thread pool size to manage the timeout when using the asynchronous response mechanism.

Portal Runtime Technology Page 29 /113 .

The component hooks list. The connections known by the Portal Runtime. In particular.listeners runtime/hooks/mode runtime/connections runtime/prt. The document hooks list. In general. The list of request event listeners The list of mode hooks. A sub context dedicated to the application exists by default.naming. This feature can be used by any portal application to store additional configuration files or resources that are to be shared by all PRT nodes on the cluster. and lookup objects. The Portal Registry is a singleton offering methods to create sub-contexts. The modes known and handled by the PRT.modes Central Configuration Storage The Portal Registry also provides access to a JNDI context which can be used to read/write any kind of data to the repository. The Portal Runtime is using a set of pre-defined contexts to store objects that are invoked at certain point of time during the Portal execution. Registry Sub-Context runtime/hooks/node runtime/hooks/component runtime/hooks/document runtime/hooks/response runtime/hooks/deployment Description The list of node hooks. The Central Configuration context relies on the JNDI API plus the IStreamSource interface.. Components and services can access to the context of the application the belongs to by calling the lookup method on the root context. bind. import javax. Context applicationContext = context. Portal Runtime Technology Page 30 /113 . the Portal Registry is used for two purposes: • • A global place for an application to store and retrieve objects. runtime/hooks/event runtime/hooks/event/request.Context.. Contains all the response hooks known by the runtime. in which the Portal Runtime will look for objects to customize its execution. For further information concerning this topic please check: Central Config Storage – How to page 94. The Portal Registry is implemented as a hierarchical JNDI context allowing to bind any kind of object. The context in which deployment hooks bind themselves in order to be notified when a Portal Application is deployed in the Portal.getCentralConfigurationContext(). The list of event hooks installed in the runtime. this includes the running services and the Portal Configuration.Portal Registry The Portal Registry is the entry point for inspection of almost all Portal runtime information. Context context = PortalRegistry. The following table gives the list of contexts. This interface is used to read and write the data.lookup(“MyAppName”). .

the component needs to change its implementation and inherit from the ICachablePortalComponent interface. In that case. But the Portal Runtime will mark the cached content as expired in the following circumstances: A request or a component event has been sent to the component.Portal Runtime Cache The Portal Runtime implements by default a memory cache. The node mark has changed on a node. The request type is a REFRESH An exception is raised when executing the service method that is supposed to be stored in the cache. 3 values are allowed : • • • Shared : The cache content is shared among all the users (one java virtual machine) User: The content is private for each user Session: The content of the component is cached all the time the (servlet) session is running. A portal administrator could always force the PRT to use the cache properties defined in the Profile of the component by setting the property ForceProfileCachingParams to true. Portal Runtime Technology Page 31 /113 . In that case. API The ICachablePortalComponent interface offers the following methods to control how the PRT cache will interact with the content of the component. Properties A first property identifies at which level the cache needs to be placed by adding the CachingLevel property in your component profile. • • Configure the Portal Component by selecting a set of Properties. only the content of the request of type “content” will be stored in the cache. A content developer has two ways to decide when and how a Portal Component needs to cache content. the cache expiration is controlled by the component either because the validity period expires or the method hasExpired() returns true. This level is used to cache information related to the browser's sessions The property ValidityPeriod will A second property provides information on the validity of the cache. whether or not a user is connected. long creationTime. indicate the validity of the cache in milliseconds. Caching Expiration In general. hasExpired(IPortalComponentRequest request. long currentTime) returns true it the cache has expired getCachingLevel(IPortalComponentRequest request) returns a CachingLevel object representing one of the 3 values described above. Using the Portal Runtime API to control the validity and the granularity of the cache. This cache is used to store and retrieve the content of components that want to be cached.

try { PortalRegistry. This can be done during the initialization of a service that has been marked as load on startup.bind ("/runtime/connections/MyConnection".system/configuration Description Root context Folders for PAR files Folder containing the list of applications loaded in the repository.portal. Handle any incoming SOAP request.sap.portal. } catch (NamingException e) {}} Type Servlet connection Soap connection Description This is the default connection of the portal.system com. public synchronized void init(IServiceContext context){ mm_connection = new MyConnection(). Connnection Name /runtime/connections/portal /runtime/connections/soap Connection registration at startup: The registration must bind an object of type IServletConnection in the “connections” JNDI context of the Portal Registry. Portal Connection Framework The Portal Connection Framework offers an API allowing to control the process of a request.portal. The constraints are the following: The application must be declared “Load-on-startup” in the application config section of the deployment descriptor.getInstance(). The configuration of the Applications.sap.sap. In Addition the Portal Application Repository provides a central storage of application configuration and arbitrary application data. The connection must register itself to the Portal Registry The connection must implement the IServletConnection interface Two connections are provided by default by the Portal Runtime.sap. Portal Runtime Technology Page 32 /113 .system/applications com.Portal Application Repository The Application Repository serves to provide information on all available Portal Applications (including Portal Components and Portal Services). Each implementation might have a different request cycle. This layer allows to plug several “Connection” implementation to the portal. The Application repository is packaged and delivered as a standard Portal Service providing a JNDI interface to the following contexts: Folder Name com.portal. mm_connection). Connection implementations are delivered and packaged as regular Portal Applications.system/archives com.

and the response. Portal Runtime Technology Page 33 /113 . It gives access to the request.The IServletConnection interface has defined one method called: • handleRequest(IDispatcherContext) The dispatcher context gives access to the environment in which the connection has been started.

The name of the Portal Object to start is provided by the prtroot URL parameter. Start the content collection phase.M. Uses JNDI to get the Portal Object that is to be rendered. For further detail concerning “Runnable Portal Objects” please check: Portal Content Abstraction page 97. This chapter describes the request cycle as it is performed by the default “Connection” used by the Portal Runtime. The Node semantics is defined in the INode interface. During creation. Node When building the POM. Before content phase. c. b. A before content event is sent to all the nodes in the POM. the Portal Runtime notifies the participating elements to create their sub structures in the Portal Object Model and notifies them about their ready state. 2. All nodes involved in the POM have a chance to perform special actions before the actual content phase start.). Portal Runtime Technology Page 34 /113 . This is again a 3 steps phase: a. It offers methods to: • • • • Construct and traverse the tree. Raise any event defined by using an appropriately generated URL. An after content event is sent to all the nodes in the POM. Authenticate User attached to the request.7 Request Cycle The request cycle starts when the dispatcher receives an HTTP request and ends when the response is sent back to the browser. Retrieve the content of all the nodes present in the POM. 4. the Portal Runtime constructs a tree of special objects called Node. Every Portal Component involved in the process of the request is attached to a Node. Handle Request Event.O. 5. Store and retrieve data Access to the Portal Component instance attached to it. Create the Portal Object Model (P. User authentication. The default connection will perform the following steps: 1. Create the request's Portal Object Model that represents the structure of all components in the portal that participate in event handling and content creation within this request. Content phase. 3. Send and receive events. The Dispatcher selects the “Portal Connection” according to some information encoded in the URL. After content phase.

Accessing to a Mode The default way to render a component in a specific mode is to specify it through the URL used to access the component. which is often encountered by most of the Portal Components. EDIT. For that reason. ABOUT. a Node without any component attached to it and a Node with its Component. The root node called Portal Node. HELP. Portal Node Node a Component B Node b Portal Component Mode Portal Component Mode allows a component to render a different User Interfaces (UI). Mode Overloading Portal Component implements their own behavior by overloading the doXxx method as follow: public void doHelp (IPortalComponentRequest request. The Portal Runtime API offers similar mechanisms: • • • getComponentContext (NodeMode) on the IPortalComponentRequest. setNodeMode(NodeMode) method. the behavior to handle the mode named xxx is to invoke the doXxx(IPortalComponentRequest. ERROR. Modes are abstracting a context in which component can react and display an appropriate UI. every components must offer a support for it. The content mode is the default mode of operation when rendering a component. So a mode must represent a situation. LOGON. CONTENT. Modes are supposed to be general enough. setNodeMode(NodeMode) on the INode interface. IPortalComponentResponse) on the Portal Component instance. IPortalComponentResponse response) { Portal Runtime Technology Page 35 /113 . the Portal Runtime handles a number of pre-defined modes: • • TEST. on the IComponentURI interface using the CreateComponentURI Mode Handling When deriving from AbstractPortalComponent.The figure below shows a simple POM with 3 Nodes.

Default Mode Delegate The delegation mechanism may be defined as a default way to handle a mode. Mode Name Description System delegate Portal Runtime Technology Page 36 /113 . This is done in the configuration of the component in the portalapp. This mechanism allows developing specialized component. invoking this bound mode on any component will result in invoking the mode handling method on the delegate.write (“<BR> We are in help mode”). the Portal Runtime invokes the doEdit method on the component called DelegateComponent. the doXxx method is called on the delegate component.} response.sapportals.. </application> System Mode The Portal Runtime comes with a list of pre-defined modes and delegates. Mode Delegation The delegation occurs when a Portal Component decides to forward its rendering to another component..modes/admin" name="adminDelegate" type="component” rebind="false"/> </registry> .component.prt.portal.xml file as shown in the example below: <component name="mycomp"> <component-config> <property name="ClassName" value="com. The subsequent request events are also sent to the delegate component until the mode is set to default. a component needs to declare itself as the delegate for a specific mode by binding this mode in a specific folder called /runtime/prt. In that case. In the above example. To do so.default. The setup of such a component is also done in the Portal Application configuration as shown in the following example: <application> <registry> <entry path="/runtime/prt.MyComp"/> <property name="mode" value="edit"> <property name="delegate" value="DelegateComponent.modes of the Portal Registry.default"/> </property> </component-config> </component "> When the delegation for the xxx mode takes place.

Runtime internal usage. The Portal Runtime defines 5 types of hooks: • • • • • Document hooks. The hook can substitute the original response and is notified when the component has finished to use the response. Component hooks Executed before the service() method of the component. In that all the methods signed starting with test and signed with a TestResponse will be invoked. Those entry points are called Hooks. Display a short text explaining the purpose of the component. The content conversion feature is implemented as response hook The following picture shows at which of time. Runtime internal usage. Used by the Runtime to display the error returned by a component. Display the help text of the component. POM hooks Executed at every creation of a POM node.modes/badUserAgent /runtime/prt.modes/preview /runtime/prt. Do a preview component.modes/config Edit and save the profile of a component. of the StandardEditDialog SystemModes SystemModes SystemModes SystemModes Display the UI of the configuration framework starting from the root plugin of the component. Concerned by the construction of the output HTML document. the different hooks are called: Portal Runtime Technology Page 37 /113 . It could replace the event. forward it to another object or cancel the publishing. Start the component in a test mode.modes/edit /runtime/prt./runtime/prt.modes/help /runtime/prt. Event hooks Executed before firing any event.modes/test SystemModes /runtime/prt.modes/error ErrorComponent /runtime/prt. It could add some content or replace the content.modes/about /runtime/prt.modes/_release SystemModes ReleaseComponent Portal Hooks Only internal. CRITICAL TOPIC REQUIRING EXPERT KNOWLEDGE Purpose During the request cycle. Response hooks Executed before and after the service() method of the component. /runtime/prt. the Portal Runtime has defined some points that can be customized to add specific processing.

e. Adding a new Hook Portal is basically done in the following steps. Each hook implementation defines methods called during the hooks processing by the Portal Runtime. At hooking point. This is the reason why the hooking API is packaged into the core of the Portal Runtime. 1. IResponseHook. a.Adding a new Portal Hook In general. the Portal Runtime will first traverse the list of hooks declared and then Portal Runtime Technology Page 38 /113 . This entry implements one of the Hook interface defined by the Portal Runtime Hook API. This makes the hooking mechanism. IComponentHook. So the usage of this API must be reserved for very few occasions. INodeHook. b. IEventHook. very powerful and also very dangerous. Deliver a system service that binds an entry in the Portal Registry hooks context. IDocumentHook 3. adding a new Hook in the Portal Runtime will change the default behavior of all applications loaded in the Portal. 2. d. c.

The generic registry tag in the portalapp. The Portal Runtime will continue with the normal process after the hooks chain traversal. but the default Portal Runtime process is not performed at the end of the hooks processing.. Hence a portal component that doesn’t provide Any implementation for a request event (does not overload do<<EventName>> or doRequestEvent) would let the event handling to the component that provides a default implementation for this event. SKIP The hook chain is traversed. ERROR The hook indicates that it encounters a problem during its execution. <application> <registry> <entry path="/runtime/hooks/event/request.perform the default behavior.xml is a suitable place to declare a default event handler. c. The aim is to write the event handling one time and to make it available for all the portal components.. Default hooks Request Event Hook A portal component can provide a default request event handler. Example: The component named MyEventListener is providing a default implementation for the event named “myevent”. b. </component> </components> </application> Portal Runtime Technology Page 39 /113 . OK. During the hooks traversal.listeners/myevent" name="MyEventListener" type="component"/> </registry> <application-config> <property name="releasable" value="true"/> <property name="startup" value="true"/> </application-config> <components> <component name=" MyEventListener"> . each hook returns a status that can have one of the following value: a. but the hook chain is still traversed and the default behavior is going to be executed.

Event Handling The Portal makes the distinction between two kinds of events: • • Request Events POM Events Events sent by the client set in the URL received by the WEB server. This is sent on a preorder traversal of the POM. IEvent.BEFORE_CONTENT_EVENT IEvent. Receivers that have to assign children in the POM should do it upon handling this event.ON_POM_READY_EVENT IEvent. This is can be a good time to release all listener assignments that depend on the current POM structure. Portal Runtime Technology Page 40 /113 .AFTER_CONTENT_EVENT IEvent.IPortalRequestEventData) returns a request event corresponding to the name and containing the data passed as parameter.ON_NODE_READY_EVENT Means that the node/component has been assigned to its parent node in the Portal Object Model on its construction in the request cycle. Receivers that have to assign children in the POM should do it upon handling this event. Means that the node is going to be removed from its parent node. Events sent by a Portal Component to another. Those events are then generated in the content of the Portal Component and the methods to handle the events have to be written in the Portal Component.ON_NODE_REMOVE_EVENT Request Event API Request Event must be generated by the standard Portal Component API method used to create event. Means that the node/component has been assigned to its parent node in the Portal Object Model on its construction in the request cycle. IEvent. Means that content collection is over. Internal Portal Runtime Events Several pre-defined events are raised by the Portal Runtime to inform the Portal Components involved in the request processing of the progress of the request cycle. creates a Request Event with the name IPortalRequestEvent createRequestEvent(String . Means that we enter content collection next. The methods to create the event are defined in the IPortalComponentRequest Object • • IPortalRequestEvent createRequestEvent(String) passed as parameter.

Component Event API
Component Event is a mechanism to send and receive special type of POM events which have name and data. It allows a component to listen and filter events sent by others components. The sender component should create a component event and fire it using the Portal Component API. The receiver component should listen to events and react when the events are received. Those events are generated by the Portal Component API using the following methods on the portal node. • IPortalComponentEvent anEvent createPortalComponentEvent (String name) Events are then published by calling the fireEventOnNode method of the Portal Node of the POM. A component event should be fired on the portal node only. • • fireEventOnNode () publish the event to all the nodes of POM.

addEventListener (EventType.COMPONENT_EVENT, IEventListener, IEventFilter) declare an Event Listener and attach an Event filter to receive only events in which the Portal Component is interested

Helper class is provided for component events (AbstractComponentEventFilters).

Event Handling
When deriving from com.sapportals.portal.prt.AbstractPortalComponent the following default behavior applies for the event handling. Corresponding to the events mentioned above the methods doOnNodeReady, doOnPOMReady, doBeforeContent, doAfterContent, doOnNodeRemove will be called. For Request Events there is a special treatment. Given a name xxx of the Event the default implementation will try to call a method doXxx(IPortalComponentRequest, IPortalRequestEvent). If such a method is not available doRequestEvent(IPortalComponentRequest, IPortalRequestEvent) will be called. For Component Events, a similar treatment is executed. Given a name xxx of the Event the default implementation will try to call a public method doXxx(IPortalComponentRequest, IPortalComponentEvent). If such a method is not available doComponentEvent (IPortalComponentRequest, IPortalComponentEvent) will be called. In addition to that, the filter attached to the listener is invoked before proceeding with normal event handling and the filter can decide to accept or reject the event handling in the following method: • boolean accept (IPortalComponentEvent) returns true if the event handling should take place.

Portal Runtime Technology

Page 41 /113

8 JNDI Support in PRT
The standard JNDI way to get access to JNDI Factories assumes that the JNDI service provider classes are in the class path. Unfortunately PRT (like any J2EE engines) implements a class loading separation feature that contradicts with the JNDI approach. This chapter explains how to use JNDI service providers without loosing the benefit of class loading separation.

PRT JNDI Support Package
The PRT JNDI support package provides a different implementation of the following core JNDI classes: javax.naming.NamingManager javax.naming.DirectoryManager javax.naming.InitialContext javax.naming.InitialDirContext The standard JNDI implementation is not able to find classes that are not in the class path. The implementation that PRT provides simply changes the way the classes are loaded. More precisely, PRT tries its own mechanism and if it fails, delegates to the standard implementation. The PRT Implementation is delivered in the JAR File: prtjndisupport.jar. The classes that should be used to solve class loading issues are the following: com.sapportals.portal.prt.jndisupport.NamingManager com.sapportals.portal.prt.jndisupport.DirectoryManager com.sapportals.portal.prt.jndisupport.InitialContext com.sapportals.portal.prt.jndisupport.InitialDirContext Note that only the package name has been changed (not the class name). As a consequence the impact on the code is minimal since changing the import statement might be sufficient.

JNDI Service Providers
To take benefit of the PRT JNDI Support, JNDI Service Providers will have to compile against this new “com.sapportals.portal.prt.jndisupport” package and delegate to the PRT implementation instead of calling directly the core classes provided by the “javax.naming” package.

import com.sapportals.portal.prt.jndisupport.DirectoryManager; // convert the persistenceObject to a semantic object Object semanticObject; semanticObject = DirectoryManager.getObjectInstance( null, name, this, env, objectAttributes);

Portal Runtime Technology

Page 42 /113

JNDI Clients
JNDI clients have to change the way they get the InitialContext. They must used the PRT Implementation of the Initial Context class instead of the standard one like below:
import com.sapportals.portal.prt.jndisupport.InitialContext; ... try { Context initialContext ; Hashtable env = new Hashtable(); env.put( Context.INITIAL_CONTEXT_FACTORY, "com.sapportals.portal.pcd.gl.PcdInitialContextFactory"); initialContext = new InitialContext(env); Object o = initialContext.lookup(aName); } catch ( NamingException e ) { e.printStackTrace(); }

JNDI Service Providers Packaging
A typical JNDI service provider will be deployed in the portal like any portal application by providing a PAR File. In order to register itself to the PRT JNDI Support, the application have to include a java property file named jndiprovider.properties in its PAR File and be declared as “load-on-startup” in its deployment descriptor. The location of this “JNDI Provider Resource File” in the PAR file must be:
/PORTAL-INF/properties/jndiprovider.properties

This file is a regular “JNDI Provider resource file” and when loading the portal application, PRT uses it to get the following JNDI properties:
java.naming.factory.initial java.naming.factory.object java.naming.factory.state java.naming.factory.url.pkgs

Note that properties for object and state factories might provide a colon-separated list of class names. For more details about these properties, please check the JNDI Tutorial at:
http://java.sun.com/products/jndi/tutorial/beyond/env/overview.html

PRT also expects from that file additional properties defining the schemes that the JNDI Service Provider will support at runtime:
com.sapportals.portal.prt.jndisupport.scheme com.sapportals.portal.prt.jndisupport.schemes

Portal Runtime Technology

Page 43 /113

naming.state=com.factory. which provides basic operations like: bind.factory.tm.providers # # scheme supported by this JNDI service provider # com.naming.application.sap.TravelInitialContextFactory # # List of packages where to look for URL Context Factory # java.sun.scheme=tm # # State factories # java.com/products/jndi/tutorial/beyond/env/overview. lookup and list.naming. Please check the link: http://java.jndisupport.jndi.application. This environment typically includes user authentication information. It allows to organize data hierarchically. The “Initial Context Factory” will be the root node to the specific content.Context interface. JNDI Concepts and Related Documents The JNDI Tutorial provides in-depth information concerning the JNDI API and how to implement it.factory.portal.sapportals.sap. Portal Runtime Technology Page 44 /113 .sap.TravelObjectFactory # Each factory declared in that file are playing a specific role at runtime.prt.pkgs=com. the state factory will be used to update/store objects in the persistence layer and the scheme will avoid naming conflicts with other JNDI providers.initial=com.com/products/jndi/tutorial/ JNDI Environment The environment is a property set (Hashtable) used to specify various preferences and properties that define the environment for which the contexts are created. This application could have its own factories and its own scheme (tm:).tm.factory.application.tm.naming.sun.html JNDI Context A JNDI context is an implementation of the javax. A typical “JNDI Provider Resource File” could be: # # Initial Context Factory # java.JNDI Provider Resource File Sample Let’s imagine a “Travel Management Portal Application” that want to plug its own content to the portal.object=com.sap.naming. JNDI Tutorial: http://java.TravelStateFactory # # # Object factories # java.url.tm. The Object Factory will be used to get the raw data from the persistence layer and load it in memory as Java objects.

3/docs/api/javax/naming/spi/InitialContextFactory.html Portal Runtime Technology Page 45 /113 .More detail at: http://java. Factories are necessary because only the factory knows about the context implementation.sun. The JNDI Naming Manager internally used factories to get Context instances.3/docs/api/javax/naming/Context.html JNDI Context Factories The initial context factory is the object used to create initial context instances.com/j2se/1.sun.com/j2se/1. More detail at: http://java.

It is accessible via an URL of the type : irj/servlet/prt/soap/PortalServiceName?wsdl . the Portal Runtime provides tools and facilities to generate Proxies to external WEB Services. By providing a SOAP connection to the Portal Services.xml property WebEnable=”true” WebProxy=”true” Effect Turn the service into a WEB service Force the use of the proxy of the service Portal Applications and external WEB services External WEB services can be accessed by portal components or portal services. external components can access to the services and applications developed with the Portal Runtime technology using the SOAP protocol. Thus.9 WEB Services Support A natural extension of the concept of Portal Services is the WEB Services technology. generated with the ToolKitWebServicePRT you have to set the property WebProxy=”true”) . Portal Components SOAP Service LAYER SOAP Protocol . The first one consists in offering Portal services as WEB services. Portal Components and Portal Services can easily access to external WEB Services to build Portal Applications The purpose of this chapter is to describe how work WEB Portal Services. Approach The Portal Runtime offers two convenient ways to use the WEB services. Portalapp. This done. In the same way. The WSDL file informs what are the accessible methods in the service. The related tool Portal Runtime Technology Page 46 /113 . The following line must be added : WebEnable=”true” (If you want to use a proxy.xml makes the trick. the Portal Service is a Portal Web Service. Only the WSDL file of this external WEB service is requested (even if it is only accessible via Internet). The second one allows portal applications to access external WEB services. A simple modification of the portalapp.NET / INQMY / SOAP APACHE WEB SERVICE IMPLEMEN TATION Portal Services … The external WEB service is accessed like every other service within the portal. Portal Services as WEB Services Turning a Portal Service to a Web Service is something very smooth and easy after using the open tool (ToolKitWebServicePRT).

It is done if the security is respected (rights. On the other side. Service Requestor Web Services tool (Open Tools) Service Invocation Implementation Service Wrapper Service Provider Web Services tool (Open Tools) D E S I G N Service Implemen -tation WSDL WSDL Generator SOAP Service D E V R U N T I M E Service Invocation SOAP Consumer SOAP Service WSDL Soap Service Service SOAP Connection PRT Service SOAP Message Portal Runtime Technology Page 47 /113 . Concepts The principle of the WEB services into the portal is shown below. It can be seen on the schema. for the provider. For emitter as for receiver. Very few things are requested to allow a WEB service to run into the portal. etc…) The needed operations are shown more precisely into the architecture part.(ToolKitWebServicePRT) allows you to configure your development environment. And when a soap message is received. each access to the soap service is converted by the runtime to a soap message. The answer is waited and when this one arrives the process can go on. The open tool do almost all the work needed. The whole process (or so) is hidden to the user. All is wrapped by the portal runtime. All the manipulations done by the open tool are done before making the PAR file. The portal service of the requestor is wrapped by the open tool (ToolKitWebServicePRT) from the WSDL file to the external WEB service. the WSDL file of the soap service within the portal is generated by the open tool (the same as before). Then. There is no intervention of the open tool in the runtime sequence. the soap message is not directly handled by the portal service. the message is interpreted by the runtime and redirected to the specified portal service. It is as easy as developing a portal service. Nevertheless as it interacts a lot with the WSDL files it is useful to know a little how it works. identifications.

wsdl Open Tool Open Tool Proxy SOAPProxyP Par Reflection + Connection Information WEB Service development process 1. WSDL is an XML format for describing network services as a set of endpoints operating on messages containing either document-oriented or procedure-oriented information. It is an XML based protocol that consists of three parts: an envelope that defines a framework for describing what is in a message and how to process it.Architecture In this part. however. the main architectural aspects of the portal WEB services will be detailed. and a convention for representing remote procedure calls and responses. distributed environment. Portal Runtime Technology Page 48 /113 . the only bindings defined in this document describe how to use SOAP in combination with HTTP and HTTP Extension Framework. SOAP can potentially be used in combination with a variety of other protocols. IService Open Tool . A Web Service is an interface that describes a collection of operations that are network-accessible through standardized XML Messaging. Soap Framework SOAP is a lightweight protocol for exchange of information in a decentralized. a set of encoding rules for expressing instances of applicationdefined data types. wsdl From External Service IXXXService methodA methodB Simple and Complex Types … IX.

1.1 The Portal WEB Services give a common architecture to connect external Web Services. will also use the portal WEB services implementation to the address them. dynamic service methods invocation….0 Implementation (based on the JavaTM API for XML Messaging (JAXM) version1.2 The Portal WEB Services give to developer an easy way to create Web Service. we use the new libraries inqmysoap. The developer. We provide • An interpreter for WSDL Language o o • • • o to make portal services to address external web services Be able to cope with custom types Serializers / Deserializers generator Complex Object wrapper Web services configuration stored in the Central Config Storage 1. the Portal Runtime will also provide his own implementation to generate proxy for Web services Connection. This implies different functionalities as SOAP interpreter.0) which was developed as JSR067 under the Java Community Process. o o • o Be listener Address Message to the SM Be able to decode SOAP Message Address call to the good service Decode parameter Construct answer • Implements JAXR Specifications o Publish our service to external new calls Provide WSDL Description of service Automatic process or not • Web services configuration stored in the Central Config Storage Interpreter for WSDL Language One unique entry point The advantage of this approach is that there is no need to provide multiple URL. which needs to contact external Web Services. The portal WEB services implementation is also able to deal with the WSDL concept. The open tool is able to generate a portal service from a WSDL file. In this case. It also allows us to only provide one ServletConnection to understand SOAP Calls. These URLs are of this type : irj/servlet/prt/soap/AliasApplication Portal Runtime Technology Page 49 /113 . to be connected. For that. We provide • Open simple way to receive SOAP Messages. The portal WEB services implementation is able to receive SOAP Messages.jar. a JAXM 1. Java proxies generation.

the parent class is asked for it – and so for as many levels as needed). The specialized registries are loaded in the class loader of the corresponding service.xml” file (description of the portal applications) to declare the service as WebEnabled (proceed the same way for the WebProxy). extract Soap messages from it and to pass them to the Soap Consumer SOAPConnection Class is able to receive HttpRequest. contains all the Soap types and some common Java types. The Soap message is deserialized to transform it in a java method call. It calls the Service Manager to access the called service. This class could be compare to the JAXMServlet class from Sun. The difference is that this approach allows us to easily include the Soap listening to our Connection Layer. the MimeHeaders and the ServletInputstream. to receive request call. A list of processors is maintained by the portal. These serializers and deserializers are included into the deployed PAR files. For processing a soap message you need to unmarshal it. Registries Supported types (serialization and deserialization) are maintained by registries. Processor The processor insures the method invocation. 3. 4.irj/servlet/prt/soap/ApplicationName. It implements IServletConnection. Soap connection The SOAP Connection registers itself to the Portal Plug in Framework. load dynamically the Portal Runtime Services and address them the call. The developer of the Portal Services will have to provide a few extra works. the Mapping Registry. If the XML Soap Message description is well formatted and if the called service exists on the Portal Runtime environment then the Soap Consumer can work correctly. That means that it must verify whether the Soap message is Portal Runtime Compliant.ServiceName Easy use of Portal Services The Portal Runtime Services are called dynamically by the SOAP Listener (or Consumer). another a type. It gets from the request. Some other processors are in development like the WSRP processor. another one the value and so on. A global one. the Java object is serialized to an xml content (marshal of the soap message). Other ones are linked to services. Soap Consumer The Soap Consumer is in charge of processing the Soap message. This process works also on interfaces and copes with inheritance (if a class has no deserializer. 6. Proxies Portal Runtime Technology Page 50 /113 . The service developers need to provide: The exposed methods wanted. the only provided processor is a portal service. to recreate the incoming Soap message. The Soap Consumer is also in charge of the answer construction. Create the associated PAR file and upload this PAR file. 2. 5. SOAPConsumer class is able to read the Soap Message and its possible attachments in collaboration with the ServiceManager to retrieve. Now. when a soap message is constructed. And. The xml content is converted to java code. on the contrary. Each service refers to its Specialized Registry to deals with custom types. selected with the open tool Modify the “portalapp. An xml tag represents a method.

org/2001/12/soap-faults"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>%TYPE_ERROR% </faultcode> <faultstring>%DESCRIPTION_ERROR%</faultstring> <faultactor>%[SERVER_NAME] COMPONENT NAME%</faultactor> <detail> <stackTrace >%JAVA_STACKTRACE%</stackTrace> </detail> </SOAP-ENV:Fault> </SOAP-ENV:Body> Portal Runtime Technology Page 51 /113 . Other messages (i. 7. The header also contains a way to check the Soap message integrity. Security Soap messages from a SAP Enterprise Portal to our Soap processors may not be encrypted. it is converted automatically in SOAP Fault Message with the following structure : <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas. Soap messages are included in HttpRequest. it wraps all the requested methods and decompose them.The open tools can generate a proxy for each portal service turned into a WEB service. SOAP Fault Process • The invoked method generates an exception SOAP FRAMEWORK Portal Service SOAP Request Invoked Method Exception throws SOAP Response (Fault) SOAP Fault Message During the invoke of the Web Service’s method if an exception is throw.xmlsoap.w3. There is also be a protection/verification of incoming Soap messages in order to avoid the execution of our services via Soap attacks.e. The service then manipulates the proxy for its soap calls. It provide efficient security to the portal WEB services. The proxy externalizes the method call. There are two ways for doing it. Use of the “CRC” principle. It means the use of https protocol and single sign on (sso) identification (into the soap header). on request by the open tool.org/soap/envelope/" xmlns:fault="http://www. The proxies are also used for the call of external WEB services. So the normal process of authentication included in the Portal Runtime environment can do the authentication process. The whole process is once more hidden from the user. The other way implemented to increase security for soap messages is to block the method call for users who do not have the permission to use them. 8. The proxy is automatically created. outgoing Soap messages) need to be encrypted.

Within the portal. to enable the soap logger to store the soap message and debug information you must select the property “ Log” in the Configuration menu of SOAP Admin component Related tools Some tools are quite useful for developing portal WEB services. • The SOAP Call return a fault message WEB SERVICE SOAP Request 2 SOAP FRAMEWORK 3 Error Server SOAP Fault Message SOAP (Fault) Response PRTSOAP Call 1 Web Portal Service SOAP Fault Message 4 Create 5 Throws PRT Fault Exception PRTFault When a WebService Portal Proxy Service invoke a webservice method (1). normally a SOAP Fault message is generated by the WebService and returned as response(4). .log). a serializer and deserializer generator. You may also find interesting the SAPParWizard (for both Eclipse and JBuilder) for development operations about PAR files. The main one is the ToolKitWebServicePRT (a JBuilder open tool) which contains a WSDL Generator. Portal Runtime Technology Page 52 /113 . 9. the soap admin tool (for configuration needs) and the Soap test suite. SOAP Logger In the PRT SOAP Framework. all soap messages are logged in the SOAP Logger if it is enable. It contains an example of external WEB service use (Google WEB service.0 (the name is soap. the SOAP Logger file is stored in the log folder of EP6. By default the information logger is disable. a proxy generator and a complex objects wrapper. mssoap. it is possible to disable the display of java stack trace in the SOAP Fault Message. allows searches on Google) and an example of client proxy use (This proxy is open tool generated). It verifies the compatibility of the round 1 tests with the main soap platform available on the market (systinet. the PRTSOAP Call class in the PRT SOAP Framework generates the SOAP Request (2) and in the case an where an error will be occur in the Web Service Server (3) during the SOAP process. The second form of the log is the soap debug information. two other tools can be found. For that the property “Debug Mode” must be deselect in the configuration menu. apache…). It contains Interoperability tests (round 1 – to check the compatibility between the portal WEB services and other implementations). All exceptions throws in the SOAP framework and the Portal Web services are logged in the SOAP Logger.net.In SOAP Admin tool. it exists two forms of log different. and it throws in the WebService Portal Proxy. The PRTSOAP Call converts the SOAP Fault message by a PRTFault Exception (extends SOAPServiceException) (5). It also contains an example which shows a way of using the WSDL generator (on the fly WSDL file reading and writing).

compile and add resources to Portal Application. Supported objects are Portal Components. Edit. Portal Services. The objective of the PAR IDE is to speed up the Portal Application development process. Portal Runtime Technology Page 53 /113 . Portal WEB Services. It allows Portal Application developers to extend the original Portal Application development model. Additional Feature The PAR IDE offers also an API to register a plug-in that can be called during the creation of the PAR File.iviewstudio. PAR Export Upload Create PAR IDE Portal Application Development Cycle PRT PAR Import Execute and Test The goal of the PAR IDE is allow a Portal Application developer to cover all the development steps in one environment: • • • Export/Import/Create PAR files.10 PAR IDE The PAR IDE is an eclipse plugin supporting the Portal Application development model. code. Upload/Execute/Debug Portal Application.com/ Approach The following picture shows the Portal Application development model: A Portal application has to be packaged in a Portal Archive (PAR) file and must be uploaded in the Portal before being executed. Create a Portal WEB Services from a WSDL or Portal Service The complete documentation can be found in the iView studio WEB site: http://www. It allows to: • • • • Import PAR file Export PAR file Add a Portal Object to a PAR.

The plugin id must be unique. During the packing operation. And during the unpacking operation. 4. Eclipse startup The plugin add-on has to be loaded when eclipse starts. It must be loaded at the eclipse startup.eclipse.eclipse.developmentTools. So in its constructor.xml the following extension point has to be added. In the plugin.plugin. IParIdePlugin aPlugin). In order to create such a tool. It must implement two interfaces. …in order to register to the PAR plugin.portal. 2.api. Register Now. you have to produce a PAR plugin add-on. an add-on plugin must implement the com.sap.startup"> </extension> In the base class of the add-on plugin (the first class called when the add-on plugin is started.ideSpecific.. It will allow this add-on to register into the PAR plugin. one for the packing the other for the unpacking. it can be assumed that the add-on plugin is loaded at startup..eclipse. the additional tool will be called before the final packing of the PAR file.ui.PortalPlugin class: registerPlugin(String pluginId. the additional tool will be call after the initial unpacking of the PAR file. The interface to implement To register.IparIdePlugin and give the implementation class as parameter when it registers. In order to achieve this follow the instructions.eclipse.You can interfere with both process concerning the packing and unpacking of the PAR file. 1.general. and where org. Other important notes The add-on plugin has to clearly specify the final state of the operation using the method setFinalState(int status) from the class Portal Runtime Technology Page 54 /113 . 3.sap. Call of the static method of com. it can register itself to the PAR plugin.Istartup with its unique method (earlyStartup()) must be implemented.developmentTools. This add-on is also an eclipse plugin and must follow few simple rules: 1. 2.portal.AbstractUIPlugin is extended) the interface org. 3.ui.ui. <extension point="org.

general.sap. Portal Runtime Technology Page 55 /113 . These will be displayed into the task view of Eclipse. you can also add as many messages with their level as you want. If the final state is OK or warning then the PAR process will go on otherwise it will be stopped.IfinishResult. Inside the IfinishResult.developmentTools.portal.com.api.

Example of deployment descriptor enabling backward compatibility properties <?xml version="1.km. When EP50 archives are uploaded to the portal the EP60 Deployment descriptor is dynamically generated and stored in the repository.sap. In that case the old folder is not removed and the the deployment process simply overrides the folder with the new content.0” then the deployment is backward compatible with the EP50 version of the portal. If this property is set to “5.wcm. API definitions of referenced Portal Applications via the "SharingReference" property will not be visible to referencing applications automatically.0 model assumes that definitions made accessible via the "SharingReference" property can be considered part of the Applications API and should therefore be also made visible to a referencing application. See also Class Loading in the Portal Runtime.0" encoding="utf-8"?> <application name="com.application" alias="knowledgemanagement"> <application-config> <property name="releasable" value="false"/> <property name="PreservedConfigPaths" value="/PORTAL-INF/lib/config_local. Those files and paths will not be replaced by the new version. The 6.KMServiceImpl"/> <property name="classNameFactory" value=""/> <property name="classNameManager" value=""/> <property name="poolFactory" value="0"/> <property name="startup" value="false"/> </service-config> Portal Runtime Technology Page 56 /113 .portal.0". It is important to know that those generated deployment descriptors will by default enable the EP50 Deployment and Class Loading Policy.properties"/> <property name="ClassLoadingPolicy" value="5. In that case the deployment policy also takes care of the deprecated “PreservedConfigPaths” property. - EP50 Class Loading "ClassLoaderPolicy": if set to "5. EP50 Archives EP50 PAR Files and ZAR Files were using a different format and the XML based deployment descriptor as it is today was missing. By default they will.sapportals.11 Compatibility Considerations EP 5.0 version to enable backward compatibility EP50 Deployment Policy The local deployment of a portal application is done taking care of the “DeploymentPolicy” property declared in the application config section of the deployment descriptor.0 Backward compatibility The following section describes some mechanisms that were kept or introduced in the 6.service. This property provides a comma-separated list of paths or file names that are protected.0"/> <property name="DeploymentPolicy" value="5.0"/> </application-config> <components/> <services> <service name="default" alias="knowledgemanagement"> <service-config> <property name="className" value="com.

a Portal Application is portable from Windows to Unix. the PRT should run on Windows and in development mode by setting the portal.mode property to development Portal Runtime Technology Page 57 /113 . If a file name or a WEB resources is wrongly capitalized. With this mechanism.0 • • jco service is deprecated jcoclient service: the different getJCOClientPoolEntry() methods throw a TimeoutException (a RuntimeException). and proposes a development model relying on the Java Technology.log. This check produces a warning message each time that the name of the resource in the file system is not the same than the name passed as parameter of the API regarding its capitalization.2 UNIX/Windows compatibility As the PRT is written in Java.permission. Portal Application developers can fix their applications on Windows without having to wait to see their applications crashing on Unix. The warning message is logged in a new file called diagnostic. PRT offers a case-sensitive check when accessing WEB resources via the Portal Component API.</service> </services> </application> List of Incompatibilities to EP 5. the error will occur only in Unix and will be hidden in Windows. a common portability problem often encountered by Portal Application developers when running on Unix an application developed on Windows is the case-sensitive issue.0 since SP 4. To enable this check. this is the same in EP 5.runtime. In order to help Portal Application developers to identify those kind of problems on the Windows platform. However.

This is the only service having such knowledge of the execution infrastructure. This implies that a version of the Notification Service should exist for every supported platform.runtime. In this example. the message is sent to all the PRTs declared in the cluster. The service use to subscribe and receive message ITopicListener. the component B on PRT2 is registering to a specific topic and the component A is publishing a message associated to the topic in which the component B is interested in. The PRT Bridge uses the SAP J2EE cluster configuration to obtain this knowledge.sap. TopicDataContainer Representation of the message sent from a PRT to another PRT.notification The notification Service is responsible to provide a support for communication between PRT instances running in different Portal Environments. The following figure illustrates the architecture of the Notification Service. The API is built around the following objects: o o o • INotificationService. the Notification Service uses the PRT Bridge to manage the communication between the different nodes of the cluster. Maintain the cluster information. When the component A publishes on PRT1.system. Interface implemented by objects that want to listen for messages associated to a certain topic. The notification service has two goals: • Deliver an API to send and receive messages between different WEB servers.portal. In the SAP J2EE environment.12 Additional PRT Services Notification Service Application name: com. The Notification Service implementation must understand the cluster configuration. PRT 1 Component A Notification Service PRT 2 Component B Notification Service PRT Bridge PRT Bridge SAP J2EE cluster configuration Portal Runtime Technology Page 58 /113 .

The value of ContentType must be the text representation of an instance of PortalComponentContentType. The target content type of this conversion is the content type defined by the PortalResponse. After the component has finished its content generation. IPortalComponentRequest request) Using the parameter request. Content converters are provided to the PRT by content converter factories that implement IContentConverterFactory. A component that wants to generate a content type other than HTML must specify the property: ContentType in its configuration. but a Portal Component can decide to generate content of another type like XML or WML. If a component wants to change the content type during generation. it can call the method: public void setContentType(PortalComponentContentType type) defined on IPortalComponentResponse.portal. the converter has access to the components resources and can locate any scripts/parameters that the component might provide to perform the conversion. Portal Runtime Technology Page 59 /113 . text/wml At runtime such a component receives a PortalComponentResponse in which the component can write multiple content types. This interface contains the method: public IContentConverter getConverter(PortalComponentContentType fromType.application. PortalComponentContentType toType) The factory must be registered in the Portal Registry. e. The content type defined by the property ContentType is the content type a component generates at the beginning of the content generation. A content converter is capable of converting content of one content type to another. The Content Conversion Service allows Portal Components to generate such alternative content types. Such a component can also participate in a WEB service scenario. With this mechanism a component can even generate multiple content types during one content generation. Everything written from this point on is treated as belonging to the content type set. It uses internally the PRT mechanism of a response hook.runtime.sap.Content Conversion Service Application name: com. Content Converters To perform the conversion the service uses content converters.g. It implements the interface IContentConverter that defines the method: String convert(String content. The Content Conversion Service will convert them all to the target type which is the type of the PortalResponse. The path in the registry where the factories must be registered can be obtained by calling getContentConverterRegistryRoot() defined on IContentConversionService. a conversion of the content takes place.contentconversion In general Portal Components are generating HTML content.

String fromType = URLEncoder. Instances of XSLConverter are used to do conversions using XSL style sheets.KEY). Content Converter Service Application name: com.contentconverter This service provides a generic XSLConverter that implements IContentConverter (see Content Conversion Service).The key to register the factory must be the concatenation of the two content types that the factory is able to provide a converter for.getInstance().runtime. The two content types must be URL encoded. See the API documentation for more details: public XSLConverter(File styleSheet. myFactory). String toType = URLEncoder. String styleSheetReference) throws FileNotFoundException Portal Runtime Technology Page 60 /113 .encode(PortalComponentContentType. An XSLConverter can be created by specifying a style sheet to be used or/and the converter can look for a style sheet at runtime in the components resources.toString()). String mm_rootKey = contentConversion.bind(mm_rootKey + "/" + mm_RSSToHTMLConverterRegistryString. String mm_RSSToHTMLConverterRegistryString = fromType + toType.sap.HTML.RSS.getContentConverterRegistryRoot().portal.application. Here is an example that registers myFactory to provide a converter that can convert from RSS to HTML: IContentConversionService contentConversion = (IContentConversionService)mm_serviceContext.getService(IContentConversionService. PortalRegistry. This is the constructor of XSLConverter.encode(PortalComponentContentType. The Content Converter Service registers during startup the following content converter factories: RSS -> HTML XML -> HTML The converters provided by these factories are instances of XSLConverter.toString()).

jcoclient This service is used in EP 5.JCO Client Service Application name: com.portal.application. Please refer to the corresponding documentation therefore. however is the connector framework.0 to provide JCO clients to Portal Components.0.runtime. The recommended way to obtain JCO connections with EP 6. The JCO Client Service provides the following functionality: • • • • • • Provide JCO clients to Portal Components Connection pooling HTTP session timeout detection Close connections when user logs off Maintain a connection limit (configurable) Authorization Trace (configurable) Following is a usage scenario to explain this functionality: User 1/ Session 1 User 1/ Session 2 User 2/ Session 1 a b c a b b Portal Runtime a c d e JCO Client Service R/3 R/3 System 2 f System 1 f Portal Runtime Technology Page 61 /113 . It exists in EP 6.0 as well for backward compatibility reasons.sap.

each user is allowed to use 10 connections to R/3 System 1 in the scenario above. This is used to generate the user definition in R/3 with the appropriate authorizations to execute a specific business package. a b c d e f Related documentation: • • • JCO Client Service API documentation. Technical Article: How to share JCO connections in iViews. All function modules accessed by a specific user are traced (configurable). Portal Runtime Technology Page 62 /113 . In this scenario the JCO Client Service provides the following functionality: If the user logs off from the Portal. It is assumed that both users use the R/3 System 1 and System 2. Available in iViewStudio. If the HTTP session timeout occurs. Connections that are no more referenced in Portal Applications are identified by the VM garbage collector and deducted from the connection limit. all JCO connections requested in this session will be closed. all JCO connections requested in this session will be closed If a connection limit (configurable) is defined in the JCO Client Service for a specific destination. This can be configured per destination. Available in iViewStudio and PRT documentation. this limit is maintained for each user over several sessions. If for example. The JCO Client Service maintains a timeout for connections contained in each pool. Connections are pooled. JCO Client Service Tutorial.In the above scenario User 1 is logged on with two different sessions and User 2 with one session. than the service ensures that this limit does not exceed the sum of connections in both sessions used by User 1.

IPRTRFCListener • Portal Service should then register in their afterInit() method the RFC it want to cover using the following function of the RFC Engine Service.setValue("This is a response from the TestRFCService side!". service.getImportParameterList().getName().equals("STFC_CONNECTION")) { output."RESPTEXT").portal. public class TestRFCEngineService implements Iservice. JCO.getExportParameterList().Function function. String nameOfService) IRFCEngineService service = (IRFCEngineService) mm_serviceContext. JCO. IUserContext userCtx) throws Throwable { try { JCO.KEY).ParameterList input = function.RFC Engine Service The RFC Engine Service allows to invoke a Portal Service from a R/3 system via an ABAP call to the Portal Runtime.getTableParameterList(). “My Service or application name”)."ECHOTEXT").setFunctionCallListener ("MY_R3_FUNCTION". if (function.ParameterList tables = function. the Portal Service must implement the function handleRequest to receive calls from R/3 system.service. Portal Runtime Technology Page 63 /113 .rfc.getService (IRFCEngineService.setValue(input. • The Portal Application has to reference the PRTRFCEengine Service. } return function.IPRTRFCListener.prt. public JCO. Service Description • Portal services that want to be called via RFC must implement a new interface com.ParameterList output = function. output.Function handleRequest(JCO.sapportals. setFunctionCallListener(String nameOfFunction.getString("REQUTEXT"). <application alias="TestRFC"> <application-config> <property name="ServicesReference" value="RFCEngine"/> <property name="releasable" value="true"/> </application-config> • Finally. This service knows and maintains a list of EJBs accessible from R/3 system via a RFC. The implementation of the RFC Engine Service is based on the rfc-engine service provided by SAPJ2ee. The PRT RFC Engine Service registers itself to the SAP J2EE service as an EJB.

This triggers the registration of an EJB call PRTBase to the SAP J2EE RFC Engine. in method handleRequest.The PRTBase EJB transmits the call to the PRT Bridge. it looks in its 5. by asking for the IRFCListener registered in the bridge under the name “PRT_RFC”. Security Open Issues We need an authenticated Portal user in order to interact with some Portal services when being called via RFC. 2. This Portal Service has to implement the interface com. The PRTRFCEngine service is registering itself to the PRTBridge Service. Portal Runtime Technology Page 64 /113 .On its start-up the Portal Service listener of RFC registers itself to the PRTRFCEninge Service. we are not able to know what is the R/3 user.On start-up. which had generated the calls.rfc.IPRTRFCListener and so to define the method: JCO. 6.The PRTRFCEngine is registering the new Function to the SAP J2ee RFCEngine service. 4When an R/3 System calls a function for the registered RFC-destination.Function handleRequest (JCO.prt.Implementation 1.The Portal RFC engine transmits the call to the Portal Service.sapportals. which registered the function name.The EJB transmits the call the PRT RFCEngine 7. IUserContext userCtxt). to find which is the EJB registered under the function name.Function function. context. 3. the parameter IUserContext is not fill in. under the name “PRT_RFC”. With the actual version ramp-up and SAP J2ee.portal. With the version SAPJ2ee 6.20 of the rfcengine service. This issue will be fixed in the future version.service.

load and manage its own configuration in the Portal. those configurations objects and react to changes occurring of those objects. Read/Write/Update/Delete via an API. Portal Runtime Technology Page 65 /113 .13 Configuration Management in Portal Application The objective of this chapter is to describe how a Portal Application can define. A Portal Application defines its own configuration containing any information that needs to be adapted to the environment to customize the behavior of the Portal Application Load in the environment the definition of the configuration.sap. The load of this configuration is able to merge and upgrade already existing configuration elements. The following points will be covered in this chapter: • • • • • • Create a config archive Package the config archive with the PAR Export Tool Accessing the data Config Framework API React to Configuration events Start the config mode. This is achieved by a standard administration UI invoked by but this could also be done during the load of the Portal Application by creating some default instances of the configuration. The configuration management of a Portal Application provides a model to: • Define the configuration element of an application.com/portals/ or refer to the document on meta-data from the Configuration Framework. Manage (Create/Update/Delete) the configuration objects of the Portal Application. This Framework offers a set of libraries to define and manage configuration elements of an application. • • • For more information please see: http://help. This functionality is based on the Configuration Framework delivered as one of the core services of the Portal Runtime: the Configuration Framework Services.

properties placed at the root of the config folder. allows to build the Meta Config Archive and the Config Archive transparently.Create a Config Archive Place your configuration files in folders • • Data files: <project root>/config/data/<plugin name> Meta files: <project root>/config/meta/<plugin name> Important Points • • • The plugin name should be the name of the PAR file (this is a good way to guarantee its uniqueness). Portal Runtime Technology Page 66 /113 . Use Export PAR File of the PAR IDE The deployment unit of the configuration is called the Config Archive. It contains the configurables as they were on the file system and it gathers all the config classes (meta data) in a Config Meta Archive. in this case: com. In order to build the Config Archive (and its Config Meta Archive) properly. more precisely the directory in which the configuration is stored (meta as well as data. The Export PAR functionality of the PAR IDE. The names of the directory must match properly under meta and data! From a configuration perspective.prototype) is called the Root-Plugin. the plugin name.portal.prt. This is import for ConfigRootFolder considerations (this will be detailed later). the Portal Application needs to provide some information in a specific file called configArchive.sap.config. The Config Archive will be copied in <root project>/dist/PORTAL-INF/config folder as a consequence it will be packaged automatically in the PAR file and it will be deployed when the PAR is uploaded by the PAR IDE.

prt.time ca.config.user cma.1 cma.date cma.version=6.machine Manifest CMA-Name CMA-Version CMA-Dependencies CMA-Storage CMA-Creation-Time CMA-Creation-Date CMA-Creation-User CMA-Creation-Machine Mandatory No Yes No Yes No No No No Default Project name The possible values are: • sfs • pcd Time Date User name Machine name Portal Runtime Technology Page 67 /113 .time cma.prototype.name cma.Config Archive properties file The plugin will place automatically the default value If non-mandatory values are specified as shown in the example below: ca.sap.0.storage cma.version cma.config.sap.version ca.creation.version=6.prototype ca.dependencies ca.date ca.1.portal.creation.machine Manifest CA-Name CA-Version CA-Dependencies CA-Creation-Time CA-Creation-Date CA-Creation-User CA-Creation-Machine Mandatory No Yes No No No No No Default Project name Time Date User name Machine name CMA Properties cma.prt.1.name ca.creation.user ca.dependencies cma.0.portal.creation.creation.hello cma.name=com.name=com.1 cma.creation.storage=pcd CA Properties ca.creation.creation.

xml The configuration of an application can be administered via the general Configuration UI or via the config mode of the portal application. This represents the path within the overall configuration structure of your component specific configuration.runtime.prt. com. the application itself does not need a direct dependency on the Config Component.config"/> </application-config> Note that although the Config mode will use the Config FWK component to display the configuration.sap. A Portal Component can also specify a property called the ConfigRootFolder. The virtual Portal Component will use the delegate Component to the config mode.prt.hooks"/> </application-config> Then the virtual Portal Component is created as an instance of the Config Component.runtime.sap.portal.xml: <application-config> <property name="PrivateSharingReference value="com. can be administered by using a virtual configuration component To access the Config Framework APIs.config.portal. It just need the dependency on the Configuration Framework service in order to access the APIs.sap. If no ConfigRootFolder info has been specified.system. This is done by adding the following lines in the portalapp. Portal Runtime Technology Page 68 /113 . Configuration data for a service. the Portal Application needs to specify a Private Sharing Reference in portalapp.HelloWorld"/> </component-config> <component-profile> <property name="ConfigRootFolder" value="/com.portal.Access data Modify portalapp. <component name="HelloWorld"> <component-config> <property name="ClassName" value="com.xml: <application-config> <property name="PrivateSharingReference" value="com.portal.portal. the Config Component will take the name of the application as a default (the name of the PAR file).config.prototype"/> </component-profile> </component> Virtual Components Portal Service configuration are managed by creating virtual Portal Component while giving it a right ConfigRootFolder.config.runtime.sap.sap.

portal.config.prt.getPropertyValue("value").Note that in the example below the ConfigRootFolder is set as the subfolder font of the plugin com.portal.prototype").prototype.prt. The path /com.sap.getInstance().sap.createContext()).portal.config. This is the mechanism used to have different Portal Applications sharing the same configuration.portal.sap.getConfigPlugin("/com.config.sap. • Get the Config Plugin IConfigPlugin plugin = manager.prt.getConfigurable("hello_text").prototype/font"/> </component-profile> </component> Sharing Configuration between Applications If the Root-Plugin name is not the same as the application name then the ConfigRootFolder has to match the Root-Plugin (see also).component.ConfigComponent"/> </component-config> <component-profile> <property name="ConfigRootFolder" value="/com. Use the Config Framework API • Get the Configuration Service IConfigurationService service = Configuration. • Get the Config Manager IConfigManager manager = service.config.getConfigManager(IConfigClientContext. • Get the Configurable IConfigurable configurable = plugin.prototype matches the Root-Plugin name. <component name="FontConfiguration"> <component-config> <property name="ClassName" value="com.portal.runtime. • Get the Property Value String text = configurable.sapportals. Portal Runtime Technology Page 69 /113 .runtime.

CONFIGURABLE_ADDED) { .prototype as the application name and HelloWorld which is the component name .. Of course if within a application there is a need for only ONE Config listener.prototype.Configuration Event Subscription Implement the interface IConfigEventListener If a Portal Application wants to be notified about modifications on its configuration.getType() == ConfigEvent.getType() == ConfigEvent.portal. Portal Runtime Technology Page 70 /113 . CONFIGURATION_UPDATED: The configuration has been updated (by a queued update). } List of events type: • • • • • • • CONFIGMANAGER_INITIALIZED: A configmanager has been initialized.prt.config.HelloWorld".portal. } This will uniquely identify the listener’s application throughout all the applications..prt. } else if (. public class HelloWorld extends AbstractPortalComponent implements IConfigEventListener { . CONFIGURABLE_UPDATED: A configurable has been updated. CONFIGURABLE_LOADED: A new configurable has been loaded from store. In this case we have com. } else if (event.CONFIGURABLE_UPDATED) { ...the application can just use its name. this application has to implement the interface IConfigEventListener. CONFIGURABLE_ADDED: A new configurable has been added.sap. • public void configEvent(ConfigEvent event): is called when an action occurred on the specified Configuration public void configEvent(ConfigEvent event) { if (event...sap. It is a good pattern to use a combination of the application name and the component name. CONFIGURABLE_DELETED: A configurable has been deleted.. } Add the required methods Two methods have to be implemented: • public String getConfigListenerId(): return the ID of your listener public String getConfigListenerId() { return "com..config. CONFIGMANAGER_TERMINATED: A configmanager has been terminated.

.

This is achieved as any other mode by adding /prtmode/config/ at the end of the prtroot URL.config"}.Add a listener To be notified about changes on the configuration data.addConfigEventListener(this. } catch (InitialConfigException e) { e. Page 72 /113 . the listener receives only the events that are relevant the application.portal. In that case. eventService.getConfigEventServiceInstance().getInstance(). try { // get Configuration Service IConfigurationService configurationService = Configuration.removeConfigEventListener(this). } catch (InitialConfigException e) { e.printStackTrace().getInstance(). IConfigEventService eventService = configurationService.printStackTrace(). domains). The UI display the configuration starting at the root folder of the component.sap. IConfigEventService eventService = configurationService.getConfigEventServiceInstance(). the Portal Application has to subscribe to the IconfigEventService and by specifying domains for which the application wants to receive notifications.printStackTrace(). // add listener on domain String[] domains = {"/com. The system configuration delegue will open the Config Framework UI. } catch (InvalidEntryException e) { e.printStackTrace(). Remove listener When the application is released. } Start the Config Mode The configuration of a Portal Component can be displayed by executing the component in config mode. } Elements of domains can be plugins. Specifying domains allows the Configuration Framework to perform a preliminary filtering on the events that will be sent to the listener. } catch (InvalidEntryException e) { e. configurables or config items generally speaking. it has to remove any listeners of the IConfigEventService.prt. // remove listener eventService. Configuration of Portal Service can be displayed by creating a virtual component as described above. try { // get Configuration Service IConfigurationService configurationService = Configuration. Application registers the listener in the method init(IPortalComponentInitContext context) of the Portal Component.

Do not make wrong assumptions Issue Do not make wrong assumptions Example (negative)/ Explanation catch (NamingException e) { throw new PortalRuntimeException("Registry not found:" + e).g.14 Exception Handling This chapter gives general rules and guidelines to manage exception in the Portal Applications. new PortalRuntimeException("Error in I/O. The original exception can be passed on by adding them to the message ("message: " + e). Better is to use a constructor which can take an exception as argument as well. } There are many subclasses of NamingException and the reason might be another. the original problem might be hidden.". Issue Overview Exception handling influences the quality of Java programs because: • • It ensures that the program can continue in error conditions. Coding Rules Always pass the original exception Issue Always pass the original exception on Example (negative)/ Explanation catch (IOException e) { throw new RuntimeException("Problem in I/O. this should not introduce problems. However. This chapter also describes a framework implemented by the Portal Platform to enrich the information associated to exceptions. Following example produces a NullPointerException if context is null: throw new RuntimeException("Error in "+ context. If possible this information should be constructed dynamically."). } By not doing this. e) Always include a message Issue Always include a message Example (negative)/ Explanation throw new IOException(). Page 73 /113 .getComponent()). An exception that caused the termination of a Portal Application should lead to the causing problem by giving a meaningful information. It allows the user to find the problem which caused a thread to terminate. There is always additional information which is useful to the user. e.

g.getLogger(). Do not only print the stack trace Issue Do not only print the stack trace Example (negative)/ Explanation catch (NamingException e) { e. } If stdout is not redirected. The console however might not always be there or accessible. In addition there is sometimes to much output on the console thus making it impossible to follow the output. the application was started using javaw which does not open a console."). The exception should be logged. thus hiding a problem. the exception is only visible on the console. If there is really a need for an empty exception handler there should be a good reason which should be commented and the exception should be logged. The exception caught might be a subclass of the specified one. Assuming somebody needs to find such a problem at the customer site.printStackTrace().Do not have empty exception handlers Issue Do not have empty exception handlers Example (negative)/ Explanation catch (Exception e) { // ignore } This interrupts the exception flow without doing something. The following line logs the stack trace of the exception above: PortalRuntime. Log Important Exception Issue Log important Exception Example (negative)/ Explanation catch (IOException e) { throw new RuntimeException ("Exception while reading service parameters: " + e). Nobody can find the problem caused by an exception handled this way. } In general. it might take hours to search and then one ends up in an empty exception handler. Page 74 /113 . e. " Exception while reading service parameters.severe(e. thus presenting another problem than expected. when important information is lost in an exception handler because it is not passed on it should be logged.

For example: "message: This is the specific message for this exception. This is the purpose of this key word. The functionality that analyzes errors and exceptions is a mechanism based on a Exception Catalog made of a set of Exception files containing: • • additional info for the exception.javax) and the first stack trace line starting with anything else than "java" or "javax" will be selected and displayed in the result. by proposing an Exception catalog and a tool to display this information to the users." You can also add an advise referring to this exception. filter information to retrieve the most relevant information out of the Java stack trace. Analysis error and exception logged in a specific files. Log Viewer The PRT provides a tool called LogViewer used to analyze Portal Platform Log files in order to facilitate the diagnostic of errors and problems occurring in the Portal Platform. The goal of this approach is to help Portal administrators to diagnostic in a very fast and effective way problems occurring in the Portal Platform. you only need to know the relevant stack trace line. View and download log files to a local system." Page 75 /113 . message action For this specific error you may want to display a particular message. After an exception. Just put it there. Search for specific patterns in a log file or a list of log files present in a directory. The LogViewer offers 4 main functionalities • • • • browse a file system to locate log files.Adding Extra Information The Portal Platform allows a developer to add extra information to exceptions thrown by Portal Applications. You then specify that you want to exclude them (stacktrace:java. the java exceptions are not always relevant. For the portal. Exception Files Exception Files are test files containing the following key word: Key word stacktrace Description Give the exclusion filter used to parse the stack trace. For example: "action: Please contact you system administrator.

the keyword can be omitted.sap. In that case.CustomerInfo Message: Customer ID is not valid Action: Check your application to verify that the customer ID has a valid format. Action: Check that the test configuration has been set up correctly in the test directory In that case. In that case. only the relevant information is shown.portal. the method name and the line of the caller of the CustomerInfo application that should be corrected.customer. the class name. It is what the LogViewer is doing. So only the caller should be displayed.portal. And of course the message and action will appear.sap.portal. It contains a pre-defined list of exception files either sent by the Portal or representing the standard Java Exception. the help window of the LogViewer will clearly extract from the stack trace the file. as there are no information after “stacktrace”.customer.Example: The com. the catalog will be moved to the Application Repository and Portal Applications will be allowed to enrich the catalog during PAR uploading.customer.portal.portal. Exception Catalog The exception catalog is located in the private errors folder of the LogViewer Portal Application. every Exception Files defined in the private errors folder of Portal Applications Example: PORTAL-INF/errors/com.sap.sap.testException.err containing the following information: stacktrace: Message: A test Exception occurs.InvalidCustIDException.CustomerInfo” will be kept and parsed (to display the file. the method and the line where the error occurred).sap. For the next version of the PRT (SP2).sap.testException can be described in the Exception catalog in a file called: com. In that case. the associated Exception file com.err Page 76 /113 .sap.portal. the method and the line where the error occurred). All these values will be displayed by the help window of the LogViewer. A new deployment hook will be developed and will store in the PCD. Example: The Portal Applicaion CustomerInfo PortalApplication sends an exception named com.testException.InvalidCustIDException. That means that the first stack trace line which does not start with “com. The initial error and message will also be displayed.err will use the stacktrace keyword to filter out from the stacktrace analysis any references to the CustomerInfo application stacktrace:com.customer. The error occurs in the “CutomerInfo” class but it is the call of that class which is not correct.portal. And the message and action information will also appear in the display window. It means that the first line of the stack trace will be selected as the correct one (indicating the file.

It then restarts all portal applications that have been dropped.15 Appendix PAR Flow This chapter describes the PAR Flow and explains how PAR Files are deployed to make the corresponding portal application available on all PRT nodes of a SAPJ2EE cluster. He or she can also import content to the portal using some external tools that are provided by the persistence layer. components and services) that are depending on the current application. the upload process notifies all PRT nodes in order to guarantee that all nodes will take care of the latest changes. Basically this the PAR Upload procedure stores the whole archive in the underlying persistence layer (ie: a DataBase). Local Deployment Consistency The upload process updates all PRT nodes. That step also checks and drops all entities (applications. It starts the deployment process. Each PRT node proceeds as described below: • It checks if the application is already loaded and drops the corresponding instance. PRT also checks the local deployment before loading the application into the memory. This step will update the “local deployment” of the portal application on each server. This process gets the PAR File from the repository and updates the local deployment by expanding the archive content. It means that the Upload procedure is to be done only once. In both cases the upload proceeds in two steps: • • It uploads the PAR file into the Application Repository It notifies all PRT nodes that a new Version of the application is available Uploading a PAR File to the Application Repository The PAR file is stored in the application repository.xml) all information requiring fast access at runtime. • • The main purpose of the local deployment is to improve performance at runtime by providing a fast access to classes and to portal application resources. this is why all portal applications are releasable. The Portal Administrator typically uses the “Archive Uploader” component to upload and deploy a Portal Applications to the portal. This procedure of course can’t succeed when the server is down. The local deployment avoids additional round trip to the application repository and in that sense must be considered as a cache for portal applications. Deploying a PAR File on all PRT Nodes Once the Upload to the Application Repository is completed. The update of the local deployment requires Hot Deployment capabilities. Page 77 /113 . It is important to understand that there is only one Application Repository and all PRT nodes of the SAP J2EE cluster are sharing the same content. To solve that problem. It also extracts from the deployment descriptor (portalapp.

a regular deployment is done. the old deployment folder is removed and then replaced by the new one.The check is done by comparing a “revision number” (updated during the PAR Upload). It is important to understand that the EP60 deployment logic assumes that the application doesn’t store any configuration locally. If the revision number of the local deployment differs from the repository then the local deployment is updated before loading the application. If this property is set to “5. - Page 78 /113 .0” then the deployment is backward compatible with the EP50 version of the portal. everything should be store in the repository. In that case the old folder is not removed and the deployment process simply overrides the folder with the new content. If the deploymentPolicy property is missing. Deployment Policy The local deployment is done taking care of the “DeploymentPolicy” property declared in the deployment descriptor.

If the value is true.BEGIN_UPLOAD The PAR has been loaded in the portal repository. the normal behavior is not executed. The boolean value returned by the handler will condition the execution of the normal deployment/upload process. The PAR is about to be deployed in the Portal Environment. 2.. The PRT defines two kinds of deployment event. DeploymentEventType.. The handler can execute custom code on each entry of the PAR. <application> <registry> <entry path="/runtime/deployment/com. DeploymentEventType. the rest of the process is executed.myDeploymentHook" name="myDeploymentHook" type="service” </registry> <services> <service name="myDeploymentHook"> .myPackage. 1. The handler can execute custom code on each entry of the PAR. </service> </ services > </application> This service implements the IDeploymentHook interface defining the following method: • IDeploymentHandler createHandler(IDeploymentEvent) returns a deployment handler depending on the deployment event set by the Portal Runtime. A IDeploymentHandler instance returned by the deployment hook has then the chance to implement specific code in the following method: • boolean handleEvent(IDeploymentEvent) The deployment event passed as parameter gives access to the PAR currently loaded.Deployment Hook The Portal Runtime has implemented a hook called deployment to allow custom code to be executed at some pre-defined points of the deployment process. A deployment hook is a service delivered in a Portal Application that binds some name in the portal registry deployment folder.BEGIN_DEPLOYMENT. Page 79 /113 . If the value is false.

Internationalization is the process of designing or converting an existing program so it is capable of being used in more than one locale. if the current default locale is en_US. which is simply a container for strings identifying a particular language and country. The Resource Bundle returned by this method depends on the Locale of the application and on the resource bundle name defined in the Portal Application profile. A locale defines a set of culturally-specific conventions for the display. the locale of the component is fr_CH. in order: • • • • • localization _fr_CH localization _fr localization _en_US localization _en localization Page 80 /113 .util. • Resource Bundle Name The name of the resource bundle is defined by the property ResourceBundleName of the Profile of the Portal Component.Text localization and Portal Components internationalization This section examines issues involved in designing and developing portal applications that support multi language environment. API The Portal Runtime API offers two methods defined in the PortalComponentRequest to make the Portal Application aware of localization aspects. • • • How data is passed to the Portal Application by the browser. Manipulated those data in the Java/JSP code of the Portal Component. • java. For example. java. Principle and approach The approach used by the Portal Runtime to support internationalized application is based on the choice to use the Unicode character set to take advantage of the Java’s internationalization capabilities in the following 3 areas of a Portal Application. The value returned is determined at runtime depending on multiple parameters described later on. and collation of data. resource bundle lookup will search for the following classes. How data is presented to the user.ResourceBundle getResourceBundle() Return the Resource Bundle associated with a Portal Component. format. The rules to find the resource bundle are the rules defined by the Java language. The first part of the internationalizing process is the resourcing.util. all the locale-specific strings and objects are stored in a set of ResourceBundle packaged with the PAR file. a Locale object specifies a locale. It involves isolating the locale-specific resources of the source code into modules called ResourceBundle. and the resource bundle name is localization.Locale getLocale() Return the locale object associated with a Portal Component. Those modules can then be independently added to or removed from the application. In Java. For a Portal Application.

properties by the following two properties: a.defaultcountry 6. request. This is the local attached in the user’s profile logged in the system. a.defaultlanguage b.properties and forces a Portal installation to use one and only one local. User locale . For example. ForcedRequestLanguage b. 4.classes | | +-. request. (Either the operating system. <Portal Archive> | +-. This could be used for administration components.mandatorylanguage b.PORTAL-INF | | | +-. Component locale.properties | | +-. This is defined in the prtDefault. ForcedRequestCountry 2.mandatorycountry 3.MANIFEST. or the Java virtual machine) Resource Bundle packaging The Java implementation is excepting the resource bundles to be accessible by the Java Class loading mechanisms.my_Bundle. Portal Default locale. This is used for example for anonymous user or users without locale defined in their profiles.properties Page 81 /113 . The Java default locale defined by the system. the localization properties must be packaged in a folder of the PAR file accessible by the Java Class Loader. So. The locale of the component is specified by the following two properties and allows forcing a component to use one specific local.Locale lookup The locale lookup rule implemented by the Portal Runtime follows the order described below: 1. a. System Default locale. request. Portal Mandatory locale.META-INF +-. Request locale. Administrators to setup a portal environment use this locale.my_Bundle_fr. 5.… +-. The Request locale is defined by the browser. request.private | | +-. it could a JAR file in PORTAL-INF/private/lib or just a single file in the PORTALINF/private/classes directory.MF +-. This locale is defined in the prtDefault.

doubleByteSupport is set to false.encoding property). In this example. response.util.write(resource. The runtime. IPortalComponentResponse response) { java.getString("GREETING")).sapportals.portal.util.doubleByteSupport.*. Thus the Portal Runtime can parse the file in the correct encoding and generates the corresponding Portal Component in UTF-8 encoding encoding (or in any encoding specified in the runtime.prt. the encoding used by the Portal Runtime is the encoding defined at the servlet container level. the corresponding PAR must contain one resource bundle per supported language.component.getResourceBundle(). JSP Support When a portal application uses a JSP resource containing double byte characters. the Portal Runtime needs to understand the character set that has been used to create the file. If the property runtime. import com.*. The locale of the browser can be found by the getLocale() method of the original servlet request.ResourceBundle resource = request. import com.encoding property is also used to encode the data sent by the Portal Component and presented to the user in the browser.encoding Description Convert data sent by the browser Encoding used to convert the data received from the browser Default value true UTF-8 The data are read in a Unicode format and are then manipulated accordingly.doubleByteSupport. the data is converted by the Portal Runtime according to the following properties defined in the Portal Configuration file Name runtime.sapportals. public class HelloWorldComponent extends AbstractPortalComponent { public void doContent(IPortalComponentRequest request.ResourceBundle.Portal Component Java Code The following is a code example showing how to access to a resource bundle from a Portal Component Java code.doubleByteSupport runtime.doubleByteSupport. } Request/Response handling When a data is sent from the browser to the Portal Component for processing.portal.prt. This is done by specifying the encoding in which the page has been saved in the pageEnconding directive of the JSP file as shown in the following example: <html> <%@page pageEncoding=”shift_JIS” %> … Page 82 /113 . import java.resource.

any string could represent a security zone. The goal of this feature is to control the access to the following Portal Objects. From a PRT perspective there is no restriction. • • Portal Components started using the prtroot URL. The administrator of the Portal Environment has to associate the principal of the system to the zones by creating ACLs defining the permission needed to access to a specific zone. Page 83 /113 . ConfigComponent • Safety Level : A security level in a zone.sap.portal.runtime Description Zone containing all PRT system components like ErrorComponent. on which ACLs are attached and checked at runtime when accessing to the Portal Object belonging to a zone. Technically the zone is a string defined in the portal application descriptor. Examples: Security Zone com. But form an administration perspective it is necessary to normalize the way portal component use this concept. The zone defines a logical catalog containing a set of Portal Objects. The Portal application developer doesn’t have to any knowledge of the name of the roles or of the name of the users that will be present in the Portal environment in which the Portal Application will be installed. It relies on two concepts: • Security Zone : A catalog containing a set of Portal Components and Portal Services. Examples: Safety Level HIGH_SAFETY Description Administrator rights are required to access objects belonging to this zone Security Zone The security zone provides during the development phase. Portal Services accessed as WEB Services by the soap connection.Permission model for Portal Components and Portal WEB Services This chapter explains the model implemented in the Portal Runtime to control Permission on Components. It allows to group objects belonging to a zone into different categories. a way to abstract the security level that a portal component or a Portal Service will require at runtime.

The Portal Runtime recommendation is to use the following values: Safety Level HIGH_SAFETY Description Administrator rights are required to access to a zone. It could be any String. <component-config> … <property name="SecurityZone" value="com.portal/high_safety"/> … </component-config> Example of portalpp. a security exception will be returned by the Portal Runtime.wsdl"> </property> </service-config> . e. content_admin for portal applications User needs to be authenticated.sap. This mechanism helps Portal administrators to organize and classify objects belonging to a zone. The check is performed by the application repository by testing if the current user has execute permission for that “security zone”. If the user has not enough permissions. This zone is defined in the Portal Application descriptor by the property SecurityZone. Example of portalapp..xml containing the definition of a zone for a Portal WEB Service. the zones are created if they do not exist. <property name="SecurityZone" value="com.g. <service-config> …. Each of these safety levels can then be assigned to different permissions by the administrators of the system.test.TestBO/medium_safety"> </property> <property name="WebEnable" value="true"> </property> <property name="WSDL" value="TestBO. e. the Portal Runtime checks if the current user has the permissions required to access to the zone the Portal Object belongs to. Page 84 /113 . Anonymous access is allowed MEDIUM_SAFETY LOW_SAFETY NO_SAFETY Implementation During the load of the Portal Application archive in the system. The PRT doesn’t make any assumptions on the value representing a safety level. has to be member of the system_admin role User has to have certain roles in the system to enter the zone. g.sap. Entries corresponding to the Portal Objects are then created into the zone.Safety level Within a zone. developers can define different safety levels. <services> …. to enter the zone.xml containing the definition of a zone for a Portal Component. When accessing a Portal Object (Portal Component or Portal Service).

ume com.sap. the portal application name. is optional. this is not necessary and only increases complexity. Page 85 /113 . This allows the administrator to configure the permissions for one portal application separately.sap.portal com.spa. It is the full name of the application the security zone is defined for. In most cases.Recommendations The naming convention for the security zones is the following: {Namespace of business application}/{safety level}/{portal application (optional)} The namespace of the business application is defined as follows: Business Application Portal applications User Management KM Namespace com.km The third part of the name.

Each of the Portal Objects are accessed on different occasions summarized by the following table: Object Application Purpose Applications are referenced by other applications to indicate class loader dependencies in the deployment descriptor file (portalapp. PrivateSharingReference = ApplicationName ServicesReference = ApplicationName getResource(applicationName. Page 86 /113 .<name>.. <ApplicationName> == <ApplicationAlias> Component can have alias by using the alias of <ApplicationName>. Components are referenced by other components using the getComponentContext of the PortalComponentRequest object of the PRT API.xml).<name> is not a valid service name. Examples CharingReference = ApplicationName. using the alias of the application name is not accepted.<name> == <ApplicationAlias>. then the alias can replace without any limitation the name of the application.) Application Service getService(ServiceName) Service Component irj/servlet/prt/soap/ServiceName getComponentContext(ComponentName) in the URL. In that case. <ApplicationName>. The ServiceName or the ComponentName is defined by prefixing the name of the component or a service defined in the portal application descriptor with the name of the application <ApplicationName >. the application. The ApplicationName is defined by the name of the file containing the application. Components are referenced in the URL to be executed and rendered. In the case of a Service. For example <ApplicationAlias>. Services are referenced by components or services using the getService() API of the PRT.<name> == <ServiceAlias>. For example. the name of the service can be replaced by the service alias. Application are referenced by either componts or services to access to a resource packaged in the PAR file of the application by calling one of the different getResource() methods of the API. Component irj/servlet/prt/portal/prtroot/ComponentName Name The following rules apply for naming objects in the Portal Runtime.<name> Alias The Portal Runtime offers also a concept of alias that allows for compatibility reason to define alternate name for Portal objects.Portal Object Name and Alias The goal of this chapter is to focus on how to identify and access to the objects manipulated by the Portal Runtime. The following rule apply to declare an alias on Portal objects. . Services are referenced in a URL to access WEB services using the soap connection. For example. • • • Application can have alias. For example Service can have an alias.

<components> <component name="myComponent" > The following name will be valid and recognized by the Portal: • • • myApplication. Page 87 /113 .service" > . myApplication.myComponent..myService.. myAlias.Example If the myApplication.par defines the following entries: <application alias="myAlias"> <services> <service name="myService" alias="alias. myApplication or myAlias for the application myApplication.myComponent for the component defined myComponent.service for the service myService. alias.

Page 88 /113 .logs | +-.ear” file should look like below: Important: Please note that this structure can be change at any time.lib <== API: jar files only | | | +-.lib +-.portal | | | +-. The java code should not assume that the structure will remain the same in the next release. The PAR file content is extracted and split into 2 parts... The PRT API provides methods to abstract from the real location of resources.deployment Local Deployment of Portal Applications A portal application is deployed locally either at startup or on first call (upon HTTP request).lib | | | +-.scripts +-.<myApplication> | +-.classes <== API: java classes only | +-. style sheets) that are to be accessible from the user-agent (ie: the browser).private <== Implementation of the portal application | | +-.lib <== CORE: jar files only | | | +-.system | | +-.irj | +-| | | | | | | +-| | | | | | | | | | | | | | | | | | | | | | | | | | | | portalapps | +-. <SAP J2EE>\<server>\services\servlet_jsp\work\jspTemp | +-.portalapp.< myApplication > <== a subfolder for each portal application | | | +-.Directory structure This section describes the directory structure after deployment. Local Deployment Overview The directory structure after deploying the “irj.META-INF <== deployment descriptor | +-.classes <== CORE: java classes only | | +-.portalapps <== Non-WEB resources | | | +-.images +-. That should help the developer to understand what are the resources necessary at runtime and how portal applications are deployed locally. <== WEB resources <== a subfolder for each portal application WEB-INF | +-.. scripts.lib | | | +-.xml <== deployment descriptor | | | +-.MF <== Manifest file | | +-.MANIFEST. The public part contains Web resources (images.

. Elements of a Portal Application The following illustration gives an overview over the elements of Portal Applications from a resource perspective. // // Page 89 /113 . scripts. style sheets. The private part basically contains the code (API and CORE implementation). personalization. Note: The local deployment is a copy of the original PAR file content stored in the application repository. That means for instance that a change made in the deployment descriptor deployed locally might have no impact at runtime since PRT night use the original version instead. application data.- The private part (ie: the PORTAL-INF folder) is deployed in a secure folder which is not accessible from the browser (ie: under WEB-INF). the deployment descriptor and some application-specific files. Portal Application Web Resources non-web resources web server accesses images.. . Hosting environment (PRT and more) use From an execution perspective. a Portal Application is a collection element of the two currently supported types. static data files. static html. code private code (implementation) use Referenced Portal Application's shared code Shared code (APIs) Referencing Portal Applications access to config.. private JSPs. etc. It is important to understand that the local deployment is a kind of cache. Portal Component and Portal Service that have a use relation between each other. etc.

In the PAR format these are all the definitions in jar files under PORTAL-INF/lib and all files under PORTAL-INF/classes.Application X alias=Y R Service a alias="p" Application R Application Service b Access by getService(name) provides service instances . The areas marked as "API" represents all the public resources of an application as far as related to class loading. Dependencies by SharingReference (incl. On the contrary. In the PAR format these are all the definitions in jar files under PORTAL-INF/private/lib and all files under PORTAL-INF/private/classes. ServicesReference) or PrivateSharingReference enable visibility of type definitions Class Loading in the Portal Runtime The following illustration shows the class loading relations between Portal Applications... public private default (in EP6 and EP5) by "PrivateSharingReference" default (in EP6) non-default only if "CoreAccessInAPI" policy in use API Core Class Loading Examples The following picture shows the difference between the PrivateSharingReference and the SharingReference attribute: • • When setting the reference from B to C to private. Portal Component u Application Portal Component v .. This may be JAVA class definition. A does not have any visibility on C. The area marked as "core" represents all the private resources of an application as far as class loading is concerned.0" policy in use Application Y API Using Application X API by "SharingReference" (or ServicesReference for compatibility) Arrow directions indicate propagation of type definition knowledge by class loading mechanism. not if "5. but also Resource Bundles for example.. A gets visibility to C. Page 90 /113 . when the reference from B to C is not private.

A API B API C API CORE CORE CORE SharingReference: B PrivateSharingReference: C SharingReference: C Page 91 /113 .

ChatRoom"/> </component-config> <component-profile> <property name="AuthRequirement" value="user"> <property name="personalization" value="none"/> </property> <property name="diplayHistory" value="10"> <property name="plainDescription" value="Number of messages"/> <property name="personalization" value="dialog"/> </property> <property name="diplayStyle" value="list"> <property name="type" value="select[list.exampleapp.sap.ChatService"/> </service-config> <service-profile> <property name="chatHistory" value="100"/> </service-profile> </service> </services> </application> Page 92 /113 .Deployment Descriptor example This is a deployment descriptor (portalapp.portal.sap.impl. <?xml version="1.portal.exampleapp.xml file) example of an application that contains one Portal Service and one Portal Component.impl. The Portal Service has one property in its profile and the Portal Component has two properties.0" encoding="iso-8859-1"?> <application> <application-config> <property name="releasable" value="true"/> </application-config> <components> <component name="ChatRoom"> <component-config> <property name="ClassName" value="com.history]"/> <property name="personalization" value="dialog"/> </property> </component-profile> </component> </components> <services> <service name="ChatService"> <service-config> <property name="startup" value="true"/> <property name="className" value="com.

we have the following PAR File content: hello.jar: META-INF/MANIFEST.xml PORTAL-INF/lib/chatapi.MF PORTAL-INF/portalapp.Application Example Matching the deployment descriptor above.jar The chatapi.MF com/sap/portal/exampleapp/impl/ChatService.jar should contain: META-INF/MANIFEST.class and chatcore.jar PORTAL-INF/private/lib/chatimpl.class Page 93 /113 .jpg META-INF/MANIFEST.MF com/sap/portal/exampleapp/api/IChatService.class com/sap/portal/exampleapp/impl/ChatRoom.

naming. Context context = PortalRegistry.naming. This interface is used to read and write the data. . it exists by default and has been created during the PAR Upload.lookup(“MyAppName”). Context myContext = context.Context. A sub context dedicated to the application exists by default. } How to store and retrieve config files to/from the central location? The application can store and retrieve any kind of data as soon as it can provide an implementation of the IStreamSource interface. which can be. How to get the sub context that belongs to the application? The application can get its own sub context calling the lookup method on the root context.lookup(“MyAppName”). It can creates its own hierarchy thanks to the Context. the application might want to organize it’s data using its own logic.createSubcontext method.getCentralConfigurationContext(). The Central Configuration context relies on the JNDI API plus the IStreamSource interface.. import javax. import javax. As a contrary. Page 94 /113 .. Context applicationContext = context..getCentralConfigurationContext().. used to read/write any kind of data to the repository. That interface is simply used to get an input stream to the data source.. Note that this context doesn’t have to be created by the application. Components and services can access to the context of the application the belongs to by calling the lookup method on the root context.. . This feature can be used by any portal application to store additional configuration files or resources that are to be shared by all PRT nodes on the cluster. } catch (NamingException e) { .Central Configuration Storage – How to The Central Configuration Context is a JNDI context. try { context.Context. Context context = PortalRegistry.createSubcontext("/"+appName+"/"+contextName).

The StreamSource helper class can be use by the portal application. if (logger!=null && logger. } catch (NamingException e) { .Context context = … String myConfig = “/MyAppName/data. properties.lookup(myConfig).Context context = … String myConfig = “/MyAppName/data. the application typically uses the bind or the rebind.InputStream is = source. javax.getLogger().io.properties”.util. java.Properties properties = new Properties().util.rebind(myConfig.close(). the source refers to a java property file (the application has to know it!). IStreamSource source=null . } Reading the data from the IStreamSource: In our example.properties. We can simply load the data source using the IStreamSource.properties”.Properties properties = … javax.load(is). It implements the IStreamSource interface and as constructors for common data source (Files..Storing a config file To store a config file.util.getInputStream(). try { StreamSource source = new StreamSource(properties). context. try { IStreamSource source = … java.severe(e. "Operation failed"). } Retrieving a config file: The application has to use the lookup method to get back an IStreamSource to its config file. try { source = (IStreamSource)centralConfigContext. } Page 95 /113 . source).naming. java. is. …). //important } catch (IOException e) { ILogger logger = PortalRuntime.naming.. } catch ( NamingException e ) { source=null .isActive()==true) logger. java.getInputStream method.

SAP J2EE integration and interaction
The Portal Runtime supports two types of interaction with object defined and executed in the SAP J2EE environment.

Executing a Servlet as a Portal Component.
Any servlet can be packaged and executed as a Portal Component by packaging the servlet objects in a PAR file as shown in the example below: 1. The ServletTest class defines as shown below a standard servlet.
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServlet; public class ServletTest extends HttpServlet { protected void doGet(HttpServletRequest req, HttpServletResponse resp) try { resp.getWriter ().write ("I am a servlet "); } catch (Exception e) { } }

{

2. The PAR file should declared the Servlet object as a component of type servlet.
<components> <component name="ServletTest" > <component-config> <property name="ClassName" value="com.sapportals.portal.prt.component.ServletTest"/> <property name="ComponentType" value="servlet"/> </component-config> </component>

3. The Servlet object should be packaged in the PAR.
<Portal Archive> | +-- META-INF +-- MANIFEST.MF +-- … +-- PORTAL-INF | | | +-- private | | +-- lib | | +-- servletTest.jar

Accessing to the Portal Service from a J2EE object.
Under construction

Page 96 /113

Portal Content Abstraction
The Portal Content Abstraction is an API that provides to PRT the ability to start and render any kind of “portal objects”. The simplest portal object that can be started is of course the portal component, but PRT doesn’t make any assumption on the object type and PRT knows nothing about the source of the object and about its implementation. The benefit of this content abstraction is quite clear. PRT does not depend at all on the structure of the content itself. The concept of Roles, Worksets, iViews, Pages, Templates or whatever has no impact on the portal runtime.

JNDI Basis
The API used to achieve this abstraction is based on the JNDI API. This approach assures to benefit from JNDI defined operations and to adhere to this existing standard. This allows to keep the API thin. All metadata regarding authentication (and more) are passed using standard JNDI properties.

JNDI Service Providers
Any portal application that want to play the game will have to register its own JNDI Service provider under a name space (the scheme). This JNDI provider does not just serve the PRT, but everything running in and (potentially) next to the PRT. The contract between the content provider and PRT is the following: The JNDI provider must be able to provide objects implementing the IPropertyContentProvider and IPropertyContent interfaces. The IPropertyContent implementation must provide at least the CodeLink property. This property is used to get the corresponding PAR File (and therefore the implementation) from the application repository

For further detail concerning JNDI Providers please have a look to: PRTJndiSupport page 42.

Starting Portal Objects
When PRT receives an HTTP request, the prtroot URL parameter specifies the unique name of the object that is to be started. This name here is a JNDI name and the syntax used is not PRT-Specific. To get the object PRT simply calls the lookup method on an Initial JNDI Context.
Object o = null ; try { o = initialContext.lookup(prtroot); } catch ( Exception e ) { } if ( o!=null && o instanceof IPropertyContentProvider ) { provider = (IPropertyContentProvider)o; } else { throw new PortalRuntimeException("Portal object not found: "+prtroot ); }

As shown in the code above, PRT checks if the object implements the IPropertyContentProvider interface. That interface is the entry point providing all information that PRT needs to find the portal archive, the portal application and finally the implementation class that will be responsible of the rendering.

Page 97 /113

Portal Runtime Help Mode
The objective of this chapter is to describe how the default Help Mode is implemented in the PRT. The Help mode allows a content developer to ship help texts in a PAR and to render a Portal Component in the help mode by displaying this help text. The Portal Runtime supports 4 kinds of help text sources: • • Help Text is stored in the PAR file of the component that is rendered in help mode. The structure is totally free and should only respect the public/private rules of the PAR file structure. Help Text is stored in the PAR file according to a pre-defined structure that supports localization of the texts. The help texts must be stored in the public folder named help. When retrieving the text files, the Portal Runtime will except this text file to be located in a subfolder corresponding to the language of the user. Help text is accessed with an external URL. In that case, the help can be displayed in a separate frame. This behavior is defined by another property of the Portal Component called HelpIsolationMode. Help text is retrieved from another Portal Application. It allows the packaging of the help texts in different PARs. This approach does not support text localization.

• •

This configuration is done by using the two following properties. • • HelpURL HelpName Description gives the location of the help text to display when the Portal Runtime renders a Portal Component in the Help Mode. Many formats are supported. HelpName Gives the name of the help text file that needs to be located in a subfolder of the help public folder of the PAR. Examples docs/help.html docs/myhelp/index.html http://www.sap.com/help/ip.html /com.sap.par.help.default/docs/index.html Index.html

Property Name HelpURL

Page 98 /113

To use this feature.html located in the following directory: help/{user_language}/index.default/docs/index.yahoo. the Portal Component can decide to display the content of this external web site in a separate frame. the help text is shipped in a separate PAR. if a language specific version is not found.The Portal Runtime will look first to the HelpName property and then will inspect the value of the HelpURL property. the Portal Component should set the value of the property HelpIsolationMode to URL.html Description Access to the file index. HelpURL Portal Component property example.com Description Connect to the specified URL to get help for the Portal Component. docs/index. /com. Example http://www.sap. In that case. If none of those properties is set.html in the docs directory of the Portal Application. Access to the files named index. This format is absolutely free and does not support text localization.html where {user_language} is the language of the user accessing the component .html in the docs directory of the helpcomponent Portal Application.html HelpName Portal Component property behavior Example Index. an error message is displayed. This is the typical scenario where the help text is shipped in the PAR of the Portal Component. This is the case when the help texts are stored in an external web site.portal. In that case. The two following tables show examples of different values of those two properties.html Access to the file named index. Page 99 /113 . it uses the top level file without any language code.helpcomponent.

Portal Runtime Test Mode The objective of this chapter is to describe how the Test Mode is implemented in the PRT. Format the output of the test to HTML or XML format. public class MyAbstractPortalComponent extends AbstractPortalComponent implements ITestable { public String getTestName () { return "MyAbstractPortalComponent". String msgId) logs a message in the output of the Portal Component assert (boolean condition. } } Each test methods invoked by the Test Mode execution. Invokes every test methods defined in the Portal Component. String msgId) stops the execution of the test when the test condition fails by outputting a message in the test output. are written against the following pattern: public void testXXX (IPortalComponentRequest aRequest. IPortalComponentTestResponse aResponse). String msgLog. Rendering a Portal Component in test mode will perform the following operations: • • • Checks if the Portal Component provides support for this mode. The Portal Component is invoked in test mode by using the following URL: • /irj/servlet/prt/portal/prtroot/<MyComponent>/prtmode/testComponents/testRendering/html Page 100 /113 . A Portal Component provides support for the test mode by implementing the ITestable interface defined in the PRT API. The IPortalComponentTestResponse is an IPortalComponentResponse enriched with the following test methods • • log(String mgLog.

SimpleFileLogger" = "WARNING"> = "logs/workplace.MANIFEST.ConsoleLogger" = "SEVERE" Page 101 /113 . By default those methods return an ILogger object.sapportals.prt.logger.prt. The following example shows a part of the logger.logger. • Administrator view.portal. Each Portal Application can define its own logger by packaging a logger configuration file in its PAR as described in the following example: <Portal Archive> | +-. the Portal Runtime offers a way to define and return another interface.Logger configuration Every logger accessed by the Portal Logging API are defined in the following files: • • Logger. It contains Internal Portal Runtime loggers like the default logger. • Application Developer view.xml | | +-.portal.sapportals. a Java interface. <Logger name loggerInterface isActive pattern <LoggerClass className level <param filename append limit </param> </LoggerClass> <LoggerClass className level > </LoggerClass> </logger> = = = = "default_logger" "com. Every loggers of this list are following an implementation a model proposing two views on the loggers. A logger is associated to one or many logging class defining the output channels. This separation allows the developer to be isolated from the logging infrastructure and let the administrator manage the locations of the log files without disturbing the application behavior.META-INF +-. the default activation flag and a logging level.xml in the WEB-INF\portal\system\xml directory.PORTAL-INF | | | +-.prt.MF +-. However.logger.portal. getLogger(String) on the Service Context.sapportals.ILogger" "true" "%d # %20t %15s %m #"> = "com.portalapp.logger.xml The logger configuration file gives a list of Portal Runtime loggers. A logger is defined by its name. a string formatting pattern. One a logger has been defined it is accessed through the Portal Runtime API: o o getLogger(String) on the Portal Component Request.xml used to define the default logger of the Portal Runtime.log" = "false" = "800000"> = "com. Logger.logger | | +-.xml in the PORTAL-INF/logger folder of the PAR file.… +-.

jsp"). Page 102 /113 . "jsp". public class CheckBoxComponent extends AbstractPortalComponent { public void doContent(IPortalComponentRequest request. jspResource).include(request. response.jsp").JSP Support The objective of this chapter is to describe how application developers can integrate and use JSP technology into a Portal Component.getResource("JSPValidation". Programmatic way: any Portal Component can access any JSP brought with its PAR file or that belongs to another Portal Component. The second example shows how to access to JSP files belonging to another Portal Application. "/jsp/include/foo. "jsp/checkresult.include(request. } In that case. the PRT will find a JSP called foo under the directory jsp in the component JSPValidation.jsp"). Declaring JSP as Portal Component Two properties in the profile of the Portal Component indicate that a JSP needs to be compiled into a Portal Component. Property JSP ComponentType Value path/FileName jspnative Description Relative path to the JSP in component resource Tells the PRT that this component is based on a JSP The first access to such a component will indicate to the Portal Runtime framework to compile the JSP into a real IPortalComponent instance and then execute it. IResource jspResource = request. the PRT will find a JSP called checkresult under the directory jsp.getResource("jsp".IPortalComponentResponse response) { response. The Portal Runtime supports two ways to use JSPs in the Portal: • • Declarative way: the JSP lives in the portal as a component on it's own.write("calling pagelet checkresult. response. jspResource).IPortalComponentResponse response) { response.write("calling pagelet checkresult. The location where to find the JSP is the property "JSP" JSP selected programmatically The JSP file is selected programmatically into the code of the Portal Component by including it as a resource in the response: The first example below shows how to access to a JSP file packaged into the caller Portal Component.jsp"). public class CheckBoxComponent extends AbstractPortalComponent { public void doContent(IPortalComponentRequest request. IResource jspResource = request. } In that case.

JSP packaging/Compilation The JSP must be located in the par file under the private section in any directory: Directory any path Description Contains the page that will be compiled into a Portal Component The JSP file is compiled when the Portal Component is accessed for the first time.jar of the JDK.portal.jar.jsp.addclasspath=C:/Java/jdk. The tools. Supported Features in the PRT Implicit Objects The JSP standard implicit objects accessible via scripting in the JSP are also accessible in a compiled Portal Component. If It's not retrieved a property "jsp.prt. the class path used by the Java compiler is build with the JARs file and class files accessible from the class loader that have been used to create the Portal Component using the JSP file.IPortalComp onentRequest javax.addclasspath" in the file "prtDefault. The structure reflects the java packages. For example a file named jsp/select/customer/default/entry.jar file which are not retrieved by the class loader.1_01/lib/tools.select.customer.java.servlet.home defines by JDK. After compilation. Objects request response pageContext component request session Description original request object portal component response the page context for this JSP page the portal component request the session object requesting client created for the Type javax. In order to compile the generated JSP pages at run-time.jsp will be compiled under the package name jsp.IPortalComp onentResponse javax. During compilation.servlet.sapportals. Class Loader consideration When accessing a JSP file.properties" can be used to define where to find the tools. PRT needs to locate the tools.default in file _sapportalsjsp_entry.prt.http.jar must be set in the class path of the WEB server environment. # # This specifies jars to add to the classpath for JSP compilation # jsp. The JSP file found is generated into a java Portal Component file and then compiled into a class file.1. By default this jar is retrieved with the system property java.ServletRequest com. the generated classes are added to the class loader of the Portal Component.portal. the Class Loading separation philosophy of Portal Runtime is preserved.servlet.sapportals.PageContext (not all functionnality are supported) com.3.HttpSession (specific implementation) Page 103 /113 .

jsp.application out config page the servlet context obtained from the servlet configuration object an object that writes into the output stream the servlet config for this JSP page the instance of this page's implementation class processing the current request.servlet.portal.ServletConfig com.lang.sapportals.IportalCompo nentContext exception the uncaught java. must be accessible by the Portal Component class name.lang. supported not supported.servlet.prt.ServletContext javax. must be accessible by the Portal Component supported supported. Support java class name. The PRT returns the Portal Component Context of the Component that is associated to the JSP pages.servlet. the JSP standard implementation is returning the servlet.Throwable Page directive The page directive accepts the following parameter: <%@page page_directive_attr_list %> page_directive_attr_list ::={language="scriptingLanguage "} {extends="className "} {import="importList "} {session="true|false "} {buffer="none|size kb "} {autoFlush="true|false "} {isThreadSafe="true|false "} {info="info_text "} {errorPage="error_url "} {isErrorPage="true|false "} {contentType="ctinfo "} {pageEncoding="peinfo "} The following table shows the actual support of the page directive in the Portal Runtime: Directive language extends import session buffer autoFlush isThreadSafe Description scripting language used in scriptlets fully qualified class name of superclass of the class to which the JSP Page is transformed java types describing the types that are available to the scripting environment indicates if the page requires participation in a Session Specifing the buffering model for the initial out JspWriter to handle content output from the page Specifing if the buffered output should be flushed automatically Indicates the level of thread safety implemented in the page.Throwable that resulted in the error page being invoked java. always multithread Page 104 /113 .JspWriter javax. javax.

/test/anot her/j1.. The following values are accepted by the Portal Runtime: [path] . ErrorPage Attribute The attribute errorPage is changed to add more flexibility for referencing a Portal Component that can handle and display an error in a Portal page.default prt:component:MyComponent. The following table shows the different supported value of the [page] value for the errorPage attribute <%@ page errorPage="[page]" autoflush="false" %> [page] ./.jsp Directory private folders private folders private folders private folders Description Redirects to the JSP relatively to the current JSP if error Redirects the given component if error Redirects the given component if error Redirects to the JSP that belongs to given component include directive/action The include directive is used to include text and/or code at JSP page translation time.jsp prt:component:MyComponent. This is used to know in which not supported supported (See Portal Runtime extension) Supported (See Portal Runtime extension) Supported Supported errorPage contentType pageEncoding Portal Runtime extension The following chapter describes the extension implemented by the Portal Runtime. directive/action <jsp:include page="[path]" /> <%@ include file="[path]" %> description content is not parsed./custom...info isErrorPage Defines an arbitrary string that is incorporated into the translated page indicate the current JSP page is intended to be the URL target of another JSP's page../errorpage.default./..jsp Directory same as current JSP Description Includes the JSP relatively to the Page 105 /113 .SubComponent prt:componentres:MyComponent... it is included at the runtime content is parsed by the JSP container Supported Supported Supported. if true the implicit variable exception is defined Defines an URL resource to which any Java Programming uncaught Exception will be forwarded Defines the character encoding for the JSP page and for the response of the JSP page Defines the character encoding for the JSP page..

The JSP file that is referencing the tag library can use the custom tag library definition property to reference the tag Library as follow: <%@ taglib uri="[uri]" prefix="custom" %> [uri] .default .default. The id here is custom./test/another/j1./../custom.html " %> Syntax <%@include file="relativeURLspec "%> The relativeURLSpec is relative to the private resource Portal Component distribution file.tld prt:taglib:custom Directory same as current JSP private folders Description takes the tag library definition file relatively to the current JSP the tag library is referenced by an identifier which must be defined in the profile of the component.tld Page 106 /113 ../custom. <%@include file="copyright...../.default prt:component:MyComponent.. at translation time. Directory private folders private folders private folders private folders Description includes the jsp relatively to the current JSP includes the given component includes the given component Includes the JSP that belongs to given component Tag lib packaging All Java Server Pages that are compiled into a Portal Component can use custom tags lib by following the rules described below: The class file that implements the tag lib definition must be packaged in the lib or classes directory of the Portal Component PAR file.current JSP (belongs to the current component) prt:componentres:MyComponent.jsp Examples The following example requests the inclusion. of a copy-right file. The file may have elements which will be processed too./ test/another/j1. the tag library must be defined in the profile of the component. [path] ..jsp prt:component:MyComponent. Profile none custom=/taglib/custom. If the JSP page is include in a component as a resource.SubCompo nent prt:componentres:MyComponent.jsp private folders Includes the JSP that belongs to given component The include action is used for the inclusion of static and dynamic resources in the same context as the current page.

the beans instance is stored in the context of the component that is using the JSP page that contains the useBean directive. • page . References to objects with request scope are stored in the request object.Objects with session scope are accessible from pages processing requests that are in the same session as the one in which they were created. References to objects with page scope are stored in the pageContext object. However the name spacing associated to the application scope is modified and is associated to the context of the Portal Component like in the example below: <jsp:useBean id="foo" scope="page" class="beans. This accessibility is achieved by packaging the beans into the lib or classes directory of the PAR file. The jsp:useBean action associates an instance of a Java programming language object defined within a given scope and available with a given id with a newly declared scripting variable of the same id. The JSP semantics is respected when translating a JSP page to a Portal Component. References to objects with session scope are stored in the PortalComponentSession object associated with the page activation.Using the taglib provided by Portal Services All Java Server Pages that are compiled into a Portal Component can use tags libraries provided by Portal service by following the rules described below: The Tag Lib Definition file must be referenced into the Portal Component Profile as follow: Property tlhtmlb Value /SERVICE/htmlb/taglib/htmlb.Objects with page scope are accessible only within the page where they are created.Objects with application scope are accessible from pages processing requests that are in the same application as the one in which they were created.checkbox. Passing a Java beans to the JSP page can be achieved by storing the beans into the request. Page 107 /113 . • application . References to objects with application scope are stored in the component context associated of the Portal Component that activates the page.CheckTest" /> When using the application scope. • request . • session . The basic semantic tries to find an existing object using id and scope . If the object is not found it will attempt to create the object using the other attributes. its exact semantics depends on the attributes given.Objects with request scope are accessible from pages processing the same request where they were created.tld The JSP file that is referencing the tag library can use the custom tag library definition property to reference the tag Library as follow: <%@ taglib uri="prt:taglib:tlhtmlb" prefix="hbj" %> Java Beans Java Beans referenced in JSP must be accessible at compilation time and at execution time. All references to the object shall be released when the runtime environment reclaims the PortalComponentContext. <jsp:useBean id="name "scope="page|request|session|application" typeSpec > body </jsp:useBean> The jsp:useBean action is quite flexible.

<% logger.createRequestEventData(). %> <!-.Gets all logger names from admin logger service --> <FORM type=POST ACTION= <%= componentRequest. Those events are then generated in the content of the Portal Component and the methods to handle the events have to be written in the Portal Component. IPortalRequestEvent loEvent = componentRequest.Handling Request Events Request Event must be generated by the standard Portal Component API method used to create event.createRequestEvent("oneEvent". loEvent)%> > <br/> Page 108 /113 .data).getNode().createComponentURL(componentRequest.setComponentRequest(componentRequest). IPortalRequestEventData data = componentRequest. Here is an example of possible use of Portal Component Evens in JSP page.

The default value is set to 100.This method returns immediately.sapportals. This API is only available from the core (package com.properties contains a special entry to configure the rendering thread pool size.core.MyClass"/> </component-config> <component-profile> <property name="timeout" value="2000"/> </component-profile> </component> </components> … It is also possible to supply a timeout value in the AsyncPortalComponentResponse constructor : Page 109 /113 .portal. The entry is async.size).portal. in that case the component won’t be rendered and a timeout message can be displayed.size and is also set to 100 by default. (async. Example of a component declaring a timeout of 2 seconds in its portalapp.pool.pool. A component can use a special asynchronous response that provides some methods to include nodes asynchronously (asyncInclude method in interface IAsyncPortalComponentResponse). Thus a method to wait for the end of all the nodes rendering has been implemented in the asynchronous portal component response (method waitForAllIncludesDone ()) The component can be notified (IAsyncResponseListener) when the content for the included node is available with the status of the inclusion of the node (See AsyncIncludeStatus) Configuring the thread pool size The file prtDefault. Either the component has an obsolete cache content available: in that case this obsolete cache content will be displayed but the component will be rendered as well and the cache will be updated with the new content outside the request cycle.prt. Is there is no more threads available in the timer thread pool.response.properties (10000ms).response. Either the component has no cache content. in that case this cache will be used and the component won’t be rendered.Asynchronous Response API PRT provides an internal API to make the programming of gluer components more powerful.xml … <components> <component name="MyComponent"> <component-config> <property name="ClassName" value="com. If the thread pool has no more threads available then the rendering will be done in the current thread.timer.async). Another entry also specifies the timeout thread pool size (it should roughly corresponds to the rendering thread pool size). Configuring the timeout The default timeout value for component is also defined in the prtDefault. This API provides two features: Multithreaded rendering to speed up the rendering (managed by a thread pool) Timeout for components. This value can be customized for each component in the profile using the property timeout. the timeout feature is disabled for the component .sapportals. if the component takes too long to render (given a timeout value) 3 scenarios are possible: Either a valid cache content is available for the component.

this) resp.waitForAllIncludesDone (). … resp. node1. node 2 has no cache content and has enough time to finish its rendering node 3 has some valid cache content (does not need to rendered) public void doContent (IPortalComponentRequest req. node2.public AsyncPortalComponentResponse (IPortalComponentRequest request. IPortalComponentResponse r) { IAsyncPortalComponentResponse resp= new AsyncPortalComponentResponse (req. Below a simple example : A component includes 3 nodes asynchronously and writes the content to the original response.asyncInclude (request.writeToParentResponse () } Page 110 /113 . node 1 takes too long to render (timeout case) and has an obsolete cache. node3. this) resp. // Simply writes all the content to the parent response resp.asyncInclude (request. r).asyncInclude (request. IPortalComponentResponse parent. this) resp. long timeout) If this constructor is used the timeout cannot exceed this value even if the component has defined a longer timeout in its profile.

asyncInclude (node1) Check for Node1 Cache Content: Not up to date. resp) { getDatabaseValues ().waitUntilAllIncludesDone () doContent (req. launch a rendering thread resp. launch a rendering thread resp.asyncInclude (node2) Check for Node2 Cache Content: Not available. return cache content resp. } Thread 1 Thread 2 Regular Request cycle timeout node1 Returns to browser timeout node2 Node1 : Returns old CacheContent waitUntilAllIncludesDone () returns : Content is available for node1. resp) { getContent ().asyncInclude (node3) Check for Node3 Cache Content: available and valid.Here is a schema that shows how the rendering is done throw the time: Time Main thread resp. } doContent (req. node2 and node3 Node2 : do nothing because the rendering is already finished Outside Request cycle Updated cache Content for node 1 Page 111 /113 .

0 Directory structure E Exception Handling Exception Catalog Exception Files 73 76 75 79 24 88 16. 66 65 97 59 9 12 86 109 41 26 40 11 16 24 23 23.0 UNIX/Windows Component Component Configuration Component Type Component Component Profile Component Type ConfigRootFolder Configuration Framework Content Abstraction Content Conversion Service Core Application D Deployment Deployment Hook Hot Deployment Local Deployment Deployment Descriptor Deployment Policy EP 5. PAR Deployment PAR File EP 5.M. 92 78 56 88 31 94 42 90 56 18 56 56 57 18 102 19 18.0 PAR Flow PAR IDE PAR Upload Permissions Portal Application Portal Application archive Portal Component See Portal Object Model 77 14 56 77 53 77 83 9 See PAR File 11 58 35 98.O. 102 19. 96.properties JSP compilation Component Type L Locale Logger M Mode Component Mode Test Mode N Notification Service P P. 32 H Hook Deployment Hook Portal Hooks I InitialContext INode Internationalization IPortalComponent IService IServiceContext IStreamSource J JCO Client Service JNDI Class loading Initial Context JNDI Clients JNDI Packaging JNDI Provider Resource File JNDI Service Providers jndiprovider.0 ClassName Compatibility issues Backward compatibility EP 5.Index A AbstractPortalComponent Alias API Asynchronous Response API Component Event API Dispatcher API Event API Portal Runtime API Application Configuration Application Dependencies Application Life Cycle Application Repository C Cache Central Configuration Storage Class loading Class Loading EP 5. 100 81 101 61 42 43 43 43 44 42 43 102 103 102 43 34 80 11 12 12 94 79 37 Page 112 /113 .

jar U Upload URL parameter prtroot W WEB Services WSDL 46 47 77 97 75 103 83 9 83 22 22 96 16 48 Page 113 /113 . 21 portalapp.xml See Deployment Descriptor PORTAL-INF 14 PrivateSharingReference 17 Property ClassLoaderPolicy 56 ClassName 18 ComponentType 102 DeploymentPolicy 56 PrivateSharingReference 17 SharingReference 16 PRT bridge 9 prtroot 97 R Request Cycle Resource Bundle Resources Non-Web Resources Web Resources revision number RFC Engine 34 80 14 14 78 63 S Safety Level SAP J2EE Security Zone Service Service Configuration Service Profile Servlet Component Type SharingReference SOAP T Tool LogViewer tools.Portal Object Model 34 Portal Registry 30 Portal Service 12.

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->