org.acegisecurity.vote.LabeledData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acegi-security

The newest version!

/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.acegisecurity.vote;

/**
 * This interface indicates data objects that carry a label. The purpose is to support
 * the {@link LabelBasedAclVoter}. When it votes, it evaluates all method arguments
 * tagged with this interface, and votes if they match the user's granted authorities list.
 *
 * @author Greg Turnquist
 */
public interface LabeledData {
    //~ Methods ========================================================================================================

    /**
     * Retrieve the domain object's data label. NOTE: This implementation only supports one data label per
     * object.
     *
     * @return The label value of data object as a string.
     */
    String getLabel();
}