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.server.core.authz.support;
021
022
023/**
024 * An enumeration that represents the scope of user operation.
025 *
026 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027 */
028public final class OperationScope
029{
030    /**
031     * An operation that affects the whole entry.
032     */
033    public static final OperationScope ENTRY = new OperationScope( "Entry" );
034
035    /**
036     * An operation that affects all values in an attribute type.
037     */
038    public static final OperationScope ATTRIBUTE_TYPE = new OperationScope( "Attribute Type" );
039
040    /**
041     * An operation that affects the specific value in an attribute type.
042     */
043    public static final OperationScope ATTRIBUTE_TYPE_AND_VALUE = new OperationScope( "Attribute Type & Value" );
044
045    private final String name;
046
047
048    private OperationScope( String name )
049    {
050        this.name = name;
051    }
052
053
054    /**
055     * @return the name of this scope.
056     */
057    public String getName()
058    {
059        return name;
060    }
061
062
063    /**
064     * Returns the name of this scope.
065     */
066    @Override
067    public String toString()
068    {
069        return name;
070    }
071}