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.authz.Permission;
22
23
24 /**
25 * <tt>PermissionResolver</tt> implementation that returns a new {@link WildcardPermission WildcardPermission}
26 * based on the input string.
27 *
28 * @since 0.9
29 */
30 public class WildcardPermissionResolver implements PermissionResolver {
31 boolean caseSensitive;
32
33 /**
34 * Constructor to specify case sensitivity for the resolved premissions.
35 * @param caseSensitive true if permissions should be case sensitive.
36 */
37 public WildcardPermissionResolver(boolean caseSensitive) {
38 this.caseSensitive=caseSensitive;
39 }
40
41 /**
42 * Default constructor.
43 * Equivalent to calling WildcardPermissionResolver(false)
44 *
45 * @see WildcardPermissionResolver#WildcardPermissionResolver(boolean)
46 */
47 public WildcardPermissionResolver() {
48 this(WildcardPermission.DEFAULT_CASE_SENSITIVE);
49 }
50
51 /**
52 * Set the case sensitivity of the resolved Wildcard permissions.
53 * @param state the caseSensitive flag state for resolved permissions.
54 */
55 public void setCaseSensitive(boolean state) {
56 this.caseSensitive = state;
57 }
58 /**
59 * Return true if this resolver produces case sensitive permissions.
60 * @return true if this resolver produces case sensitive permissions.
61 */
62 public boolean isCaseSensitive() {
63 return caseSensitive;
64 }
65
66 /**
67 * Returns a new {@link WildcardPermission WildcardPermission} instance constructed based on the specified
68 * <tt>permissionString</tt>.
69 *
70 * @param permissionString the permission string to convert to a {@link Permission Permission} instance.
71 * @return a new {@link WildcardPermission WildcardPermission} instance constructed based on the specified
72 * <tt>permissionString</tt>
73 */
74 public Permission resolvePermission(String permissionString) {
75 return new WildcardPermission(permissionString, caseSensitive);
76 }
77 }