alma.acs.logging.domainspecific

Class AudienceLogger

java.lang.Object

alma.acs.logging.domainspecific.AudienceLogger

Direct Known Subclasses:

DeveloperLogger, OperatorLogger, ScienceLogger

public abstract class AudienceLogger
extends java.lang.Object

Base class for the various fixed-audience loggers. As of ACS 9.0, the following audience types are defined in acscommon.idl: const string OPERATOR = "Operator";
const string DEVELOPER = "Developer";
const string SYSADMIN = "Sysadmin";
const string DBA = "DBA";
const string SCILOG = "SciLog";
const string NO_AUDIENCE = "";
but we only provide the convenience wrappers for the most popular audiences: Operator, Developer, SciLog. For other audiences, the static method log(Level, String, Throwable, AcsLogger, Audience) can be used, or AcsLogger.logToAudience(Level, String, String) with a generic audience string which is especially useful when a new audience type gets introduced and ACS has not added support for it yet.

The audience loggers are wrappers around an AcsLogger, calling AcsLogger.logToAudience(Level, String, String) with a fixed audience string that corresponds to an AudienceLogger.Audience enum. The goal is to keep the "audience" concept generic in AcsLogger, and confine the usage of concrete alma audience types to this subpackage, e.g. ScienceLogger.

See http://jira.alma.cl/browse/COMP-3130 about adopting this code from CONTROL/Common/Define/src/alma/Control/Common/*Logger.java to ACS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudienceLogger.Audience

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AudienceLogger(AcsLogger logger, AudienceLogger.Audience audience)

Method Summary

Modifier and Type	Method and Description
void	config(java.lang.String msg)
void	fine(java.lang.String msg)
void	finer(java.lang.String msg)
void	finest(java.lang.String msg)
AcsLogger	getLogger()
void	info(java.lang.String msg)
void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable thr) Log with throwable
static void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable thr, AcsLogger acsLogger, AudienceLogger.Audience audience) Static log method, useful for rare audience types that don't have their own subclass (yet).
protected static void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable thr, AcsLogger acsLogger, AudienceLogger.Audience audience, java.lang.Class<? extends AudienceLogger> staticLoggerClass) To be called by static methods of subclasses only.
void	severe(java.lang.String msg)
void	warning(java.lang.String msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

AudienceLogger

protected AudienceLogger(AcsLogger logger,
                         AudienceLogger.Audience audience)

Method Detail

getLogger

public AcsLogger getLogger()

log

public static void log(java.util.logging.Level level,
                       java.lang.String msg,
                       java.lang.Throwable thr,
                       AcsLogger acsLogger,
                       AudienceLogger.Audience audience)

Static log method, useful for rare audience types that don't have their own subclass (yet).

log

protected static void log(java.util.logging.Level level,
                          java.lang.String msg,
                          java.lang.Throwable thr,
                          AcsLogger acsLogger,
                          AudienceLogger.Audience audience,
                          java.lang.Class<? extends AudienceLogger> staticLoggerClass)

To be called by static methods of subclasses only.

log

public void log(java.util.logging.Level level,
                java.lang.String msg,
                java.lang.Throwable thr)

Log with throwable

severe

public void severe(java.lang.String msg)

warning

public void warning(java.lang.String msg)

info

public void info(java.lang.String msg)

config

public void config(java.lang.String msg)

fine

public void fine(java.lang.String msg)

finer

public void finer(java.lang.String msg)

finest

public void finest(java.lang.String msg)