com.aoindustries.website.LogFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoweb-struts-core Show documentation
Core API for legacy Struts-based site framework with AOServ Platform control panels.
There is a newer version: 2.0.0
/*
 * aoweb-struts-core - Core API for legacy Struts-based site framework with AOServ Platform control panels.
 * Copyright (C) 2007-2009, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoweb-struts-core.
 *
 * aoweb-struts-core 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 3 of the License, or
 * (at your option) any later version.
 *
 * aoweb-struts-core 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 aoweb-struts-core.  If not, see .
 */
package com.aoindustries.website;

import com.aoindustries.aoserv.client.AOServConnector;
import com.aoindustries.aoserv.client.TicketCategory;
import com.aoindustries.aoserv.client.TicketLoggingHandler;
import com.aoindustries.util.ErrorPrinter;
import java.util.logging.Handler;
import java.util.logging.Logger;
import javax.servlet.ServletContext;

/**
 * Provides static access to the logging facilities.  The logs are written
 * into the AOServ ticket system under the type "logs".
 *
 * @author  AO Industries, Inc.
 */
public class LogFactory {

	private LogFactory() {
	}

	public static final String ATTRIBUTE_NAME = LogFactory.class.getName();

	/**
	 * Gets the logger for the provided ServletContext and class.
	 */
	public static Logger getLogger(ServletContext servletContext, Class clazz) {
		return getLogger(servletContext, clazz.getName());
	}

	/**
	 * 
	 * Gets the logger for the provided ServletContext and name.  The logger
	 * is stored as a context attribute under the name (ATTRIBUTE_NAME+'.'+name).
	 * Subsequent calls to this method will return the previously created logger.
	 * If an error occurs while creating the logger it will return the default
	 * logger.  In this case, it will not add the logger to the servletContext,
	 * which will cause it to try again until a fully functional logger is
	 * available.
	 * 
	 * 
	 * Callers of this class should reqest a logger each time they need one
	 * and not cache/reuse the logger provided by this method.  This allows
	 * for the automatic retry on logger creation.
	 * 
	 */
	synchronized public static Logger getLogger(ServletContext servletContext, String name) {
		String contextKey = ATTRIBUTE_NAME + '.' + name;
		Logger logger = (Logger)servletContext.getAttribute(contextKey);
		if(logger==null) {
			Handler handler;
			try {
				SiteSettings siteSettings = SiteSettings.getInstance(servletContext);
				AOServConnector rootConn = siteSettings.getRootAOServConnector();
				TicketCategory category = rootConn.getTicketCategories().getTicketCategoryByDotPath("aoserv.aoweb_struts");
				handler = TicketLoggingHandler.getHandler(
					siteSettings.getBrand().getAowebStrutsHttpUrlBase(),
					rootConn,
					category
				);
			} catch(Exception err) {
				ErrorPrinter.printStackTraces(err);
				handler = null;
			}
			logger = Logger.getLogger(name);
			if(handler!=null) {
				synchronized(logger) {
					boolean foundHandler = false;
					for(Handler oldHandler : logger.getHandlers()) {
						if(oldHandler==handler) foundHandler = true;
						else logger.removeHandler(oldHandler);
					}
					if(!foundHandler) logger.addHandler(handler);
					logger.setUseParentHandlers(false);
				}
				servletContext.setAttribute(contextKey, logger);
			}
		}
		return logger;
	}
}