Package org.opencms.module

Class CmsModuleLog

java.lang.Object

org.opencms.module.CmsModuleLog

public class CmsModuleLog
extends Object

This class is responsible for reading and writing module import/export log messages, to be used by CmsResourceWrapperModules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsModuleLog.Action	Action type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT_STRING	Date format for log messages.

Constructor Summary

Constructors

Constructor	Description
CmsModuleLog()

Method Summary

Modifier and Type	Method	Description
File	getLogFile(String moduleName)	Gets the log file for the given module name.
void	log(String moduleName, CmsModuleLog.Action action, boolean ok)	Logs a module action.
byte[]	readLog(String moduleName)	Reads the log file and returns the data.

Methods inherited from class java.lang.Object

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

Field Details

DATE_FORMAT_STRING

public static final String DATE_FORMAT_STRING

Date format for log messages.

See Also:

• Constant Field Values

Constructor Details

CmsModuleLog

public CmsModuleLog()

Method Details

getLogFile

public File getLogFile(String moduleName)

Gets the log file for the given module name.

Parameters:

moduleName - the module

Returns:

the log file

log

public void log(String moduleName,
 CmsModuleLog.Action action,
 boolean ok)

Logs a module action.

Parameters:

moduleName - the module name

action - the action

ok - true if the action was successful

readLog

public byte[] readLog(String moduleName)
               throws IOException

Reads the log file and returns the data.

Parameters:

moduleName - the module name

Returns:

the log contents

Throws:

IOException - if something goes wrong