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", category = Node.CATEGORY, printObject = true)
29  public class Script extends AbstractScript {
30  
31      public Script(final String name, final String language, final String scriptText) {
32          super(name, language, scriptText);
33      }
34  
35      @PluginFactory
36      public static Script createScript(
37              // @formatter:off
38              @PluginAttribute("name") final String name,
39              @PluginAttribute("language") String language,
40              @PluginValue("scriptText") final String scriptText) {
41              // @formatter:on
42          if (language == null) {
43              LOGGER.info("No script language supplied, defaulting to {}", DEFAULT_LANGUAGE);
44              language = DEFAULT_LANGUAGE;
45          }
46          if (scriptText == null) {
47              LOGGER.error("No scriptText attribute provided for ScriptFile {}", name);
48              return null;
49          }
50          return new Script(name, language, scriptText);
51  
52      }
53  
54      @Override
55      public String toString() {
56          return getName() != null ? getName() : super.toString();
57      }
58  }