com.sapportals.portal.prt.component

Interface IPortalComponent

All Known Subinterfaces:

ICachablePortalComponent, ICacheDiscriminator, ICacheValidator

All Known Implementing Classes:

AbstractDynamicWizard, AbstractEditorComponent, AbstractIntegratorComponent, AbstractPCMWizard, AbstractPortalComponent, AbstractResourceComponent, AbstractStaticWizard, AbstractWizard, StandardEditDialog

public interface IPortalComponent

The IPortalComponent is the central abstraction of the Portal Component API. All Portal Components implement this interface either directly, or more commonly by extending a class that implements this interface. It defines a service method for handling client requests. This method is called for each request that the Portal builder runtime routes to an instance of Portal Component. Multiple threads may be executing within the service at any time.

Method Summary

void	destroy() Invoked when this Portal Component is discarded from memory.
void	init() Deprecated. Use #init(IPortalComponentInitContext) instead
void	service(IPortalComponentRequest aRequest, IPortalComponentResponse aResponse) Called to allow the component to respond to a request.

Method Detail

init

void init()

Deprecated. Use #init(IPortalComponentInitContext) instead

Invoked when this Portal Component is loaded for the first time in memory. The container calls the init method each time this Portal Component is loaded in memory.

destroy

void destroy()

Invoked when this Portal Component is discarded from memory. The destroy method is called each time the PRT (Portal Builder Runtime) decides to discard this component.

See Also:

init()

service

void service(IPortalComponentRequest aRequest,
             IPortalComponentResponse aResponse)
             throws PortalComponentException

Called to allow the component to respond to a request.

The service method is the central point of any interaction with a Portal Component. It processes the clients requests. An implementation of the IPortalComponent interface can have access to the request and the type of request sent by the client.

Parameters:

aRequest - the client's request.

aResponse - the server's response.

Throws:

PortalComponentException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN