com.sun.common.util.logging.LoggingConfigImpl Maven / Gradle / Ivy
/*
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2010 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.common.util.logging;
import com.sun.enterprise.util.io.FileUtils;
import org.glassfish.server.ServerEnvironmentImpl;
import org.jvnet.hk2.annotations.Contract;
import org.jvnet.hk2.annotations.Inject;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.component.PostConstruct;
import java.io.*;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.LogManager;
import java.util.logging.Logger;
/**
* Implementation of Logging Commands
*
* @author Naman Mehta
*/
@Service
@Contract
public class LoggingConfigImpl implements LoggingConfig, PostConstruct {
@Inject
Logger logger;
@Inject
ServerEnvironmentImpl env;
Properties props = new Properties();
FileInputStream fis;
String loggingPropertiesName;
LogManager logMgr = null;
File loggingConfigDir = null;
File file = null;
File libFolder = null;
/**
* Constructor
*/
public void postConstruct() {
// set logging.properties filename
setupConfigDir(env.getConfigDirPath(), env.getLibPath());
}
// this is so the launcher can pass in where the dir is since
public void setupConfigDir(File file, File installDir) {
loggingConfigDir = file;
loggingPropertiesName = ServerEnvironmentImpl.kLoggingPropertiesFileName;
logMgr = LogManager.getLogManager();
libFolder = new File(installDir, "lib");
}
/*
Load the properties for DAS
*/
private boolean openPropFile() throws IOException {
try {
props = new Properties();
file = new File(loggingConfigDir, loggingPropertiesName);
fis = new java.io.FileInputStream(file);
props.load(fis);
fis.close();
return true;
} catch (java.io.FileNotFoundException e) {
Logger.getAnonymousLogger().log(Level.INFO, "Cannot read logging.properties file. ");
return false;
} catch (IOException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot read logging.properties file : ", e);
throw new IOException();
}
}
/*
Copy logging.properties files if missing for given target.
*/
public boolean copyLoggingPropertiesFile(File srcDir, File targetDir) throws IOException {
Logger.getAnonymousLogger().log(Level.WARNING, "Logging.properties file not found, creating new file using DAS logging.properties");
File src = new File(srcDir, ServerEnvironmentImpl.kLoggingPropertiesFileName);
File dest = new File(targetDir, ServerEnvironmentImpl.kLoggingPropertiesFileName);
try {
FileUtils.copy(src, dest);
return true;
} catch (IOException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot create logging.properties file : ", e);
throw new IOException();
}
}
/*
Load the properties for given target.
*/
private boolean openPropFile(String target) throws IOException {
try {
props = new Properties();
String pathForLoggingFile = loggingConfigDir.getAbsolutePath() + File.separator + target + "-config";
File dirForLogging = new File(pathForLoggingFile);
file = new File(dirForLogging, loggingPropertiesName);
if (!file.exists()) {
copyLoggingPropertiesFile(loggingConfigDir, dirForLogging);
file = new File(dirForLogging, loggingPropertiesName);
}
fis = new java.io.FileInputStream(file);
props.load(fis);
fis.close();
return true;
} catch (java.io.FileNotFoundException e) {
Logger.getAnonymousLogger().log(Level.INFO, "Cannot read logging.properties file. ");
return false;
} catch (IOException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot read logging.properties file : ", e);
throw new IOException();
}
}
private void closePropFile() throws IOException {
try {
FileOutputStream ois = new FileOutputStream(file);
props.store(ois, "GlassFish logging.properties list");
ois.close();
} catch (FileNotFoundException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot close logging.properties file : ", e);
throw new IOException();
} catch (IOException e) {
//System.out.println("some other exception");
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot close logging.properties file : ", e);
throw new IOException();
}
}
private void setWebLoggers(String value) {
// set the rest of the web loggers to the same level
// these are only accessible via the web-container name so all values should be the same
String property = null;
property = (String) props.setProperty("org.apache.catalina.level", value);
property = (String) props.setProperty("org.apache.coyote.level", value);
property = (String) props.setProperty("org.apache.jasper.level", value);
}
/**
* setLoggingProperty() sets an existing propertyName to be propertyValue
* if the property doesn't exist the property will be added. The logManager
* readConfiguration is not called in this method.
*
* @param propertyName Name of the property to set
* @param propertyValue Value to set
* @throws IOException
*/
public String setLoggingProperty(String propertyName, String propertyValue) throws IOException {
try {
if (!openPropFile())
return null;
// update the property
if (propertyValue == null) return null;
// may need to map the domain.xml name to the new name in logging.properties file
String key = LoggingXMLNames.xmltoPropsMap.get(propertyName);
if (key == null) {
key = propertyName;
}
String property = (String) props.setProperty(key, propertyValue);
if (propertyName.contains("javax.enterprise.system.container.web")) {
setWebLoggers(propertyValue);
}
closePropFile();
return property;
} catch (IOException e) {
throw e;
}
}
/**
* setLoggingProperty() sets an existing propertyName to be propertyValue
* if the property doesn't exist the property will be added. The logManager
* readConfiguration is not called in this method.
*
* @param propertyName Name of the property to set
* @param propertyValue Value to set
* @throws IOException
*/
public String setLoggingProperty(String propertyName, String propertyValue, String target) throws IOException {
try {
if (!openPropFile(target))
return null;
// update the property
if (propertyValue == null) return null;
// may need to map the domain.xml name to the new name in logging.properties file
String key = LoggingXMLNames.xmltoPropsMap.get(propertyName);
if (key == null) {
key = propertyName;
}
String property = (String) props.setProperty(key, propertyValue);
if (propertyName.contains("javax.enterprise.system.container.web")) {
setWebLoggers(propertyValue);
}
closePropFile();
return property;
} catch (IOException e) {
throw e;
}
}
/* update the properties to new values. properties is a Map of names of properties and
* their cooresponding value. If the property does not exist then it is added to the
* logging.properties file.
*
* @param properties Map of the name and value of property to add or update
*
* @throws IOException
*/
public Map updateLoggingProperties(Map properties) throws IOException {
Map m = new HashMap();
try {
if (!openPropFile())
return null;
// need to map the name given to the new name in logging.properties file
String key = null;
for (Map.Entry e : properties.entrySet()) {
if (e.getValue() == null) continue;
key = LoggingXMLNames.xmltoPropsMap.get(e.getKey());
if (key == null) {
key = e.getKey();
}
String property = (String) props.setProperty(key, e.getValue());
if (e.getKey().contains("javax.enterprise.system.container.web")) {
setWebLoggers(e.getValue());
}
//build Map of entries to return
m.put(key, property);
}
closePropFile();
} catch (IOException ex) {
throw ex;
} catch (Exception e) {
// e.printStackTrace();
}
return m;
}
/* update the properties to new values for given target. properties is a Map of names of properties and
* their cooresponding value. If the property does not exist then it is added to the
* logging.properties file.
*
* @param properties Map of the name and value of property to add or update
*
* @throws IOException
*/
public Map updateLoggingProperties(Map properties, String target) throws IOException {
Map m = new HashMap();
try {
if (!openPropFile(target))
return null;
// need to map the name given to the new name in logging.properties file
String key = null;
for (Map.Entry e : properties.entrySet()) {
if (e.getValue() == null) continue;
key = LoggingXMLNames.xmltoPropsMap.get(e.getKey());
if (key == null) {
key = e.getKey();
}
String property = (String) props.setProperty(key, e.getValue());
if (e.getKey().contains("javax.enterprise.system.container.web")) {
setWebLoggers(e.getValue());
}
//build Map of entries to return
m.put(key, property);
}
closePropFile();
} catch (IOException ex) {
throw ex;
} catch (Exception e) {
// e.printStackTrace();
}
return m;
}
/* Return a Map of all the properties and corresponding values in the logging.properties file for given target.
* @throws IOException
*/
public Map getLoggingProperties(String targetServer) throws IOException {
Map m = new HashMap();
try {
if (!openPropFile(targetServer))
return null;
Enumeration e = props.propertyNames();
while (e.hasMoreElements()) {
String key = (String) e.nextElement();
// convert the name in domain.xml to the name in logging.properties if needed
if (LoggingXMLNames.xmltoPropsMap.get(key) != null) {
key = LoggingXMLNames.xmltoPropsMap.get(key);
}
//System.out.println("Debug "+key+ " " + props.getProperty(key));
m.put(key, props.getProperty(key));
}
return m;
} catch (IOException ex) {
throw ex;
}
}
/* Return a Map of all the properties and corresponding values in the logging.properties file.
* @throws IOException
*/
public Map getLoggingProperties() throws IOException {
Map m = new HashMap();
try {
if (!openPropFile())
return null;
Enumeration e = props.propertyNames();
while (e.hasMoreElements()) {
String key = (String) e.nextElement();
// convert the name in domain.xml to the name in logging.properties if needed
if (LoggingXMLNames.xmltoPropsMap.get(key) != null) {
key = LoggingXMLNames.xmltoPropsMap.get(key);
}
//System.out.println("Debug "+key+ " " + props.getProperty(key));
m.put(key, props.getProperty(key));
}
return m;
} catch (IOException ex) {
throw ex;
}
}
/*
* remove the listed properties from the logging.properties file.
* The readConfiguration method is called on the logManager after updating the properties.
*
* @param properties Set of the names of properties to remove
*
* @throws IOException
*/
public void removeLoggingProperties(Set properties) throws IOException {
try {
openPropFile();
Iterator i = properties.iterator();
while (i.hasNext()) {
try {
Object p = i.next();
logger.log(Level.FINER, "Remove from logging.properties file property ", p);
props.remove((String) p);
} catch (java.util.NoSuchElementException e) {
//System.out.println("Attempt to remove nonexistent property "+e);
Logger.getAnonymousLogger().log(Level.WARNING, "Attempt to remove nonexistent property ", e);
// continue;
}
}
closePropFile();
try {
logMgr.readConfiguration();
} catch (java.io.IOException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, "Cannot reconfigure LogManager : ", e);
throw new IOException();
}
} catch (IOException ex) {
throw ex;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy