| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| SecurityCacheLoader | 39 | 0 | - | 0 | 0 |
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.security.authorization.cache; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.Role; | |
| 23 | import org.xwiki.security.SecurityReference; | |
| 24 | import org.xwiki.security.UserSecurityReference; | |
| 25 | import org.xwiki.security.authorization.AuthorizationException; | |
| 26 | import org.xwiki.security.authorization.SecurityAccessEntry; | |
| 27 | ||
| 28 | /** | |
| 29 | * Loads access and rule entries into the security cache. | |
| 30 | * It depends on a {@link org.xwiki.security.authorization.SecurityEntryReader} | |
| 31 | * for reading rules missing from the cache, and on a | |
| 32 | * {@link org.xwiki.security.authorization.AuthorizationSettler} for resolving | |
| 33 | * access from rules. | |
| 34 | * | |
| 35 | * @version $Id: 21c4c5c6d178607cff5a26ef1f692e3d03401392 $ | |
| 36 | * @since 4.0M2 | |
| 37 | */ | |
| 38 | @Role | |
| 39 | public interface SecurityCacheLoader | |
| 40 | { | |
| 41 | /** | |
| 42 | * Load the cache with the required entries to look up the access | |
| 43 | * for a given user on a given entity. | |
| 44 | * | |
| 45 | * @param user The user to check access for. | |
| 46 | * @param entity The entity to check access to. | |
| 47 | * @return The resulting access level for the user at the entity. | |
| 48 | * @exception org.xwiki.security.authorization.AuthorizationException if an error occurs. | |
| 49 | */ | |
| 50 | SecurityAccessEntry load(UserSecurityReference user, SecurityReference entity) | |
| 51 | throws AuthorizationException; | |
| 52 | } |