com.bea.portal.appflow.processor
Class AbstractPortalPersonalizationProcessor

java.lang.Object
  |
  +--com.bea.portal.appflow.processor.AbstractPortalProcessor
        |
        +--com.bea.portal.appflow.processor.AbstractPortalPersonalizationProcessor

All Implemented Interfaces:

com.bea.p13n.appflow.webflow.InputProcessor

Direct Known Subclasses:

LogoutProcessor

public abstract class AbstractPortalPersonalizationProcessor

extends AbstractPortalProcessor

AbtractPortalPersonalization is a generic processor (input processor) used to assist processors that wish to mutate the PortalPersonalization.

Constructor Summary

AbstractPortalPersonalizationProcessor()
Default constructor (called by webflow) - session sensitive as it calls super(true).

Method Summary

static MutablePortletPersonalization	getCurrentPortletPersonalization(PortalRequest portalRequest, MutablePortalPersonalization portalP13n) Retrieve an instance of the current MutablePortletPersonalization.
static MutablePortalPersonalization	getMutablePortalPersonalization(PortalRequest portalRequest) Return an instance of the Mutable Portal Personalization.
abstract Object	process(HttpServletRequest request, HttpServletResponse response, PortalRequest portalRequest, MutablePortalPersonalization portalPersonalization, Object requestContext) Processors extending this class must provide an implementation for this method.
Object	process(HttpServletRequest request, HttpServletResponse response, PortalRequest portalRequest, Object requestContext) Process method called on by webflow.
static void	setMutablePortalPersonalization(PortalRequest portalRequest, MutablePortalPersonalization portalP13n) Persist the PortalPersonalization into the database.

Methods inherited from class com.bea.portal.appflow.processor.AbstractPortalProcessor

getCurrentPortletState, process

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPortalPersonalizationProcessor

public AbstractPortalPersonalizationProcessor()

Default constructor (called by webflow) - session sensitive as it calls super(true).

Method Detail

process

public Object process(HttpServletRequest request,
                      HttpServletResponse response,
                      PortalRequest portalRequest,
                      Object requestContext)
               throws com.bea.p13n.appflow.exception.ProcessingException

Process method called on by webflow. Don't override this method. This in turn will call

     public abstract Object process(HttpServletRequest request,
                              HttpServletResponse response,
                              PortalRequest portalRequest,
                              MutablePortalPersonalization portalPersonalization,
                              Object requestContext)
 

Specified by:

process in class AbstractPortalProcessor

Returns:

return the results of the above subclasses process method.

Throws:

com.bea.p13n.appflow.exception.ProcessingException - as the subclasses process method can throw it.

process

public abstract Object process(HttpServletRequest request,
                               HttpServletResponse response,
                               PortalRequest portalRequest,
                               MutablePortalPersonalization portalPersonalization,
                               Object requestContext)
                        throws com.bea.p13n.appflow.exception.ProcessingException

Processors extending this class must provide an implementation for this method.

Throws:

com.bea.p13n.appflow.exception.ProcessingException - per calling implementing subclass

getMutablePortalPersonalization

public static MutablePortalPersonalization getMutablePortalPersonalization(PortalRequest portalRequest)
                                                                    throws com.bea.p13n.appflow.exception.ProcessingException

Return an instance of the Mutable Portal Personalization. Anonymous users will get a ProcessingException if calling this method.

Throws:

com.bea.p13n.appflow.exception.ProcessingException - if cannot get the profileIdentity from the PortalSession, or the could not get the MutablePortalPersonalization from the PortalManager

setMutablePortalPersonalization

public static void setMutablePortalPersonalization(PortalRequest portalRequest,
                                                   MutablePortalPersonalization portalP13n)
                                            throws com.bea.p13n.appflow.exception.ProcessingException

Persist the PortalPersonalization into the database. Anonymous users will get a ProcessingException if calling this method.

Throws:

com.bea.p13n.appflow.exception.ProcessingException - if cannot get the profileIdentity from the PortalSession, or the could not update the MutablePortalPersonalization with the PortalManager

getCurrentPortletPersonalization

public static MutablePortletPersonalization getCurrentPortletPersonalization(PortalRequest portalRequest,
                                                                             MutablePortalPersonalization portalP13n)
                                                                      throws com.bea.p13n.appflow.exception.ProcessingException

Retrieve an instance of the current MutablePortletPersonalization.

Returns:

mutable PortletPersonalization.

Throws:

com.bea.p13n.appflow.exception.ProcessingException - if cannot get the PagePersonalization from the PortalPersonalization, or the could get the PortletPersonalization from the PagePersonalization.