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.authz.Permission;
022
023
024/**
025 * <tt>PermissionResolver</tt> implementation that returns a new {@link WildcardPermission WildcardPermission}
026 * based on the input string.
027 *
028 * @since 0.9
029 */
030public class WildcardPermissionResolver implements PermissionResolver {
031    boolean caseSensitive;
032
033    /**
034     * Constructor to specify case sensitivity for the resolved permissions.
035     *
036     * @param caseSensitive true if permissions should be case sensitive.
037     */
038    public WildcardPermissionResolver(boolean caseSensitive) {
039        this.caseSensitive = caseSensitive;
040    }
041
042    /**
043     * Default constructor.
044     * Equivalent to calling WildcardPermissionResolver(false)
045     *
046     * @see WildcardPermissionResolver#WildcardPermissionResolver(boolean)
047     */
048    public WildcardPermissionResolver() {
049        this(WildcardPermission.DEFAULT_CASE_SENSITIVE);
050    }
051
052    /**
053     * Set the case sensitivity of the resolved Wildcard permissions.
054     *
055     * @param state the caseSensitive flag state for resolved permissions.
056     */
057    public void setCaseSensitive(boolean state) {
058        this.caseSensitive = state;
059    }
060
061    /**
062     * Return true if this resolver produces case sensitive permissions.
063     *
064     * @return true if this resolver produces case sensitive permissions.
065     */
066    public boolean isCaseSensitive() {
067        return caseSensitive;
068    }
069
070    /**
071     * Returns a new {@link WildcardPermission WildcardPermission} instance constructed based on the specified
072     * <tt>permissionString</tt>.
073     *
074     * @param permissionString the permission string to convert to a {@link Permission Permission} instance.
075     * @return a new {@link WildcardPermission WildcardPermission} instance constructed based on the specified
076     * <tt>permissionString</tt>
077     */
078    public Permission resolvePermission(String permissionString) {
079        return new WildcardPermission(permissionString, caseSensitive);
080    }
081}