com.exalead.mercury.mami.master.v10

Class LoggingConfig

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.master.v10.LoggingConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable, java.lang.Cloneable

public class LoggingConfig
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable

Data model
General Logging configuration, for generic process logs.
Specific system (crawler, query) have their specific log policy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLE_TIME_BASED_LOG_ROTATION
static boolean	DEFAULT_LOG_IN_SYSLOG
boolean	enableTimeBasedLogRotation
GlobalLoggerConfig	globalLoggerConfig
long	logExpirationDays
java.util.List<LoggingLevel>	loggingLevel
boolean	logInSyslog
long	logPurgeMaxSizeKB
java.lang.String	logRotationCronExpression
long	logRotationMaxSizeKB

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

Constructor and Description
LoggingConfig()
LoggingConfig(LoggingConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this LoggingConfig.
static LoggingConfig	fromString(java.lang.String s) String representation of this LoggingConfig.
GlobalLoggerConfig	getGlobalLoggerConfig()
long	getLogExpirationDays() If set, process log files are purged when older than the specified number of days.
java.util.List<LoggingLevel>	getLoggingLevel()
long	getLogPurgeMaxSizeKB() If set, process log files are purged (older first) when their total size is above the specified number.
java.lang.String	getLogRotationCronExpression() Custom Quartz Cron expression to trigger log rotation.
long	getLogRotationMaxSizeKB() If set, process log files are rotated when bigger than the specified number of kilobytes.
boolean	isEnableTimeBasedLogRotation() Rotates process log files each day at midnight.
boolean	isLogInSyslog() If set, log are also copied in syslog with type=daemon, ident=cloudview, message="AppenderName: logMessage" This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0"
LoggingConfig	makeCopy() Creates and returns a deep copy of this LoggingConfig.
static LoggingConfig	readFrom(java.io.InputStream is) Read this LoggingConfig from an XML fragment.
void	setEnableTimeBasedLogRotation(boolean enableTimeBasedLogRotation) Rotates process log files each day at midnight.
void	setGlobalLoggerConfig(GlobalLoggerConfig globalLoggerConfig)
void	setLogExpirationDays(long logExpirationDays) If set, process log files are purged when older than the specified number of days.
void	setLogInSyslog(boolean logInSyslog) If set, log are also copied in syslog with type=daemon, ident=cloudview, message="AppenderName: logMessage" This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0"
void	setLogPurgeMaxSizeKB(long logPurgeMaxSizeKB) If set, process log files are purged (older first) when their total size is above the specified number.
void	setLogRotationCronExpression(java.lang.String logRotationCronExpression) Custom Quartz Cron expression to trigger log rotation.
void	setLogRotationMaxSizeKB(long logRotationMaxSizeKB) If set, process log files are rotated when bigger than the specified number of kilobytes.
java.lang.String	toString() String representation of this LoggingConfig.
LoggingConfig	withEnableTimeBasedLogRotation(boolean enableTimeBasedLogRotation)
LoggingConfig	withEnableTimeBasedLogRotation(java.lang.Boolean enableTimeBasedLogRotation)
LoggingConfig	withGlobalLoggerConfig(GlobalLoggerConfig globalLoggerConfig)
LoggingConfig	withLogExpirationDays(long logExpirationDays)
LoggingConfig	withLogExpirationDays(java.lang.Long logExpirationDays)
LoggingConfig	withLoggingLevel(java.util.Collection<LoggingLevel> __values)
LoggingConfig	withLoggingLevel(LoggingLevel... __values)
LoggingConfig	withLogInSyslog(boolean logInSyslog)
LoggingConfig	withLogInSyslog(java.lang.Boolean logInSyslog)
LoggingConfig	withLogPurgeMaxSizeKB(long logPurgeMaxSizeKB)
LoggingConfig	withLogPurgeMaxSizeKB(java.lang.Long logPurgeMaxSizeKB)
LoggingConfig	withLogRotationCronExpression(java.lang.String logRotationCronExpression)
LoggingConfig	withLogRotationMaxSizeKB(long logRotationMaxSizeKB)
LoggingConfig	withLogRotationMaxSizeKB(java.lang.Long logRotationMaxSizeKB)
LoggingConfig	withVersion(long version)
LoggingConfig	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this LoggingConfig as an XML fragment

Methods inherited from class exa.bee.config.Versioned

clone, getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

enableTimeBasedLogRotation

public boolean enableTimeBasedLogRotation

DEFAULT_ENABLE_TIME_BASED_LOG_ROTATION

public static final boolean DEFAULT_ENABLE_TIME_BASED_LOG_ROTATION

See Also:

Constant Field Values

logRotationCronExpression

public java.lang.String logRotationCronExpression

logRotationMaxSizeKB

public long logRotationMaxSizeKB

logPurgeMaxSizeKB

public long logPurgeMaxSizeKB

logExpirationDays

public long logExpirationDays

logInSyslog

public boolean logInSyslog

DEFAULT_LOG_IN_SYSLOG

public static final boolean DEFAULT_LOG_IN_SYSLOG

See Also:

Constant Field Values

loggingLevel

public java.util.List<LoggingLevel> loggingLevel

globalLoggerConfig

public GlobalLoggerConfig globalLoggerConfig

Constructor Detail

LoggingConfig

public LoggingConfig()

LoggingConfig

public LoggingConfig(LoggingConfig o)

Copy constructor

Method Detail

withVersion

public LoggingConfig withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public LoggingConfig withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

setEnableTimeBasedLogRotation

public void setEnableTimeBasedLogRotation(boolean enableTimeBasedLogRotation)

Rotates process log files each day at midnight.

isEnableTimeBasedLogRotation

public boolean isEnableTimeBasedLogRotation()

Rotates process log files each day at midnight.

withEnableTimeBasedLogRotation

public LoggingConfig withEnableTimeBasedLogRotation(boolean enableTimeBasedLogRotation)

withEnableTimeBasedLogRotation

public LoggingConfig withEnableTimeBasedLogRotation(java.lang.Boolean enableTimeBasedLogRotation)

setLogRotationCronExpression

public void setLogRotationCronExpression(java.lang.String logRotationCronExpression)

Custom Quartz Cron expression to trigger log rotation. Only taken into account if enableTimeBasedLogRotation is false.

getLogRotationCronExpression

public java.lang.String getLogRotationCronExpression()

Custom Quartz Cron expression to trigger log rotation. Only taken into account if enableTimeBasedLogRotation is false.

withLogRotationCronExpression

public LoggingConfig withLogRotationCronExpression(java.lang.String logRotationCronExpression)

setLogRotationMaxSizeKB

public void setLogRotationMaxSizeKB(long logRotationMaxSizeKB)

If set, process log files are rotated when bigger
than the specified number of kilobytes.

getLogRotationMaxSizeKB

public long getLogRotationMaxSizeKB()

If set, process log files are rotated when bigger
than the specified number of kilobytes.

withLogRotationMaxSizeKB

public LoggingConfig withLogRotationMaxSizeKB(long logRotationMaxSizeKB)

withLogRotationMaxSizeKB

public LoggingConfig withLogRotationMaxSizeKB(java.lang.Long logRotationMaxSizeKB)

setLogPurgeMaxSizeKB

public void setLogPurgeMaxSizeKB(long logPurgeMaxSizeKB)

If set, process log files are purged (older first)
when their total size is above the specified number.

getLogPurgeMaxSizeKB

public long getLogPurgeMaxSizeKB()

If set, process log files are purged (older first)
when their total size is above the specified number.

withLogPurgeMaxSizeKB

public LoggingConfig withLogPurgeMaxSizeKB(long logPurgeMaxSizeKB)

withLogPurgeMaxSizeKB

public LoggingConfig withLogPurgeMaxSizeKB(java.lang.Long logPurgeMaxSizeKB)

setLogExpirationDays

public void setLogExpirationDays(long logExpirationDays)

If set, process log files are purged
when older than the specified number of days.

getLogExpirationDays

public long getLogExpirationDays()

If set, process log files are purged
when older than the specified number of days.

withLogExpirationDays

public LoggingConfig withLogExpirationDays(long logExpirationDays)

withLogExpirationDays

public LoggingConfig withLogExpirationDays(java.lang.Long logExpirationDays)

setLogInSyslog

public void setLogInSyslog(boolean logInSyslog)

If set, log are also copied in syslog with
type=daemon, ident=cloudview, message="AppenderName: logMessage"
This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0"

isLogInSyslog

public boolean isLogInSyslog()

If set, log are also copied in syslog with
type=daemon, ident=cloudview, message="AppenderName: logMessage"
This producs this type of line in /var/log/daemon.log: "Mar 19 12:10:47 madpc125 cloudview: index.clustermanager: Building slice list for st0"

withLogInSyslog

public LoggingConfig withLogInSyslog(boolean logInSyslog)

withLogInSyslog

public LoggingConfig withLogInSyslog(java.lang.Boolean logInSyslog)

getLoggingLevel

public java.util.List<LoggingLevel> getLoggingLevel()

withLoggingLevel

public LoggingConfig withLoggingLevel(LoggingLevel... __values)

withLoggingLevel

public LoggingConfig withLoggingLevel(java.util.Collection<LoggingLevel> __values)

setGlobalLoggerConfig

public void setGlobalLoggerConfig(GlobalLoggerConfig globalLoggerConfig)

getGlobalLoggerConfig

public GlobalLoggerConfig getGlobalLoggerConfig()

withGlobalLoggerConfig

public LoggingConfig withGlobalLoggerConfig(GlobalLoggerConfig globalLoggerConfig)

makeCopy

public LoggingConfig makeCopy()

Creates and returns a deep copy of this LoggingConfig.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

public static LoggingConfig readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this LoggingConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this LoggingConfig as an XML fragment

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static LoggingConfig fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this LoggingConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this LoggingConfig.

Overrides:

toString in class exa.bee.config.Versioned

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this LoggingConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException