001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.aci;
021
022
023import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesAndValuesItem;
024import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesItem;
025import org.apache.directory.api.ldap.aci.protectedItem.EntryItem;
026
027
028/**
029 * Defines the items to which the access controls apply.  It's one of the
030 * following elements :
031 * <ul>
032 * <li>AllAttributeValuesItem</li>
033 * <li>AllUserAttributeTypesAndValuesItem</li>
034 * <li>AllUserAttributeTypesItem</li>
035 * <li>AttributeTypeItem</li>
036 * <li>AttributeValueItem</li>
037 * <li>ClassesItem</li>
038 * <li>EntryItem</li>
039 * <li>MaxImmSubItem</li>
040 * <li>MaxValueCountItem</li>
041 * <li>RangeOfValuesItem</li>
042 * <li>RestrictedByItem</li>
043 * <li>SelfValueItem</li>
044 * </ul>
045 * 
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public abstract class ProtectedItem
049{
050    /**
051     * The entry contents as a whole. In case of a family member, it also means
052     * the entry content of each subordinate family member within the same
053     * compound attribute. It does not necessarily include the information in
054     * these entries. This element shall be ignored if the classes element is
055     * present, since this latter element selects protected entries (and
056     * subordinate family members) on the basis of their object class.
057     */
058    public static final EntryItem ENTRY = new EntryItem();
059
060    /**
061     * All user attribute type information associated with the entry, but not
062     * values associated with those attributes.
063     */
064    public static final AllUserAttributeTypesItem ALL_USER_ATTRIBUTE_TYPES = new AllUserAttributeTypesItem();
065
066    /**
067     * All user attribute information associated with the entry, including all
068     * values of all user attributes.
069     */
070    public static final AllUserAttributeTypesAndValuesItem ALL_USER_ATTRIBUTE_TYPES_AND_VALUES = new AllUserAttributeTypesAndValuesItem();
071
072
073    /**
074     * Creates a new instance.
075     */
076    protected ProtectedItem()
077    {
078    }
079}