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 import java.util.Collection;
24
25 /**
26 * A RolePermissionResolver resolves a String value and converts it into a Collection of
27 * {@link org.apache.shiro.authz.Permission} instances.
28 * <p/>
29 * In some cases a {@link org.apache.shiro.realm.Realm} my only be able to return a list of roles. This
30 * component allows an application to resolve the roles into permissions.
31 *
32 */
33 public interface RolePermissionResolver {
34
35 /**
36 * Resolves a Collection of Permissions based on the given String representation.
37 *
38 * @param roleString the String representation of a role name to resolve.
39 * @return a Collection of Permissions based on the given String representation.
40 */
41 Collection<Permission> resolvePermissionsInRole(String roleString);
42
43 }