Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
NamedObjectEnvironment |
|
| 1.0;1 |
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.env; | |
20 | ||
21 | /** | |
22 | * An environment that supports object lookup by name. | |
23 | * | |
24 | * @since 1.2 | |
25 | */ | |
26 | public interface NamedObjectEnvironment extends Environment { | |
27 | ||
28 | /** | |
29 | * Returns the object in Shiro's environment with the specified name and type or {@code null} if | |
30 | * no object with that name was found. | |
31 | * | |
32 | * @param name the assigned name of the object. | |
33 | * @param requiredType the class to which the discovered object must be assignable. | |
34 | * @param <T> the type of the class | |
35 | * @throws RequiredTypeException if the discovered object does not equal, extend, or implement the specified class. | |
36 | * @return the object in Shiro's environment with the specified name (of the specified type) or {@code null} if | |
37 | * no object with that name was found. | |
38 | */ | |
39 | <T> T getObject(String name, Class<T> requiredType) throws RequiredTypeException; | |
40 | } |