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.server.core.authz.support;
21  
22  
23  /**
24   * An enumeration that represents the scope of user operation.
25   *
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   * @version $Rev: 437012 $, $Date: 2006-08-26 01:25:30 +0200 (Sa, 26 Aug 2006) $
28   */
29  public class OperationScope
30  {
31      /**
32       * An operation that affects the whole entry.
33       */
34      public static final OperationScope ENTRY = new OperationScope( "Entry" );
35  
36      /**
37       * An operation that affects all values in an attribute type.
38       */
39      public static final OperationScope ATTRIBUTE_TYPE = new OperationScope( "Attribute Type" );
40  
41      /**
42       * An operation that affects the specific value in an attribute type.
43       */
44      public static final OperationScope ATTRIBUTE_TYPE_AND_VALUE = new OperationScope( "Attribute Type & Value" );
45  
46      private final String name;
47  
48  
49      private OperationScope(String name)
50      {
51          this.name = name;
52      }
53  
54  
55      /**
56       * Return the name of this scope.
57       */
58      public String getName()
59      {
60          return name;
61      }
62  
63  
64      /**
65       * Returns the name of this scope.
66       */
67      public String toString()
68      {
69          return name;
70      }
71  }