atg.websphere.wps.portlet

Class GenericPortletService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet

org.apache.jetspeed.portlet.Portlet

atg.websphere.wps.portlet.GenericPortletService

All Implemented Interfaces:

com.ibm.websphere.servlet.cache.CacheableServlet, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, org.apache.jetspeed.portlet.event.ActionListener, org.apache.jetspeed.portlet.PortletPageListener, org.apache.jetspeed.portlet.PortletSessionListener

Direct Known Subclasses:

DispatchPortlet

public class GenericPortletService
extends org.apache.jetspeed.portlet.Portlet
implements org.apache.jetspeed.portlet.PortletPageListener, org.apache.jetspeed.portlet.event.ActionListener

Portlet implementation with support for self-configuration, naming resolution, performance profiling and logging.

Derived class should override the following methods:

• startService
• startConcreteService
• preHandleService
• handleService
• handleLogin
• handleLogout
• handleBeginPage
• handleEndPage
• handleActionPerformed
• stopConcreteService
• stopService

The portlet may be configured from servlet init parameters. specified in a web application deployment descriptor. Named init parameters are treated as properties of the servlet. Parameters prefixed with cxt: are looked up using the portlets name context.

The following example serves to demonstrate configuration of a generic servlet service:

   <servlet>
     <servlet-name>MyPortletService</servlet-name>
     <servlet-class>com.acme.portlet.MyServletService</servlet-class>
     <init-param>
       <param-name>loggingDebug</param-name>
       <param-value>false</param-value>
     </init-param>
     <init-param>
       <param-name>loggingWarning</param-name>
       <param-value>false</param-value>
     </init-param>
     <init-param>
       <param-name>loggingError</param-name>
       <param-value>true</param-value>
     </init-param>
     <init-param>
       <param-name>loggingInfo</param-name>
       <param-value>true</param-value>
     </init-param>
     <init-param>
       <param-name>MyString</param-name>
       <param-value>foobar</param-value>
     </init-param>
       <param-name>Object</param-name>
       <param-value>ctx:dynamo:/com/Acme/MyFooObject</param-value>
     </init-param>
   </servlet>
  

Derived portlets may use the lookup method to lookup objects in the portlets name context. The objects name context is accessable via the context property.

The portlet may log information using the logging facilities provided. Support for info, warning, error and debug levels are provided by the service.

If a performance monitor is enabled the portlet collects performance metrics about the handleService method.

See Also:

Serialized Form

Nested Class Summary

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

org.apache.jetspeed.portlet.Portlet.Mode, org.apache.jetspeed.portlet.Portlet.ModeModifier

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
GenericPortletService() Constructs an instanceof GenericPortletService

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent pActionEvent) Called by the portlet container to service an action
void	beginPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should service a request/response for the begining of a page
void	destroy(org.apache.jetspeed.portlet.PortletConfig pPortletConfig) Called by the portlet container to indicate to a portlet that it is being taken out of service
void	destroyConcrete(org.apache.jetspeed.portlet.PortletSettings pSettings) Called by the portlet container to indicate to a portlet that it is being taken out of service
void	endPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should service a request/response for the end of a page
javax.naming.Context	getContext() Returns property Context
long	getLastModified(org.apache.jetspeed.portlet.PortletRequest pPortletRequest) Returns the time the time of the response object was last modified.
java.lang.String	getName() Returns property Name
org.apache.jetspeed.portlet.PortletConfig	getPortletConfig() Returns property PortletConfig
org.apache.jetspeed.portlet.PortletContext	getPortletContext() Returns property PortletContext
void	handleActionPerformed(org.apache.jetspeed.portlet.event.ActionEvent pActionEvent) Called by the portlet service to service an action
void	handleBeginPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should handle a request/response for the page.
void	handleEndPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should handle a request/response for the page.
void	handleLogin(org.apache.jetspeed.portlet.PortletRequest pPortletRequest) Called by the portlet service to indicate to a portlet that a session is being created
void	handleLogout(org.apache.jetspeed.portlet.PortletSession pPortletSession) Called by the portlet service to indicate to a portlet that a session is being destroyed
void	handleService(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should handle a request/response.
void	init(org.apache.jetspeed.portlet.PortletConfig pPortletConfig) Called by the portlet container to indicate to a portlet that it is being placed into service.
void	initConcrete(org.apache.jetspeed.portlet.PortletSettings pPortletSettings) Called by the portlet container to indicate to a portlet that it is being placed into service.
boolean	isLoggingDebug() Returns property LoggingDebug
boolean	isLoggingError() Returns property LoggingError
boolean	isLoggingInfo() Returns property LoggingInfo
boolean	isLoggingWarning() Returns property LoggingWarning
void	log(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an event with the specified message and Throwable
void	logDebug(java.lang.String pMessage) Logs an debug event with the specified message
void	logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an debug event with the specified message and Throwable
void	logDebug(java.lang.Throwable pThrowable) Logs an debug event with the specified Throwable
void	logError(java.lang.String pMessage) Logs an error event with the specified message
void	logError(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an error event with the specified message and Throwable
void	logError(java.lang.Throwable pThrowable) Logs an error event with the specified Throwable
void	login(org.apache.jetspeed.portlet.PortletRequest pPortletRequest) Called by the portlet container to indicate to a portlet that a session is being created
void	logInfo(java.lang.String pMessage) Logs an info event with the specified message
void	logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an info event with the specified message and Throwable
void	logInfo(java.lang.Throwable pThrowable) Logs an info event with the specified Throwable
void	logout(org.apache.jetspeed.portlet.PortletSession pPortletSession) Called by the portlet container to indicate to a portlet that a session is being destroyed
void	logWarning(java.lang.String pMessage) Logs an warning event with the specified message
void	logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs an warning event with the specified message and Throwable
void	logWarning(java.lang.Throwable pThrowable) Logs an warning event with the specified Throwable
java.lang.Object	lookup(java.lang.String pName) Retreives the named object
void	service(org.apache.jetspeed.portlet.PortletRequest pPortletRequest, org.apache.jetspeed.portlet.PortletResponse pPortletResponse) Called by the portlet container to indicate that a portlet should service a request/response
void	setLoggingDebug(boolean pLoggingDebug) Sets property LoggingDebug
void	setLoggingError(boolean pLoggingError) Sets property LoggingError
void	setLoggingInfo(boolean pLoggingInfo) Sets property LoggingInfo
void	setLoggingWarning(boolean pLoggingWarning) Sets property LoggingWarning
void	startConcreteService(org.apache.jetspeed.portlet.PortletSettings pPortletSettings) Called by the concrete portlet after it has been initialzed.
void	startService(org.apache.jetspeed.portlet.PortletConfig pServletConfig) Called by the portlet after it has been initialzed.
void	stopConcreteService(org.apache.jetspeed.portlet.PortletSettings pPortletSettings) Called by the portlet service after it has been destroyed.
void	stopService(org.apache.jetspeed.portlet.PortletConfig pPortletConfig) Called by the portlet service after it has been destroyed.

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

destroy, doDelete, doGet, doOptions, doPost, doPut, doTrace, getInitParameter, getInitParameterNames, getLastModified, getPortletSettings, getServletConfig, getServletContext, getServletInfo, init, init, service

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

getGenericKey, getId, getSharingPolicy

Methods inherited from class javax.servlet.http.HttpServlet

doHead, service

Methods inherited from class javax.servlet.GenericServlet

getServletName, log

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

GenericPortletService

public GenericPortletService()

Constructs an instanceof GenericPortletService

Method Detail

getPortletConfig

public org.apache.jetspeed.portlet.PortletConfig getPortletConfig()

Returns property PortletConfig

Specified by:

getPortletConfig in class org.apache.jetspeed.portlet.Portlet

getName

public java.lang.String getName()

Returns property Name

getContext

public javax.naming.Context getContext()

Returns property Context

getPortletContext

public org.apache.jetspeed.portlet.PortletContext getPortletContext()

Returns property PortletContext

setLoggingInfo

public void setLoggingInfo(boolean pLoggingInfo)

Sets property LoggingInfo

isLoggingInfo

public boolean isLoggingInfo()

Returns property LoggingInfo

setLoggingWarning

public void setLoggingWarning(boolean pLoggingWarning)

Sets property LoggingWarning

isLoggingWarning

public boolean isLoggingWarning()

Returns property LoggingWarning

setLoggingError

public void setLoggingError(boolean pLoggingError)

Sets property LoggingError

isLoggingError

public boolean isLoggingError()

Returns property LoggingError

setLoggingDebug

public void setLoggingDebug(boolean pLoggingDebug)

Sets property LoggingDebug

isLoggingDebug

public boolean isLoggingDebug()

Returns property LoggingDebug

startService

public void startService(org.apache.jetspeed.portlet.PortletConfig pServletConfig)
                  throws org.apache.jetspeed.portlet.UnavailableException

Called by the portlet after it has been initialzed. Derived classes should override this method to initialize the service.

Parameters:

pPortletConfig - portlet configuration information.

Throws:

org.apache.jetspeed.portlet.UnavailableException - if an exception occurs when starting this servlet.

startConcreteService

public void startConcreteService(org.apache.jetspeed.portlet.PortletSettings pPortletSettings)
                          throws org.apache.jetspeed.portlet.UnavailableException

Called by the concrete portlet after it has been initialzed. Derived classes should override this method to initialize the service.

Parameters:

pPortletSettings - concrete portlet configuration information.

Throws:

org.apache.jetspeed.portlet.UnavailableException - if an exception occurs when starting this servlet.

init

public void init(org.apache.jetspeed.portlet.PortletConfig pPortletConfig)
          throws org.apache.jetspeed.portlet.UnavailableException

Called by the portlet container to indicate to a portlet that it is being placed into service.

Specified by:

init in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletConfig - portlet configuration information.

Throws:

org.apache.jetspeed.portlet.UnavailableException - if an exception occurs when initializing this servlet.

initConcrete

public void initConcrete(org.apache.jetspeed.portlet.PortletSettings pPortletSettings)
                  throws org.apache.jetspeed.portlet.UnavailableException

Called by the portlet container to indicate to a portlet that it is being placed into service.

Specified by:

initConcrete in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletSettings - concreate portlet configuration information.

Throws:

org.apache.jetspeed.portlet.UnavailableException - if an exception occurs when initializing this servlet.

handleActionPerformed

public void handleActionPerformed(org.apache.jetspeed.portlet.event.ActionEvent pActionEvent)

Called by the portlet service to service an action

Parameters:

pActionEvent - the action event

actionPerformed

public void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent pActionEvent)

Called by the portlet container to service an action

Specified by:

actionPerformed in interface org.apache.jetspeed.portlet.event.ActionListener

Parameters:

pActionEvent - the action event

handleService

public void handleService(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                          org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
                   throws java.io.IOException,
                          org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should handle a request/response. Derived classes should override this method to handle the servicing of a request

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

service

public void service(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                    org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
             throws java.io.IOException,
                    org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should service a request/response

Specified by:

service in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

stopService

public void stopService(org.apache.jetspeed.portlet.PortletConfig pPortletConfig)

Called by the portlet service after it has been destroyed. Derived classes should override this method to perform any cleanup.

stopConcreteService

public void stopConcreteService(org.apache.jetspeed.portlet.PortletSettings pPortletSettings)

Called by the portlet service after it has been destroyed. Derived classes should override this method to perform any cleanup.

destroy

public void destroy(org.apache.jetspeed.portlet.PortletConfig pPortletConfig)

Called by the portlet container to indicate to a portlet that it is being taken out of service

Specified by:

destroy in class org.apache.jetspeed.portlet.Portlet

destroyConcrete

public void destroyConcrete(org.apache.jetspeed.portlet.PortletSettings pSettings)

Called by the portlet container to indicate to a portlet that it is being taken out of service

Specified by:

destroyConcrete in class org.apache.jetspeed.portlet.Portlet

handleBeginPage

public void handleBeginPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                            org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
                     throws java.io.IOException,
                            org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should handle a request/response for the page. Derived classes should override this method to handle the servicing of a request

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

handleEndPage

public void handleEndPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                          org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
                   throws java.io.IOException,
                          org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should handle a request/response for the page. Derived classes should override this method to handle the servicing of a request

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

beginPage

public void beginPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                      org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
               throws java.io.IOException,
                      org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should service a request/response for the begining of a page

Specified by:

beginPage in interface org.apache.jetspeed.portlet.PortletPageListener

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

endPage

public void endPage(org.apache.jetspeed.portlet.PortletRequest pPortletRequest,
                    org.apache.jetspeed.portlet.PortletResponse pPortletResponse)
             throws java.io.IOException,
                    org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate that a portlet should service a request/response for the end of a page

Specified by:

endPage in interface org.apache.jetspeed.portlet.PortletPageListener

Parameters:

pPortletRequest - the portlet request

pPortletResponse - the portlet response

Throws:

java.io.IOException - when an i/o error occurs

org.apache.jetspeed.portlet.PortletException - when an error occurs when processing this portlet

handleLogin

public void handleLogin(org.apache.jetspeed.portlet.PortletRequest pPortletRequest)
                 throws org.apache.jetspeed.portlet.PortletException

Called by the portlet service to indicate to a portlet that a session is being created

Parameters:

pPortletRequest - the portlet request

Throws:

org.apache.jetspeed.portlet.PortletException

handleLogout

public void handleLogout(org.apache.jetspeed.portlet.PortletSession pPortletSession)
                  throws org.apache.jetspeed.portlet.PortletException

Called by the portlet service to indicate to a portlet that a session is being destroyed

Parameters:

pPortletSession - the portlet session

Throws:

org.apache.jetspeed.portlet.PortletException

login

public void login(org.apache.jetspeed.portlet.PortletRequest pPortletRequest)
           throws org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate to a portlet that a session is being created

Specified by:

login in interface org.apache.jetspeed.portlet.PortletSessionListener

Specified by:

login in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletRequest - the portlet request

Throws:

org.apache.jetspeed.portlet.PortletException

logout

public void logout(org.apache.jetspeed.portlet.PortletSession pPortletSession)
            throws org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate to a portlet that a session is being destroyed

Specified by:

logout in interface org.apache.jetspeed.portlet.PortletSessionListener

Specified by:

logout in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletSession - the portlet session

Throws:

org.apache.jetspeed.portlet.PortletException

getLastModified

public long getLastModified(org.apache.jetspeed.portlet.PortletRequest pPortletRequest)

Returns the time the time of the response object was last modified.

Specified by:

getLastModified in class org.apache.jetspeed.portlet.Portlet

Parameters:

pPortletRequest - the portlet request

Returns:

-1

lookup

public java.lang.Object lookup(java.lang.String pName)
                        throws javax.naming.NamingException

Retreives the named object

Parameters:

pName - the name of the object

Returns:

the named object

Throws:

javax.naming.NamingException - if an error occurs

log

public void log(java.lang.String pMessage,
                java.lang.Throwable pThrowable)

Logs an event with the specified message and Throwable

Overrides:

log in class javax.servlet.GenericServlet

logInfo

public void logInfo(java.lang.String pMessage)

Logs an info event with the specified message

logInfo

public void logInfo(java.lang.Throwable pThrowable)

Logs an info event with the specified Throwable

logInfo

public void logInfo(java.lang.String pMessage,
                    java.lang.Throwable pThrowable)

Logs an info event with the specified message and Throwable

logWarning

public void logWarning(java.lang.String pMessage)

Logs an warning event with the specified message

logWarning

public void logWarning(java.lang.Throwable pThrowable)

Logs an warning event with the specified Throwable

logWarning

public void logWarning(java.lang.String pMessage,
                       java.lang.Throwable pThrowable)

Logs an warning event with the specified message and Throwable

logError

public void logError(java.lang.String pMessage)

Logs an error event with the specified message

logError

public void logError(java.lang.Throwable pThrowable)

Logs an error event with the specified Throwable

logError

public void logError(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)

Logs an error event with the specified message and Throwable

logDebug

public void logDebug(java.lang.String pMessage)

Logs an debug event with the specified message

logDebug

public void logDebug(java.lang.Throwable pThrowable)

Logs an debug event with the specified Throwable

logDebug

public void logDebug(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)

Logs an debug event with the specified message and Throwable