View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.om.common;
18  
19  import java.util.List;
20  
21  /***
22   * <p>
23   * SecurityConstraint
24   * </p>
25   * <p>
26   * Used by SecureResource to specify access constraints for
27   * security purposes.
28   *
29   * </p>
30   * @author <a href="mailto:rwatler@finali.com">Randy Watler</a>
31   * @version $Id: SecurityConstraint.java 516448 2007-03-09 16:25:47Z ate $
32   *
33   */
34  public interface SecurityConstraint
35  {   
36      String WILD_CHAR = "*";    
37  
38      /***
39       * <p>
40       * getUsers
41       * </p>
42       *
43       * @return constraint users list as List of String
44       */
45      List getUsers();
46      
47      /***
48       * <p>
49       * setUsers
50       * </p>
51       *
52       * @param users constraint users list as List of String
53       */
54      void setUsers(List users);
55      
56      /***
57       * <p>
58       * getRoles
59       * </p>
60       *
61       * @return constraint roles list as List of String
62       */
63      List getRoles();
64      
65      /***
66       * <p>
67       * setRoles
68       * </p>
69       *
70       * @param roles constraint roles list as List of String
71       */
72      void setRoles(List roles);
73      
74      /***
75       * <p>
76       * getGroups
77       * </p>
78       *
79       * @return constraint groups list as List of String
80       */
81      List getGroups();
82      
83      /***
84       * <p>
85       * setGroups
86       * </p>
87       *
88       * @param groups constraint groups list as List of String
89       */
90      void setGroups(List groups);
91      
92      /***
93       * <p>
94       * getPermissions
95       * </p>
96       *
97       * @return constraint permissions list as List of String
98       */
99      List getPermissions();
100     
101     /***
102      * <p>
103      * setPermissions
104      * </p>
105      *
106      * @param permissions constraint permissions list as List of String
107      */
108     void setPermissions(List permissions);
109 }