Entering content frame

Component documentation Portal Runtime API Locate the document in its SAP Library structure

Purpose

The Portal Runtime API is the central part of the PRT. It contains Java interfaces that define the contract between the portal objects (applications, components, services) and the runtime environment.

API Element

Interface

Description

Portal Component

com.sapportals.portal.prt.
component.IPortalComponent

com.sapportals.portal.prt.
component.AbstractPortalComponent

com.sapportals.portal.prt.
component.IPortalComponentInit

The IPortalComponent is the central abstraction of the Portal Runtime API. It defines a portal component included in a portal application

Portal Service

com.sapportals.portal.prt.
service.IService

A portal service included in a portal application

Profile

com.sapportals.portal.prt.
component.IPortalComponentProfile

com.sapportals.portal.prt.
service.IServiceProfile

A set of properties attached to a component or a service

Configuration

com.sapportals.portal.prt.
component.IPortalComponentConfig

com.sapportals.portal.prt.
service.IServiceConfig

A component or service configuration

Request

com.sapportals.portal.prt.
component.IPortalComponentRequest

Component’s view on the request during runtime

Response

com.sapportals.portal.prt.
component.IPortalComponentResponse

Encapsulation of the information sent to the client by a portal component

Portal Event

com.sapportals.portal.prt.
event.IPortalRequestEvent

com.sapportals.portal.prt.
event.IPortalComponentEvent

An API to receive and send events with the client’s request or between different components

Context

com.sapportals.portal.prt.
component.IPortalComponentContext

com.sapportals.portal.prt.
service.IServiceContext

A view of the context in which the PRT runs components and services

 

The Portal Runtime API is delivered in a set of five JAR files. This defines the contract between the portal application and the PRT. This is the API for building portal components and portal services, but also the API for cooperating with the infrastructure to extend it and customize it.

JAR

Description

prtapi.jar

The portal application API

prtconnection,jar

The portal connection API for developing and installing a new connection in the portal

prtdeploymentapi.jar

API for handing the format of PAR files and the deployment descriptor

prt_jspapi.jar

JSP support in PRT

prttest.jar

PRT testing framework API

 

This graphic is explained in the accompanying text

For more information, see the SAP EP Java API documentation.

 

 

Leaving content frame