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     */
019    package org.apache.shiro.authz.permission;
020    
021    import org.apache.shiro.authz.Permission;
022    
023    import java.util.Collection;
024    
025    /**
026     * A RolePermissionResolver resolves a String value and converts it into a Collection of
027     * {@link org.apache.shiro.authz.Permission} instances.
028     * <p/>
029     * In some cases a {@link org.apache.shiro.realm.Realm} my only be able to return a list of roles.  This
030     * component allows an application to resolve the roles into permissions.
031     *
032     * @author Brian Demers
033     */
034    public interface RolePermissionResolver {
035    
036        /**
037         * Resolves a Collection of Permissions based on the given String representation.
038         *
039         * @param roleString the String representation of a role name to resolve.
040         * @return a Collection of Permissions based on the given String representation.
041         */
042        Collection<Permission> resolvePermissionsInRole(String roleString);
043    
044    }