org.pentaho.platform.api.engine
Interface ILogger

All Known Subinterfaces:

IComponent, IContentGenerator, IDataComponent, IPentahoSession, IPreparedComponent, IRuntimeContext, IRuntimeRepository, ISolutionEngine, ISolutionRepository

All Known Implementing Classes:

AbstractChartComponent, AbstractDatasetChartPortlet, AbstractGenerateContentComponent, AbstractGenerateStreamContentComponent, AbstractJFreeChartComponent, AbstractJFreeReportComponent, ActionComponent, ActionPortlet, ActionSequenceContentGenerator, ActionSequenceXMLParamsContentGenerator, AdhocWebService, AdminContentGenerator, AnalysisSaver, AnalysisViewService, BaseContentGenerator, BasePortlet, BasePublisher, BaseSession, BaseTest, BaseUIComponent, BaseXmlContentGenerator, BIRTReportComponent, CategoryDatasetChartComponent, CategoryDatasetChartPortlet, ChartComponent, ChartContentGenerator, CleanRepoPublisher, ComponentBase, ComponentImplementationExample, ContentItem, ContentItemFile, ContentLocation, ContentOutputComponent, ContentRepository, ContentRepositoryCleaner, Custom1, DashboardWidgetComponent, DbBasedSolutionRepository, DialChartComponent, EmailComponent, ExtensionDbBasedSolutionRepository, ExtensionFileBasedSolutionRepository, FileBasedSolutionRepository, FilterPanelComponent, FilterPanelPortlet, FlashChartComponent, GenericServlet, GetContent, GetImage, GetMondrianModel, GetResource, GlobalListsPublisher, HelloWorldComponent, HQLBaseComponent, HQLDataComponent, HQLLookupRule, HtmlComponent, HtmlPortlet, HttpWebService, InputFormComponent, InstanceEnd, JasperReportsComponent, JavascriptRule, JFreeReportAllContentComponent, JFreeReportComponent, JFreeReportConfigParameterComponent, JFreeReportCSVComponent, JFreeReportDataComponent, JFreeReportDirectoryHtmlComponent, JFreeReportExcelComponent, JFreeReportGenerateDefinitionComponent, JFreeReportGeneratorComponent, JFreeReportHtmlComponent, JFreeReportLoadComponent, JFreeReportParametersComponent, JFreeReportPdfComponent, JFreeReportPreviewSwingComponent, JFreeReportPrintComponent, JFreeReportRTFComponent, JFreeReportStreamHtmlComponent, JFreeReportValidateParametersComponent, JFreeReportXmlComponent, JFreeReportZipHtmlComponent, JobSchedulerComponent, KettleComponent, LoadDBRepositoryUIComponent, MapParameterResolver, MDXBaseComponent, MDXDataComponent, MDXLookupRule, MetadataPublisher, MondrianCachePublisher, MondrianCatalogPublisher, MondrianModelComponent, MQLRelationalDataComponent, NavigationComponent, NavigationContentGenerator, NavigationPortlet, PathBasedSystemSettings, PentahoBase, PentahoHttpSession, PentahoMessenger, PentahoPortletSession, PentahoVersionCheckComponent, PieDatasetChartComponent, PieDatasetChartPortlet, PivotViewComponent, PMDUIComponent, PojoComponent, PojoComponent, PrintComponent, PropertiesEditorUIComponent, PropertiesPanelUIComponent, ProxyServlet, QuartzExecute, QuartzExecute, ReportWizardSpecComponent, RepositoryFilePublisher, ResultSetCompareComponent, ResultSetCrosstabComponent, ResultSetExportComponent, ResultSetFlattenerComponent, RuntimeContext, RuntimeContext_new, RuntimeContextBase, RuntimeElement, RuntimeRepository, SchedulerAdminComponent, SchedulerAdminUIComponent, SecureFilterComponent, ServletBase, SettingsPublisher, ShowTestResult, SimpleLogger, SimpleRuntimeElement, SimpleRuntimeRepository, SolutionEngine, SolutionEngineInteractivityService, SolutionManagerUIComponent, SolutionPublisher, SolutionRepositoryBase, SolutionRepositoryService, SolutionTreeUIComponent, SQLBaseComponent, SQLDataComponent, SQLDdlComponent, SQLExecute, SQLLookupRule, StandaloneSession, SubActionComponent, SubscriptionAdminServlet, SubscriptionAdminUIComponent, SubscriptionExecute, SubscriptionPublisher, SubscriptionUserCleanup, SystemSettings, SystemStartupSession, TemplateComponent, TestComponent, TestManager, TimeSeriesCollectionChartComponent, TimeSeriesCollectionChartPortlet, TrustedSystemStartupSession, UIServlet, UserFilesComponent, UserSession, UtilityComponent, ViewAction, ViewActionExperimental, ViewPortlet, WebServiceLookupRule, WidgetGridComponent, WidgetGridPortlet, WidgetPortlet, XMLABaseComponent, XMLADataComponent, XMLALookupRule, XmlComponent, XQueryBaseComponent, XQueryLookupRule, XYSeriesCollectionChartComponent, XYSeriesCollectionChartPortlet, XYZSeriesCollectionChartComponent, XYZSeriesCollectionChartPortlet

public interface ILogger

The Logger is the main interface into the platform's logging subsystem.

Note: Documentation taken from Log4j Javadoc documentation.

Field Summary

static String	ACTIVITY_LOG
static int	DEBUG The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
static int	ERROR The ERROR level designates error events that might still allow the application to continue running.
static int	FATAL The FATAL level designates very severe error events that will presumably lead the application to abort.
static int	INFO The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
static String	INSTANCE_LOG
static String	SESSION_LOG
static String	SOLUTION_LOG
static int	TRACE The TRACE has the lowest possible rank and is intended to turn on all logging.
static int	UNKNOWN
static int	WARN The WARN level designates potentially harmful situations.

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	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.
int	getLoggingLevel() Return the logging level for this Logger.
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	setLoggingLevel(int loggingLevel) Set the logging level for this Logger.
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.

Field Detail

TRACE

static final int TRACE

The TRACE has the lowest possible rank and is intended to turn on all logging.

See Also:

Constant Field Values

DEBUG

static final int DEBUG

The DEBUG Level designates fine-grained informational events that are most useful to debug an application.

See Also:

Constant Field Values

INFO

static final int INFO

The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.

See Also:

Constant Field Values

WARN

static final int WARN

The WARN level designates potentially harmful situations.

See Also:

Constant Field Values

ERROR

static final int ERROR

The ERROR level designates error events that might still allow the application to continue running.

See Also:

Constant Field Values

FATAL

static final int FATAL

The FATAL level designates very severe error events that will presumably lead the application to abort.

See Also:

Constant Field Values

UNKNOWN

static final int UNKNOWN

See Also:

Constant Field Values

SOLUTION_LOG

static final String SOLUTION_LOG

See Also:

Constant Field Values

ACTIVITY_LOG

static final String ACTIVITY_LOG

See Also:

Constant Field Values

INSTANCE_LOG

static final String INSTANCE_LOG

See Also:

Constant Field Values

SESSION_LOG

static final String SESSION_LOG

See Also:

Constant Field Values

Method Detail

getLoggingLevel

int getLoggingLevel()

Return the logging level for this Logger.

Returns:

logging level

setLoggingLevel

void setLoggingLevel(int loggingLevel)

Set the logging level for this Logger.

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

Parameters:

loggingLevel -

trace

void trace(String message)

Log a message object with the TRACE Level.

Parameters:

message - the message object to log.

debug

void debug(String message)

Log a message object with the DEBUG Level.

Parameters:

message - the message object to log.

info

void info(String message)

Log a message object with the INFO Level.

Parameters:

message - the message object to log.

warn

void warn(String message)

Log a message object with the WARN Level.

Parameters:

message - the message object to log.

error

void error(String message)

Log a message object with the ERROR Level.

Parameters:

message - the message object to log.

fatal

void fatal(String message)

Log a message object with the FATAL Level.

Parameters:

message - the message object to log.

trace

void trace(String message,
           Throwable error)

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

Parameters:

message - the message object to log.

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

debug

void debug(String message,
           Throwable error)

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

Parameters:

message - the message object to log.

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

info

void info(String message,
          Throwable error)

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

Parameters:

message - the message object to log.

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

warn

void warn(String message,
          Throwable error)

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

Parameters:

message - the message object to log.

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

error

void error(String message,
           Throwable error)

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

Parameters:

message - the message object to log.

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

fatal

void fatal(String message,
           Throwable error)

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

Parameters:

message - the message object to log.

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