View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.script;
18  
19  import org.apache.logging.log4j.core.config.Node;
20  import org.apache.logging.log4j.core.config.plugins.Plugin;
21  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
22  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
23  import org.apache.logging.log4j.core.config.plugins.PluginValue;
24  
25  /**
26   * Container for the language and body of a script.
27   */
28  @Plugin(name = Script.PLUGIN_NAME, category = Node.CATEGORY, printObject = true)
29  public class Script extends AbstractScript {
30  
31      private static final String ATTR_LANGUAGE = "language";
32      private static final String ATTR_SCRIPT_TEXT = "scriptText";
33      static final String PLUGIN_NAME = "Script";
34  
35      public Script(final String name, final String language, final String scriptText) {
36          super(name, language, scriptText);
37      }
38  
39      @PluginFactory
40      public static Script createScript(
41              // @formatter:off
42              @PluginAttribute("name") final String name,
43              @PluginAttribute(ATTR_LANGUAGE) String language,
44              @PluginValue(ATTR_SCRIPT_TEXT) final String scriptText) {
45              // @formatter:on
46          if (language == null) {
47              LOGGER.error("No '{}' attribute provided for {} plugin '{}'", ATTR_LANGUAGE, PLUGIN_NAME, name);
48              language = DEFAULT_LANGUAGE;
49          }
50          if (scriptText == null) {
51              LOGGER.error("No '{}' attribute provided for {} plugin '{}'", ATTR_SCRIPT_TEXT, PLUGIN_NAME, name);
52              return null;
53          }
54          return new Script(name, language, scriptText);
55  
56      }
57  
58      @Override
59      public String toString() {
60          return getName() != null ? getName() : super.toString();
61      }
62  }