View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.authz.permission;
20  
21  import org.apache.shiro.ShiroException;
22  
23  
24  /**
25   * Thrown by {@link PermissionResolver#resolvePermission(String)} when the String being parsed is not
26   * valid for that resolver.
27   *
28   * @since 0.9
29   */
30  public class InvalidPermissionStringException extends ShiroException
31  {
32  
33      private String permissionString;
34  
35      /**
36       * Constructs a new exception with the given message and permission string.
37       *
38       * @param message          the exception message.
39       * @param permissionString the invalid permission string.
40       */
41      public InvalidPermissionStringException(String message, String permissionString) {
42          super(message);
43          this.permissionString = permissionString;
44      }
45  
46      /**
47       * Returns the permission string that was invalid and caused this exception to
48       * be thrown.
49       *
50       * @return the permission string.
51       */
52      public String getPermissionString() {
53          return this.permissionString;
54      }
55  
56  
57  }