All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.acegisecurity.acl.basic.BasicAclEntryCache Maven / Gradle / Ivy

There is a newer version: 1.0.7
Show newest version
/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.acl.basic;

/**
 * Provides a cache of {@link BasicAclEntry} objects.
 * 
 * 

* Implementations should provide appropriate methods to set their cache * parameters (eg time-to-live) and/or force removal of entities before their * normal expiration. These are not part of the * BasicAclEntryCache interface contract because they vary * depending on the type of caching system used (eg in-memory vs disk vs * cluster vs hybrid). *

* * @author Ben Alex * @version $Id: BasicAclEntryCache.java,v 1.3 2006/01/27 04:42:39 benalex Exp $ */ public interface BasicAclEntryCache { //~ Methods ================================================================ /** * Obtains an array of {@link BasicAclEntry}s from the cache. * * @param aclObjectIdentity which should be obtained from the cache * * @return any applicable BasicAclEntrys (no * nulls are permitted in the returned array) or * null if the object identity could not be found or * if the cache entry has expired */ public BasicAclEntry[] getEntriesFromCache( AclObjectIdentity aclObjectIdentity); /** * Places an array of {@link BasicAclEntry}s in the cache. * *

* No nulls are allowed in the passed array. If any * null is passed, the implementation may throw an exception. *

* * @param basicAclEntry the ACL entries to cache (the key will be extracted * from the {@link BasicAclEntry#getAclObjectIdentity()} method */ public void putEntriesInCache(BasicAclEntry[] basicAclEntry); /** * Removes all ACL entries related to an {@link AclObjectIdentity} from the * cache. * * @param aclObjectIdentity which should be removed from the cache */ public void removeEntriesFromCache(AclObjectIdentity aclObjectIdentity); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy