001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.web.tags;
020
021import javax.servlet.jsp.JspException;
022import javax.servlet.jsp.tagext.TagSupport;
023
024import org.slf4j.Logger;
025import org.slf4j.LoggerFactory;
026
027
028/**
029 * JSP tag that renders the tag body only if the current user has <em>not</em> executed a successful authentication
030 * attempt <em>during their current session</em>.
031 *
032 * <p>The logically opposite tag of this one is the {@link org.apache.shiro.web.tags.AuthenticatedTag}.
033 *
034 * @since 0.2
035 */
036public class NotAuthenticatedTag extends SecureTag {
037
038    //TODO - complete JavaDoc
039
040    private static final Logger log = LoggerFactory.getLogger(NotAuthenticatedTag.class);
041
042    public int onDoStartTag() throws JspException {
043        if (getSubject() == null || !getSubject().isAuthenticated()) {
044            if (log.isTraceEnabled()) {
045                log.trace("Subject does not exist or is not authenticated.  Tag body will be evaluated.");
046            }
047            return TagSupport.EVAL_BODY_INCLUDE;
048        } else {
049            if (log.isTraceEnabled()) {
050                log.trace("Subject exists and is authenticated.  Tag body will not be evaluated.");
051            }
052            return TagSupport.SKIP_BODY;
053        }
054    }
055}