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", category = Node.CATEGORY, printObject = true)
029public class Script extends AbstractScript {
030
031    public Script(final String name, final String language, final String scriptText) {
032        super(name, language, scriptText);
033    }
034
035    @PluginFactory
036    public static Script createScript(
037            // @formatter:off
038            @PluginAttribute("name") final String name,
039            @PluginAttribute("language") String language,
040            @PluginValue("scriptText") final String scriptText) {
041            // @formatter:on
042        if (language == null) {
043            LOGGER.info("No script language supplied, defaulting to {}", DEFAULT_LANGUAGE);
044            language = DEFAULT_LANGUAGE;
045        }
046        if (scriptText == null) {
047            LOGGER.error("No scriptText attribute provided for ScriptFile {}", name);
048            return null;
049        }
050        return new Script(name, language, scriptText);
051
052    }
053
054    @Override
055    public String toString() {
056        return getName() != null ? getName() : super.toString();
057    }
058}