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.authz.permission;
020
021import org.apache.shiro.lang.ShiroException;
022
023
024/**
025 * Thrown by {@link PermissionResolver#resolvePermission(String)} when the String being parsed is not
026 * valid for that resolver.
027 *
028 * @since 0.9
029 */
030public class InvalidPermissionStringException extends ShiroException {
031
032    private final String permissionString;
033
034    /**
035     * Constructs a new exception with the given message and permission string.
036     *
037     * @param message          the exception message.
038     * @param permissionString the invalid permission string.
039     */
040    public InvalidPermissionStringException(String message, String permissionString) {
041        super(message);
042        this.permissionString = permissionString;
043    }
044
045    /**
046     * Returns the permission string that was invalid and caused this exception to
047     * be thrown.
048     *
049     * @return the permission string.
050     */
051    public String getPermissionString() {
052        return this.permissionString;
053    }
054
055
056}