com.sapportals.portal.prt.component

Class AbstractResourceComponent

java.lang.Object
  extended by com.sapportals.portal.prt.component.AbstractPortalComponent
      extended by com.sapportals.portal.prt.component.AbstractResourceComponent
All Implemented Interfaces:
IEventListenerComponent, IPortalComponent, IPortalComponentInit

public abstract class AbstractResourceComponent
extends AbstractPortalComponent

This class is the base class for all Portal Components that support AJAX events. Upon a request, it will check if the request is marked to be handled asynchronously and if so will delegate the handling of the request to the appropriate method in the implementing class.


Nested Class Summary
static class AbstractResourceComponent.AsyncEventData
          This class is used to abstract the data structure that is used to hold the event parameters.
 
Constructor Summary
AbstractResourceComponent()
           
 
Method Summary
 void init(IPortalComponentConfig config)
          This method is overridden in order to cache the annotations of the methods of this class
 void service(IPortalComponentRequest request, IPortalComponentResponse response)
          Called by the PortalSessionManager to allow the component to respond to a request.
 
Methods inherited from class com.sapportals.portal.prt.component.AbstractPortalComponent
destroy, doAbout, doAfterContent, doBeforeContent, doComponentEvent, doContent, doEdit, doHandleEditData, doHelp, doOnNodeReady, doOnNodeRemove, doOnPOMReady, doPreview, doRefresh, doRequestEvent, getCacheDiscriminant, getCachingLevel, handleEvent, hasExpired, init, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractResourceComponent

public AbstractResourceComponent()
Method Detail

init

public void init(IPortalComponentConfig config)
          throws PortalComponentException
This method is overridden in order to cache the annotations of the methods of this class

Overrides:
init in class AbstractPortalComponent
Throws:
PortalComponentException

service

public void service(IPortalComponentRequest request,
                    IPortalComponentResponse response)
             throws PortalComponentException
Description copied from class: AbstractPortalComponent
Called by the PortalSessionManager to allow the component to respond to a request. It inspects the request type of the request, and dispatch the godd method.

Specified by:
service in interface IPortalComponent
Overrides:
service in class AbstractPortalComponent
Parameters:
request - the PortalComponentRequest object that contains the client's request
response - the PortalComponentResponse object that contains 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/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice