af0feb041809d95b08c5f419f62396d8a2aefa48
[utils] / security / impl / src / main / java / org / wamblee / security / authorization / UserCondition.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16 package org.wamblee.security.authorization;
17
18 import org.wamblee.security.authentication.UserAdministration;
19
20 /**
21  * Condition used to match a user against a specified set of users.
22  * 
23  * @author Erik Brakkee
24  */
25 public interface UserCondition {
26     
27     /**
28      * Sets the user administration object. 
29      * @param aAdmin User administration.
30      */
31     void setUserAdmin(UserAdministration aAdmin);
32
33     /**
34      * Determines if the condition matches.
35      * 
36      * @param aUser
37      *            user to check.
38      * 
39      * @return True if the condition matches, false otherwise.
40      */
41     boolean matches(String aUser);
42
43 }