org.acegisecurity.acl.basic.cache.BasicAclEntryHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acegi-security
There is a newer version: 1.0.7
/* Copyright 2004 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.cache;

import org.acegisecurity.acl.basic.BasicAclEntry;

import java.io.Serializable;

import org.springframework.util.Assert;


/**
 * Used by {@link EhCacheBasedAclEntryCache} to store the array of
 * BasicAclEntrys in the cache.
 * 
 * 
 * This is necessary because caches store a single object per key, not an
 * array.
 * 
 * 
 * 
 * This class uses value object semantics. ie: construction-based
 * initialisation without any setters for the properties.
 * 
 *
 * @author Ben Alex
 * @version $Id: BasicAclEntryHolder.java,v 1.3 2005/11/17 00:56:47 benalex Exp $
 */
public class BasicAclEntryHolder implements Serializable {
    //~ Instance fields ========================================================

    private BasicAclEntry[] basicAclEntries;

    //~ Constructors ===========================================================

    /**
     * Constructs the BasicAclEntryHolder.
     *
     * @param aclEntries to cache (any nulls will cause an
     *        exception, which should not be a problem as the contract for
     *        BasicAclEntryCache allows exceptions if
     *        nulls are presented)
     *
     * @throws IllegalArgumentException if a null exists anywhere
     *         in the aclEntries or if a null is
     *         passed to the constructor
     */
    public BasicAclEntryHolder(BasicAclEntry[] aclEntries) {
        Assert.notNull(aclEntries, "aclEntries cannot be null");

        for (int i = 0; i < aclEntries.length; i++) {
            Assert.notNull(aclEntries[i], "aclEntries cannot be null");
        }

        this.basicAclEntries = aclEntries;
    }

    //~ Methods ================================================================

    public BasicAclEntry[] getBasicAclEntries() {
        return basicAclEntries;
    }
}