[GitHub] [logging-log4j2] zartc commented on a diff in pull request #682: Add environment variable arbiter

[GitBox <gi...@apache.org>]

zartc commented on code in PR #682:
URL: https://github.com/apache/logging-log4j2/pull/682#discussion_r1002458301


##########
log4j-core/src/main/java/org/apache/logging/log4j/core/config/arbiters/EnvironmentArbiter.java:
##########
@@ -0,0 +1,93 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache license, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the license for the specific language governing permissions and
+ * limitations under the license.
+ */
+package org.apache.logging.log4j.core.config.arbiters;
+
+import org.apache.logging.log4j.core.config.Node;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
+
+/**
+ * Condition that determines if the specified environment variable is set.
+ */
+@Plugin(name = "EnvironmentArbiter", category = Node.CATEGORY, elementType = Arbiter.ELEMENT_TYPE,
+        deferChildren = true, printObject = true)
+public class EnvironmentArbiter implements Arbiter {
+
+    private final String variableName;
+    private final String variableValue;
+
+    private EnvironmentArbiter(final String variableName, final String variableValue) {
+        this.variableName = variableName;
+        this.variableValue = variableValue;
+    }
+
+
+    /**
+     * Returns true if either the environment variable is defined (it has any value) or the property value
+     * matches the requested value.
+     */
+    @Override
+    public boolean isCondition() {
+        String value = System.getenv(variableName);
+        return value != null && (variableValue == null || value.equals(variableValue));
+    }
+
+    @PluginBuilderFactory
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    public static class Builder implements org.apache.logging.log4j.core.util.Builder<EnvironmentArbiter> {
+
+        public static final String ATTR_VARIABLE_NAME = "variableName";

Review Comment:
   Why not stick with the names used by the SystemPropertyArbiter ("propertyName" and "propertyValue") ?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org