org.pentaho.platform.web.portal
Class BasePortlet

java.lang.Object
  GenericPortlet
      org.pentaho.platform.web.portal.BasePortlet

All Implemented Interfaces:

ILogger

Direct Known Subclasses:

ViewPortlet

public abstract class BasePortlet
extends GenericPortlet
implements ILogger

Field Summary

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

BasePortlet()

Method Summary

void	debug(String message) Log a message object with the DEBUG Level.
void	debug(String message, Throwable error) Log a message with the DEBUG level including the stack trace of the Throwable error passed as parameter.
void	doEdit(RenderRequest request, RenderResponse response)
void	doHelp(RenderRequest request, RenderResponse response)
abstract void	doPortletEdit(RenderRequest request, RenderResponse response, PentahoPortletSession userSession)
abstract void	doPortletHelp(RenderRequest request, RenderResponse response, PentahoPortletSession userSession)
abstract void	doPortletView(RenderRequest request, RenderResponse response, PentahoPortletSession userSession)
void	doView(RenderRequest request, RenderResponse response)
void	error(String message) Log a message object with the ERROR Level.
void	error(String message, Throwable error) Log a message with the ERROR level including the stack trace of the Throwable error passed as parameter.
void	fatal(String message) Log a message object with the FATAL Level.
void	fatal(String message, Throwable error) Log a message with the FATAL level including the stack trace of the Throwable error passed as parameter.
abstract org.apache.commons.logging.Log	getLogger()
int	getLoggingLevel() Return the logging level for this Logger.
String	getLogId()
void	info(String message) Log a message object with the INFO Level.
void	info(String message, Throwable error) Log a message with the INFO level including the stack trace of the Throwable error passed as parameter.
void	init()
void	initPortlet()
void	processAction(ActionRequest request, ActionResponse response)
abstract void	processPortletAction(ActionRequest request, ActionResponse response, PentahoPortletSession userSession)
void	setLoggingLevel(int logLevel) Set the logging level for this Logger.
void	setLogId(String lId)
void	trace(String message) Log a message object with the TRACE Level.
void	trace(String message, Throwable error) Log a message with the TRACE level including the stack trace of the Throwable error passed as parameter.
void	warn(String message) Log a message object with the WARN Level.
void	warn(String message, Throwable error) Log a message with the WARN level including the stack trace of the Throwable error passed as parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePortlet

public BasePortlet()

Method Detail

getLogger

public abstract org.apache.commons.logging.Log getLogger()

getLogId

public String getLogId()

setLogId

public void setLogId(String lId)

init

public void init()
          throws PortletException

Throws:

PortletException

initPortlet

public void initPortlet()

processPortletAction

public abstract void processPortletAction(ActionRequest request,
                                          ActionResponse response,
                                          PentahoPortletSession userSession)
                                   throws PortletException,
                                          IOException

Throws:

PortletException

IOException

doPortletView

public abstract void doPortletView(RenderRequest request,
                                   RenderResponse response,
                                   PentahoPortletSession userSession)
                            throws PortletException,
                                   IOException

Throws:

PortletException

IOException

doPortletHelp

public abstract void doPortletHelp(RenderRequest request,
                                   RenderResponse response,
                                   PentahoPortletSession userSession)
                            throws PortletException,
                                   IOException

Throws:

PortletException

IOException

doPortletEdit

public abstract void doPortletEdit(RenderRequest request,
                                   RenderResponse response,
                                   PentahoPortletSession userSession)
                            throws PortletException,
                                   IOException

Throws:

PortletException

IOException

processAction

public final void processAction(ActionRequest request,
                                ActionResponse response)
                         throws PortletException,
                                IOException

Throws:

PortletException

IOException

doView

public final void doView(RenderRequest request,
                         RenderResponse response)
                  throws PortletException,
                         IOException

Throws:

PortletException

IOException

doHelp

public final void doHelp(RenderRequest request,
                         RenderResponse response)
                  throws PortletException,
                         IOException

Throws:

PortletException

IOException

doEdit

public final void doEdit(RenderRequest request,
                         RenderResponse response)
                  throws PortletException,
                         IOException

Throws:

PortletException

IOException

getLoggingLevel

public int getLoggingLevel()

Description copied from interface: ILogger

Return the logging level for this Logger.

Specified by:

getLoggingLevel in interface ILogger

Returns:

logging level

setLoggingLevel

public void setLoggingLevel(int logLevel)

Description copied from interface: ILogger

Set the logging level for this Logger.

Valid logging levels are TRACE, DEBUG, INFO, WARN, ERROR, and FATAL.

Specified by:

setLoggingLevel in interface ILogger

trace

public void trace(String message)

Description copied from interface: ILogger

Log a message object with the TRACE Level.

Specified by:

trace in interface ILogger

Parameters:

message - the message object to log.

debug

public void debug(String message)

Description copied from interface: ILogger

Log a message object with the DEBUG Level.

Specified by:

debug in interface ILogger

Parameters:

message - the message object to log.

info

public void info(String message)

Description copied from interface: ILogger

Log a message object with the INFO Level.

Specified by:

info in interface ILogger

Parameters:

message - the message object to log.

warn

public void warn(String message)

Description copied from interface: ILogger

Log a message object with the WARN Level.

Specified by:

warn in interface ILogger

Parameters:

message - the message object to log.

error

public void error(String message)

Description copied from interface: ILogger

Log a message object with the ERROR Level.

Specified by:

error in interface ILogger

Parameters:

message - the message object to log.

fatal

public void fatal(String message)

Description copied from interface: ILogger

Log a message object with the FATAL Level.

Specified by:

fatal in interface ILogger

Parameters:

message - the message object to log.

trace

public void trace(String message,
                  Throwable error)

Description copied from interface: ILogger

Log a message with the TRACE level including the stack trace of the Throwable error passed as parameter.

Specified by:

trace in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.

debug

public void debug(String message,
                  Throwable error)

Description copied from interface: ILogger

Log a message with the DEBUG level including the stack trace of the Throwable error passed as parameter.

Specified by:

debug in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.

info

public void info(String message,
                 Throwable error)

Description copied from interface: ILogger

Log a message with the INFO level including the stack trace of the Throwable error passed as parameter.

Specified by:

info in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.

warn

public void warn(String message,
                 Throwable error)

Description copied from interface: ILogger

Log a message with the WARN level including the stack trace of the Throwable error passed as parameter.

Specified by:

warn in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.

error

public void error(String message,
                  Throwable error)

Description copied from interface: ILogger

Log a message with the ERROR level including the stack trace of the Throwable error passed as parameter.

Specified by:

error in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.

fatal

public void fatal(String message,
                  Throwable error)

Description copied from interface: ILogger

Log a message with the FATAL level including the stack trace of the Throwable error passed as parameter.

Specified by:

fatal in interface ILogger

Parameters:

message - the message object to log.

error - the exception to log, including its stack trace.