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
024/**
025 * @since 0.1
026 */
027public abstract class PermissionTag extends SecureTag {
028
029    //TODO - complete JavaDoc
030
031    private String name = null;
032
033    public PermissionTag() {
034    }
035
036    public String getName() {
037        return name;
038    }
039
040    public void setName(String name) {
041        this.name = name;
042    }
043
044    protected void verifyAttributes() throws JspException {
045        String permission = getName();
046
047        if (permission == null || permission.length() == 0) {
048            String msg = "The 'name' tag attribute must be set.";
049            throw new JspException(msg);
050        }
051    }
052
053    public int onDoStartTag() throws JspException {
054
055        String p = getName();
056
057        boolean show = showTagBody(p);
058        if (show) {
059            return TagSupport.EVAL_BODY_INCLUDE;
060        } else {
061            return TagSupport.SKIP_BODY;
062        }
063    }
064
065    protected boolean isPermitted(String p) {
066        return getSubject() != null && getSubject().isPermitted(p);
067    }
068
069    protected abstract boolean showTagBody(String p);
070
071}