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   */
28  public final class OperationScope
29  {
30      /**
31       * An operation that affects the whole entry.
32       */
33      public static final OperationScoper/core/authz/support/OperationScope.html#OperationScope">OperationScope ENTRY = new OperationScope( "Entry" );
34  
35      /**
36       * An operation that affects all values in an attribute type.
37       */
38      public static final OperationScopethz/support/OperationScope.html#OperationScope">OperationScope ATTRIBUTE_TYPE = new OperationScope( "Attribute Type" );
39  
40      /**
41       * An operation that affects the specific value in an attribute type.
42       */
43      public static final OperationScopet/OperationScope.html#OperationScope">OperationScope ATTRIBUTE_TYPE_AND_VALUE = new OperationScope( "Attribute Type & Value" );
44  
45      private final String name;
46  
47  
48      private OperationScope( String name )
49      {
50          this.name = name;
51      }
52  
53  
54      /**
55       * @return the name of this scope.
56       */
57      public String getName()
58      {
59          return name;
60      }
61  
62  
63      /**
64       * Returns the name of this scope.
65       */
66      @Override
67      public String toString()
68      {
69          return name;
70      }
71  }