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 executed a <b>successful</b> authentication attempt
030 * <em>during their current session</em>.
031 *
032 * <p>This is more restrictive than the {@link UserTag}, which only
033 * ensures the current user is known to the system, either via a current login or from Remember Me services,
034 * which only makes the assumption that the current user is who they say they are, and does not guarantee it like
035 * this tag does.
036 *
037 * <p>The logically opposite tag of this one is the {@link NotAuthenticatedTag}
038 *
039 * @since 0.2
040 */
041public class AuthenticatedTag extends SecureTag {
042
043    //TODO - complete JavaDoc
044
045    private static final Logger log = LoggerFactory.getLogger(AuthenticatedTag.class);
046
047    public int onDoStartTag() throws JspException {
048        if (getSubject() != null && getSubject().isAuthenticated()) {
049            if (log.isTraceEnabled()) {
050                log.trace("Subject exists and is authenticated.  Tag body will be evaluated.");
051            }
052            return TagSupport.EVAL_BODY_INCLUDE;
053        } else {
054            if (log.isTraceEnabled()) {
055                log.trace("Subject does not exist or is not authenticated.  Tag body will not be evaluated.");
056            }
057            return TagSupport.SKIP_BODY;
058        }
059    }
060}