com.ibm.wps.pb.wrapper
Class PortletWrapperBase

java.lang.Object
  HttpServlet
      com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet
          org.apache.jetspeed.portlet.Portlet
              org.apache.jetspeed.portlet.PortletAdapter
                  com.ibm.wps.pb.wrapper.PortletWrapperBase

All Implemented Interfaces:

PropertyListener, EventPhaseListener, ActionListener, MessageListener, PortletApplicationSettingsAttributesListener, WindowListener, PortletPageListener, PortletSessionListener

Direct Known Subclasses:

PortletWrapper

Deprecated. since 6.0.2 Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

public abstract class PortletWrapperBase
extends PortletAdapter
implements ActionListener, PropertyListener, PortletPageListener, MessageListener, PortletSessionListener, WindowListener, PortletApplicationSettingsAttributesListener, EventPhaseListener

PortletWrapperBase wraps the application portlet class for a cooperative portlet which uses the IBM portlet API. For cooperative portlets programmed using the IBM portlet API, this class must be specified using the <servlet-class> config parameter in web.xml. The application portlet class name must be specified using the c2a-application-portlet-class init param entry in web.xml. PortletWrapperBase is responsible for delegation of lifecycle/service methods on the application portlet. PortletWrapperBase is an abstract class extended by PortletWrapper. The setApplicationPortlet method needs to be implemented by the concrete class. The implementation of the method must return an instance of the application class. PortletWrapperBase and PortletWrapper can be used to extend PortletWrapper to add additional function. In particular, if the application portlet implements PortletTitleListener, it is required to extend PortletWrapper and implement PortletTitleListener in the extended class. However, the implementation of methods in PortletWrapperBase must not be modified in the extension, to avoid problems with the cooperative portlets function. For this reason, the methods in this class are marked final.

Since:

5.1.0.1

See Also:

PortletWrapper

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jetspeed.portlet.Portlet

Portlet.Mode, Portlet.ModeModifier

Constructor Summary

PortletWrapperBase()
Deprecated.

Method Summary

void	actionPerformed(ActionEvent event) Deprecated. This method is marked final as it must not be overridden
void	attributeAdded(PortletApplicationSettingsAttributeEvent event) Deprecated. This method is marked final as it must not be overridden
void	attributeAdded(PortletSettingsAttributeEvent psevent) Deprecated. This method is marked final as it must not be overridden
void	attributeRemoved(PortletApplicationSettingsAttributeEvent event) Deprecated. This method is marked final as it must not be overridden
void	attributeRemoved(PortletSettingsAttributeEvent psevent) Deprecated. This method is marked final as it must not be overridden
void	attributeReplaced(PortletApplicationSettingsAttributeEvent event) Deprecated. This method is marked final as it must not be overridden
void	attributeReplaced(PortletSettingsAttributeEvent psevent) Deprecated. This method is marked final as it must not be overridden
void	beginEventPhase(PortletRequest portletRequest) Deprecated. This method is marked final as it must not be overridden
void	beginPage(PortletRequest request, PortletResponse response) Deprecated. This method is marked final as it must not be overridden
void	destroyConcrete(PortletSettings portletSettings) Deprecated. This method is marked final as it must not be overridden
void	endEventPhase(PortletRequest portletRequest) Deprecated. This method is marked final as it must not be overridden
void	endPage(PortletRequest request, PortletResponse response) Deprecated. This method is marked final as it must not be overridden
protected Portlet	getApplicationPortlet() Deprecated. This method is marked final as it must not be overridden
long	getLastModified(PortletRequest request) Deprecated. This method is marked final as it must not be overridden
void	init(PortletConfig portletConfig) Deprecated. This method is marked final as it must not be overridden
void	initConcrete(PortletSettings portletSettings) Deprecated. This method is marked final as it must not be overridden
abstract java.lang.Object	instantiateApplicationPortlet(java.lang.String applicationPortletClassName) Deprecated. This method must be overridden in the derived class.
void	login(PortletRequest request) Deprecated. This method is marked final as it must not be overridden
void	logout(PortletSession session) Deprecated. This method is marked final as it must not be overridden
void	messageReceived(MessageEvent event) Deprecated. This method is marked final as it must not be overridden
void	service(PortletRequest request, PortletResponse response) Deprecated. This method is marked final as it must not be overridden
void	setProperties(PortletRequest request, PropertyValue[] propValues) Deprecated. This method is marked final as it must not be overridden
void	windowClosed(WindowEvent event) Deprecated. This method is marked final as it must not be overridden
void	windowClosing(WindowEvent event) Deprecated. Notifies this listener that a portlet window is about to be closed.
void	windowDetached(WindowEvent event) Deprecated. Notifies this listener that a portlet window has been detached.
void	windowMaximized(WindowEvent event) Deprecated. This method is marked final as it must not be overridden
void	windowMinimized(WindowEvent event) Deprecated. This method is marked final as it must not be overridden
void	windowRestored(WindowEvent event) Deprecated. This method is marked final as it must not be overridden

Methods inherited from class org.apache.jetspeed.portlet.PortletAdapter

destroy, doConfigure, doEdit, doHelp, doView, getPortletConfig, getPortletLog, getVariable, removeVariable, setVariable

Methods inherited from class org.apache.jetspeed.portlet.Portlet

destroy, doGet, doPost, doPut, getId, getInitParameter, getInitParameterNames, getPortletSettings, getServletContext, getServletInfo

Methods inherited from class com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet

getSharingPolicy

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletWrapperBase

public PortletWrapperBase()

Deprecated.

Method Detail

instantiateApplicationPortlet

public abstract java.lang.Object instantiateApplicationPortlet(java.lang.String applicationPortletClassName)
                                                        throws java.lang.Exception

Deprecated.

This method must be overridden in the derived class. The implementation must instantiate and return an instance of the class identified by the parameter applicationPortletClassName.

Parameters:

applicationPortletClassName - the name of the class to be instantiated

Returns:

an instance of the class

Throws:

java.lang.Exception - if the class cannot be instantiated

getApplicationPortlet

protected final Portlet getApplicationPortlet()

Deprecated.

This method is marked final as it must not be overridden

init

public final void init(PortletConfig portletConfig)
                throws UnavailableException

Deprecated.

This method is marked final as it must not be overridden

Overrides:

init in class PortletAdapter

Parameters:

portletConfig - the portlet configuration

Throws:

UnavailableException - if an exception has occurrred that interferes with the portlet's normal initialization

initConcrete

public final void initConcrete(PortletSettings portletSettings)
                        throws UnavailableException

Deprecated.

This method is marked final as it must not be overridden

Overrides:

initConcrete in class PortletAdapter

Parameters:

portletSettings - the portlet settings

Throws:

UnavailableException - if an exception has occurrred that interferes with the portlet's normal initialization

destroyConcrete

public final void destroyConcrete(PortletSettings portletSettings)

Deprecated.

This method is marked final as it must not be overridden

Overrides:

destroyConcrete in class PortletAdapter

Parameters:

portletSettings - the portlet settings

getLastModified

public final long getLastModified(PortletRequest request)

Deprecated.

This method is marked final as it must not be overridden

Overrides:

getLastModified in class PortletAdapter

Parameters:

request - the PortletRequest object that is sent to the portlet

Returns:

a long integer specifying the time the PortletRequest object was last modified, in milliseconds since midnight, January 1, 1970 GMT, or -1 if the time is not known

service

public final void service(PortletRequest request,
                          PortletResponse response)
                   throws PortletException,
                          java.io.IOException

Deprecated.

This method is marked final as it must not be overridden

Overrides:

service in class PortletAdapter

Parameters:

request - the portlet request

response - the portlet response

Throws:

PortletException - if the portlet has trouble fulfilling the rendering request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletAdapter.doView(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse), PortletAdapter.doEdit(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse), PortletAdapter.doHelp(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse), PortletAdapter.doConfigure(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse)

beginPage

public final void beginPage(PortletRequest request,
                            PortletResponse response)
                     throws PortletException,
                            java.io.IOException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

beginPage in interface PortletPageListener

Parameters:

request - the portlet request

response - the portlet response

Throws:

PortletException - if the portlet has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

beginEventPhase

public final void beginEventPhase(PortletRequest portletRequest)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

beginEventPhase in interface EventPhaseListener

Parameters:

portletRequest - the PortletRequest object that is sent to the portlet

endEventPhase

public final void endEventPhase(PortletRequest portletRequest)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

endEventPhase in interface EventPhaseListener

Parameters:

portletRequest - the PortletRequest object that is sent to the portlet

endPage

public final void endPage(PortletRequest request,
                          PortletResponse response)
                   throws PortletException,
                          java.io.IOException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

endPage in interface PortletPageListener

Parameters:

request - the portlet request

response - the portlet response

Throws:

PortletException - if the portlet has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

setProperties

public final void setProperties(PortletRequest request,
                                PropertyValue[] propValues)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

setProperties in interface PropertyListener

Parameters:

request - the PortletRequest object for the current request

propValues - an array of PropertyValue objects containing the the changed properties and their values.

See Also:

PropertyBrokerService, changedProperties, EventPhaseListener

actionPerformed

public final void actionPerformed(ActionEvent event)
                           throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - the action event

Throws:

PortletException - if the listener has trouble fulfilling the request

messageReceived

public final void messageReceived(MessageEvent event)
                           throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

messageReceived in interface MessageListener

Parameters:

event - the message event

Throws:

PortletException - if the listener has trouble fulfilling the request

login

public final void login(PortletRequest request)
                 throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

login in interface PortletSessionListener

Overrides:

login in class PortletAdapter

Parameters:

request - the portlet request

Throws:

PortletException - if the portlet has trouble fulfilling the login request

logout

public final void logout(PortletSession session)
                  throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

logout in interface PortletSessionListener

Overrides:

logout in class PortletAdapter

Parameters:

session - the portlet session

Throws:

PortletException - if the portlet has trouble fulfilling the logout

windowClosed

public final void windowClosed(WindowEvent event)
                        throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

windowClosed in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

windowClosing

public final void windowClosing(WindowEvent event)
                         throws PortletException

Deprecated.

Description copied from interface: WindowListener

Notifies this listener that a portlet window is about to be closed.

Specified by:

windowClosing in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

windowDetached

public final void windowDetached(WindowEvent event)
                          throws PortletException

Deprecated.

Description copied from interface: WindowListener

Notifies this listener that a portlet window has been detached.

Specified by:

windowDetached in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

windowMaximized

public final void windowMaximized(WindowEvent event)
                           throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

windowMaximized in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

windowMinimized

public final void windowMinimized(WindowEvent event)
                           throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

windowMinimized in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

windowRestored

public final void windowRestored(WindowEvent event)
                          throws PortletException

Deprecated.

This method is marked final as it must not be overridden

Specified by:

windowRestored in interface WindowListener

Parameters:

event - the window event

Throws:

PortletException - if the listener has trouble fulfilling the request

attributeAdded

public final void attributeAdded(PortletSettingsAttributeEvent psevent)

Deprecated.

This method is marked final as it must not be overridden

attributeReplaced

public final void attributeReplaced(PortletSettingsAttributeEvent psevent)

Deprecated.

This method is marked final as it must not be overridden

attributeRemoved

public final void attributeRemoved(PortletSettingsAttributeEvent psevent)

Deprecated.

This method is marked final as it must not be overridden

attributeAdded

public final void attributeAdded(PortletApplicationSettingsAttributeEvent event)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

attributeAdded in interface PortletApplicationSettingsAttributesListener

Parameters:

event - the attribute event

attributeRemoved

public final void attributeRemoved(PortletApplicationSettingsAttributeEvent event)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

attributeRemoved in interface PortletApplicationSettingsAttributesListener

Parameters:

event - the attribute event

attributeReplaced

public final void attributeReplaced(PortletApplicationSettingsAttributeEvent event)

Deprecated.

This method is marked final as it must not be overridden

Specified by:

attributeReplaced in interface PortletApplicationSettingsAttributesListener

Parameters:

event - the attribute event