com.sun.enterprise.server.logging.commands.SetLogFileFormat Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.
*/
// Portions Copyright [2019-2021] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.server.logging.commands;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import jakarta.inject.Inject;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.admin.CommandLock;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.annotations.Service;
import com.sun.common.util.logging.LoggingConfigFactory;
import com.sun.enterprise.config.serverbeans.Cluster;
import com.sun.enterprise.config.serverbeans.Clusters;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.Server;
import com.sun.enterprise.config.serverbeans.Servers;
import com.sun.enterprise.server.logging.ODLLogFormatter;
import com.sun.enterprise.server.logging.UniformLogFormatter;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
/*
* Set log file format command.
* Updates the formatter for the log file to either ODL, ULF or a custom name.
*/
@ExecuteOn( { RuntimeType.DAS, RuntimeType.INSTANCE })
@TargetType( { CommandTarget.DAS, CommandTarget.STANDALONE_INSTANCE, CommandTarget.CLUSTER, CommandTarget.CONFIG })
@CommandLock(CommandLock.LockType.NONE)
@Service(name = "set-log-file-format")
@PerLookup
@I18n("set.log.file.format")
@RestEndpoints( { @RestEndpoint(configBean = Domain.class, opType = RestEndpoint.OpType.POST, path = "set-log-file-format", description = "set-log-file-format") })
public class SetLogFileFormat implements AdminCommand {
private static final String ODL_FORMATTER_NAME = "ODL";
private static final String ULF_FORMATTER_NAME = "ULF";
@Param(optional = true)
@I18n("set.log.file.format.target")
String target = SystemPropertyConstants.DAS_SERVER_NAME;
@Param(optional = true, defaultValue=ODL_FORMATTER_NAME, primary=true)
@I18n("set.log.file.format.formatter")
String formatter = ODL_FORMATTER_NAME;
@Inject
private LoggingConfigFactory loggingConfigFactory;
@Inject
Domain domain;
@Inject
Servers servers;
@Inject
Clusters clusters;
@Inject
ServerEnvironment env;
final private static LocalStringManagerImpl LOCAL_STRINGS = new LocalStringManagerImpl(
SetLogFileFormat.class);
public void execute(AdminCommandContext context) {
String formatterClassName = null;
if (formatter.equalsIgnoreCase(ODL_FORMATTER_NAME)) {
formatterClassName = ODLLogFormatter.class.getName();
} else if (formatter.equalsIgnoreCase(ULF_FORMATTER_NAME)) {
formatterClassName = UniformLogFormatter.class.getName();
} else {
formatterClassName = formatter;
}
if (formatterClassName == null || formatter.isEmpty()) {
formatterClassName = ODLLogFormatter.class.getName();
}
Map loggingProperties = new HashMap();
loggingProperties.put("com.sun.enterprise.server.logging.GFFileHandler.formatter", formatterClassName);
final ActionReport report = context.getActionReport();
boolean isCluster = false;
boolean isDas = false;
boolean isInstance = false;
boolean isConfig = false;
String targetConfigName = "";
try {
Config config = domain.getConfigNamed(target);
if (config != null) {
targetConfigName = target;
isConfig = true;
} else {
Server targetServer = domain.getServerNamed(target);
if (targetServer != null) {
if (targetServer.isDas()) {
isDas = true;
} else {
isInstance = true;
Cluster clusterForInstance = targetServer.getCluster();
if (clusterForInstance != null) {
targetConfigName = clusterForInstance.getConfigRef();
} else {
targetConfigName = targetServer.getConfigRef();
}
}
} else {
com.sun.enterprise.config.serverbeans.Cluster cluster = domain.getClusterNamed(target);
if (cluster != null) {
isCluster = true;
targetConfigName = cluster.getConfigRef();
}
}
}
if (isDas) {
loggingConfigFactory.provide(targetConfigName).setLoggingProperties(loggingProperties);
} else if ((targetConfigName != null && !targetConfigName.isEmpty()) &&
(isCluster || isInstance || isConfig)) {
loggingConfigFactory.provide(targetConfigName).setLoggingProperties(loggingProperties);
} else {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
String msg = LOCAL_STRINGS.getLocalString(
"invalid.target.sys.props",
"Invalid target: {0}. Valid default target is a server named ''server'' (default) or cluster name.",
targetConfigName);
report.setMessage(msg);
return;
}
String successMsg = LOCAL_STRINGS.getLocalString("set.log.file.format.success",
"The log file formatter is set to {0} for {1}.",
formatterClassName,
env.getInstanceName());
report.setMessage(successMsg);
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
} catch (IOException e) {
report.setMessage(LOCAL_STRINGS.getLocalString(
"set.log.file.format.failed",
"Could not set log file formatter for {0}.", target));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
}
}
}