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.env;
020    
021    /**
022     * An environment that supports object lookup by name.
023     *
024     * @since 1.2
025     */
026    public interface NamedObjectEnvironment extends Environment {
027    
028        /**
029         * Returns the object in Shiro's environment with the specified name and type or {@code null} if
030         * no object with that name was found.
031         *
032         * @param name the assigned name of the object.
033         * @param requiredType the class to which the discovered object must be assignable.
034         * @param <T> the type of the class
035         * @throws RequiredTypeException if the discovered object does not equal, extend, or implement the specified class.
036         * @return the object in Shiro's environment with the specified name (of the specified type) or {@code null} if
037         * no object with that name was found.
038         */
039        <T> T getObject(String name, Class<T> requiredType) throws RequiredTypeException;
040    }