View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.aci;
21  
22  
23  import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesAndValuesItem;
24  import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesItem;
25  import org.apache.directory.api.ldap.aci.protectedItem.EntryItem;
26  
27  
28  /**
29   * Defines the items to which the access controls apply.  It's one of the
30   * following elements :
31   * <ul>
32   * <li>AllAttributeValuesItem</li>
33   * <li>AllUserAttributeTypesAndValuesItem</li>
34   * <li>AllUserAttributeTypesItem</li>
35   * <li>AttributeTypeItem</li>
36   * <li>AttributeValueItem</li>
37   * <li>ClassesItem</li>
38   * <li>EntryItem</li>
39   * <li>MaxImmSubItem</li>
40   * <li>MaxValueCountItem</li>
41   * <li>RangeOfValuesItem</li>
42   * <li>RestrictedByItem</li>
43   * <li>SelfValueItem</li>
44   * </ul>
45   * 
46   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
47   */
48  public abstract class ProtectedItem
49  {
50      /**
51       * The entry contents as a whole. In case of a family member, it also means
52       * the entry content of each subordinate family member within the same
53       * compound attribute. It does not necessarily include the information in
54       * these entries. This element shall be ignored if the classes element is
55       * present, since this latter element selects protected entries (and
56       * subordinate family members) on the basis of their object class.
57       */
58      public static final EntryItem ENTRY = new EntryItem();
59  
60      /**
61       * All user attribute type information associated with the entry, but not
62       * values associated with those attributes.
63       */
64      public static final AllUserAttributeTypesItem ALL_USER_ATTRIBUTE_TYPES = new AllUserAttributeTypesItem();
65  
66      /**
67       * All user attribute information associated with the entry, including all
68       * values of all user attributes.
69       */
70      public static final AllUserAttributeTypesAndValuesItem ALL_USER_ATTRIBUTE_TYPES_AND_VALUES = new AllUserAttributeTypesAndValuesItem();
71  
72  
73      /**
74       * Creates a new instance.
75       */
76      protected ProtectedItem()
77      {
78      }
79  }