AcsLogRecord.java

/*
 ALMA - Atacama Large Millimiter Array
 * (c) Associated Universities Inc., 2007 
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 */
/** 
 * @author  nbarriga
 * @version $Id: AcsLogRecord.java,v 1.6 2010/08/24 16:11:49 hsommer Exp $
 * @since    
 */

package alma.acs.logging;

import java.util.logging.Level;
import java.util.logging.LogRecord;

/**
 * As of ACS 6.0.2, this special LogRecord is produced by the generated type-safe logs
 * (module loggingts) which automatically set the target audience,
 * and by the audience-aware helper classes in this module.
 * <p>
 * Note that using AcsLogRecord, non-JDK logging data is attached to special fields in a custom log record,
 * which is then logged to a normal JDK logger, but later recovered in {@link alma.acs.logging.formatters.AcsXMLLogFormatter#format(LogRecord)}.
 * In the standard logging scenario it is the other way around: we use a custom logger, which creates standard LogRecords, and
 * special non-JDK data is attached in the form of special property-style log parameters.
 * @TODO- It may be better to unify the two approaches of storing non-JDK log data, e.g. by overriding the various AcsLogger#log, logp methods, 
 *        to create an AcsLogRecord instead of LogRecord
 */
public class AcsLogRecord extends LogRecord
{
	private String audience;
	private String array;
	private String antenna;

	private Object params[];

	public AcsLogRecord(Level level, String msg, String loggerName) {
		super(level, msg);
		this.setLoggerName(loggerName);
	}

	public AcsLogRecord(Level level, String msg, Object parameters, String loggerName) {
		this(level, msg, loggerName);
		params = new Object[1];
		params[0] = parameters;
		this.setParameters(params);
	}

	public void setAudience(String audience) {
		this.audience = audience;
	}

	public String getAudience() {
		if (audience != null)
		{
			return audience;
		}
		else
		{
			return "";
		}
	}

	public void setArray(String array) {
		this.array = array;
	}

	public String getArray() {
		if (array != null)
		{
			return array;
		}
		else
		{
			return "";
		}
	}

	public void setAntenna(String antenna) {
		this.antenna = antenna;
	}

	public String getAntenna() {
		if (this.antenna != null)
		{
			return this.antenna;
		}
		else
		{
			return "";
		}
	}

}