atg.portlet

Class GenericPortletService

java.lang.Object

atg.portlet.GenericPortletService

All Implemented Interfaces:

javax.portlet.Portlet

Direct Known Subclasses:

DispatchPortlet

public class GenericPortletService
extends java.lang.Object
implements javax.portlet.Portlet

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

Derived class should override the following methods:

• startService
• handleRender
• handleProcessAction
• stopService

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

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

   <portlet>
     <portlet-name>MyPortletService</portlet-name>
     <portlet-class>com.acme.portlet.MyPortletService</portlet-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>
   </portlet>
  

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.

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	destroy() Called by the portlet container to indicate to a portlet that it is being taken out of service
javax.naming.Context	getContext() Returns property Context
java.lang.String	getName() Returns property Name
javax.portlet.PortletConfig	getPortletConfig() Returns property PortletConfig
javax.portlet.PortletContext	getPortletContext() Returns property PortletContext
void	handleProcessAction(javax.portlet.ActionRequest pActionRequest, javax.portlet.ActionResponse pActionResponse) Called by the portlet service to process an action request
void	handleRender(javax.portlet.RenderRequest pRenderRequest, javax.portlet.RenderResponse pRenderResponse) Called by the portlet service to indicate that a portlet should handle a render request.
void	init(javax.portlet.PortletConfig pPortletConfig) 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	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	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
protected void	postHandleProcessAction(javax.portlet.ActionRequest pActionRequest, javax.portlet.ActionResponse pActionResponse) Called by the portlet service after processing an action request.
protected void	postHandleRender(javax.portlet.RenderRequest pRenderRequest, javax.portlet.RenderResponse pRenderResponse) Called by the portlet service after servicing the render request.
protected void	preHandleProcessAction(javax.portlet.ActionRequest pActionRequest, javax.portlet.ActionResponse pActionResponse) Called by the portlet service before processing an action request
protected void	preHandleRender(javax.portlet.RenderRequest pRenderRequest, javax.portlet.RenderResponse pRenderResponse) Called by the portlet service before servicing the render request.
void	processAction(javax.portlet.ActionRequest pActionRequest, javax.portlet.ActionResponse pActionResponse) Called by the portlet container to allow the portlet to process an action request.
void	render(javax.portlet.RenderRequest pRenderRequest, javax.portlet.RenderResponse pRenderResponse) Called by the portlet container to allow the portlet to generate the content of the response based on its current state.
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	startService(javax.portlet.PortletConfig pPortletConfig) Called by the portlet service after it has been initialzed.
void	stopService() Called by the portlet service after it has been destroyed.

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 javax.portlet.PortletConfig getPortletConfig()

Returns property PortletConfig

getName

public java.lang.String getName()

Returns property Name

getPortletContext

public javax.portlet.PortletContext getPortletContext()

Returns property PortletContext

getContext

public javax.naming.Context getContext()

Returns property Context

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(javax.portlet.PortletConfig pPortletConfig)
                  throws javax.portlet.UnavailableException,
                         javax.portlet.PortletException

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

Parameters:

pPortletConfig - portlet configuration information.

Throws:

javax.portlet.PortletException - if an exception has occurred that interferes with the portlet's normal operation.

javax.portlet.UnavailableException - if the portlet cannot perform the initialization at this time.

init

public void init(javax.portlet.PortletConfig pPortletConfig)
          throws javax.portlet.PortletException

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

Specified by:

init in interface javax.portlet.Portlet

Parameters:

pPortletConfig - portlet configuration information.

Throws:

javax.portlet.PortletException - if an exception has occurred that interferes with the portlet's normal operation.

javax.portlet.UnavailableException - if the portlet cannot perform the initialization at this time.

preHandleProcessAction

protected void preHandleProcessAction(javax.portlet.ActionRequest pActionRequest,
                                      javax.portlet.ActionResponse pActionResponse)
                               throws javax.portlet.PortletException,
                                      java.io.IOException

Called by the portlet service before processing an action request

Parameters:

pActionRequest - the action request

pActionResponse - the action response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the request

javax.portlet.UnavailableException - if the portlet is unavailable to process the action at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

handleProcessAction

public void handleProcessAction(javax.portlet.ActionRequest pActionRequest,
                                javax.portlet.ActionResponse pActionResponse)
                         throws javax.portlet.PortletException,
                                java.io.IOException

Called by the portlet service to process an action request

Parameters:

pActionRequest - the action request

pActionResponse - the action response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the request

javax.portlet.UnavailableException - if the portlet is unavailable to process the action at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

postHandleProcessAction

protected void postHandleProcessAction(javax.portlet.ActionRequest pActionRequest,
                                       javax.portlet.ActionResponse pActionResponse)
                                throws javax.portlet.PortletException,
                                       java.io.IOException

Called by the portlet service after processing an action request.

Parameters:

pActionRequest - the action request

pActionResponse - the action response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the request

javax.portlet.UnavailableException - if the portlet is unavailable to process the action at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

processAction

public void processAction(javax.portlet.ActionRequest pActionRequest,
                          javax.portlet.ActionResponse pActionResponse)
                   throws javax.portlet.PortletException,
                          java.io.IOException

Called by the portlet container to allow the portlet to process an action request.

Specified by:

processAction in interface javax.portlet.Portlet

Parameters:

pActionRequest - the action request

pActionResponse - the action response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the request

javax.portlet.UnavailableException - if the portlet is unavailable to process the action at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

preHandleRender

protected void preHandleRender(javax.portlet.RenderRequest pRenderRequest,
                               javax.portlet.RenderResponse pRenderResponse)
                        throws javax.portlet.PortletException,
                               java.io.IOException

Called by the portlet service before servicing the render request. Derived classes should override this method to handle the pre servicing of a render request.

Parameters:

pRenderRequest - the render request

pRenderResponse - the render response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the rendering request

javax.portlet.UnavailableException - if the portlet is unavailable to perform render at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

handleRender

public void handleRender(javax.portlet.RenderRequest pRenderRequest,
                         javax.portlet.RenderResponse pRenderResponse)
                  throws javax.portlet.PortletException,
                         java.io.IOException

Called by the portlet service to indicate that a portlet should handle a render request. Derived classes should override this method to handle the servicing of a render request.

Parameters:

pRenderRequest - the render request

pRenderResponse - the render response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the rendering request

javax.portlet.UnavailableException - if the portlet is unavailable to perform render at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

postHandleRender

protected void postHandleRender(javax.portlet.RenderRequest pRenderRequest,
                                javax.portlet.RenderResponse pRenderResponse)
                         throws javax.portlet.PortletException,
                                java.io.IOException

Called by the portlet service after servicing the render request. Derived classes should override this method to handle the post servicing of a render request.

Parameters:

pRenderRequest - the render request

pRenderResponse - the render response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the rendering request

javax.portlet.UnavailableException - if the portlet is unavailable to perform render at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

render

public void render(javax.portlet.RenderRequest pRenderRequest,
                   javax.portlet.RenderResponse pRenderResponse)
            throws javax.portlet.PortletException,
                   java.io.IOException

Called by the portlet container to allow the portlet to generate the content of the response based on its current state.

Specified by:

render in interface javax.portlet.Portlet

Parameters:

pRenderRequest - the render request

pRenderResponse - the render response

Throws:

javax.portlet.PortletException - if the portlet has problems fulfilling the rendering request

javax.portlet.UnavailableException - if the portlet is unavailable to perform render at this time

javax.portlet.PortletSecurityException - if the portlet cannot fullfill this request because of security reasons

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

stopService

public void stopService()

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

destroy

public void destroy()

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

Specified by:

destroy in interface javax.portlet.Portlet

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

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