001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.script; 018 019import org.apache.logging.log4j.core.config.Node; 020import org.apache.logging.log4j.core.config.plugins.Plugin; 021import org.apache.logging.log4j.core.config.plugins.PluginAttribute; 022import org.apache.logging.log4j.core.config.plugins.PluginFactory; 023import org.apache.logging.log4j.core.config.plugins.PluginValue; 024 025/** 026 * Container for the language and body of a script. 027 */ 028@Plugin(name = Script.PLUGIN_NAME, category = Node.CATEGORY, printObject = true) 029public class Script extends AbstractScript { 030 031 private static final String ATTR_LANGUAGE = "language"; 032 private static final String ATTR_SCRIPT_TEXT = "scriptText"; 033 static final String PLUGIN_NAME = "Script"; 034 035 public Script(final String name, final String language, final String scriptText) { 036 super(name, language, scriptText); 037 } 038 039 @PluginFactory 040 public static Script createScript( 041 // @formatter:off 042 @PluginAttribute("name") final String name, 043 @PluginAttribute(ATTR_LANGUAGE) String language, 044 @PluginValue(ATTR_SCRIPT_TEXT) final String scriptText) { 045 // @formatter:on 046 if (language == null) { 047 LOGGER.error("No '{}' attribute provided for {} plugin '{}'", ATTR_LANGUAGE, PLUGIN_NAME, name); 048 language = DEFAULT_LANGUAGE; 049 } 050 if (scriptText == null) { 051 LOGGER.error("No '{}' attribute provided for {} plugin '{}'", ATTR_SCRIPT_TEXT, PLUGIN_NAME, name); 052 return null; 053 } 054 return new Script(name, language, scriptText); 055 056 } 057 058 @Override 059 public String toString() { 060 return getName() != null ? getName() : super.toString(); 061 } 062}