01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * Unless required by applicable law or agreed to in writing, software
10: * distributed under the License is distributed on an "AS IS" BASIS,
11: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: * See the License for the specific language governing permissions and
13: * limitations under the License.
14: */
15:
16: package org.acegisecurity.vote;
17:
18: /**
19: * This interface indicates data objects that carry a label. The purpose is to support
20: * the {@link LabelBasedAclVoter}. When it votes, it evaluates all method arguments
21: * tagged with this interface, and votes if they match the user's granted authorities list.
22: *
23: * @author Greg Turnquist
24: */
25: public interface LabeledData {
26: //~ Methods ========================================================================================================
27:
28: /**
29: * Retrieve the domain object's data label. NOTE: This implementation only supports one data label per
30: * object.
31: *
32: * @return The label value of data object as a string.
33: */
34: String getLabel();
35: }
|