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.taglib;
018
019import javax.servlet.jsp.JspException;
020import javax.servlet.jsp.tagext.Tag;
021
022import org.apache.logging.log4j.Level;
023import org.apache.logging.log4j.Marker;
024
025/**
026 * This class implements the {@code <log:ifEnabled>} tag.
027 *
028 * @since 2.0
029 */
030public class IfEnabledTag extends LoggerAwareTagSupport {
031    private static final long serialVersionUID = 1L;
032
033    private transient Object level;
034
035    private Marker marker;
036
037    @Override
038    protected void init() {
039        super.init();
040        this.level = null;
041        this.marker = null;
042    }
043
044    public final void setLevel(final Object level) {
045        this.level = level;
046    }
047
048    public final void setMarker(final Marker marker) {
049        this.marker = marker;
050    }
051
052    @Override
053    public int doStartTag() throws JspException {
054        final Level level = TagUtils.resolveLevel(this.level);
055        if (level == null) {
056            throw new JspException("Level must be of type String or org.apache.logging.log4j.Level.");
057        }
058
059        return TagUtils.isEnabled(this.getLogger(), level, this.marker) ? Tag.EVAL_BODY_INCLUDE : Tag.SKIP_BODY;
060    }
061}