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   * SecurityConstraints
24   * </p>
25   * <p>
26   * Used to specify security constraints for a resource.
27   *
28   * </p>
29   * @author <a href="mailto:rwatler@finali.com">Randy Watler</a>
30   * @version $Id: SecurityConstraints.java 516448 2007-03-09 16:25:47Z ate $
31   *
32   */
33  public interface SecurityConstraints
34  {   
35      /***
36       * <p>
37       * getOwner
38       * </p>
39       *
40       * @return owner constraint for resource 
41       */
42      String getOwner();
43      
44      /***
45       * <p>
46       * setOwner
47       * </p>
48       *
49       * @param owner constraint for resource
50       */
51      void setOwner(String owner);
52  
53      /***
54       * <p>
55       * getSecurityConstraints
56       * </p>
57       *
58       * @return security constraints list for resource
59       */
60      List getSecurityConstraints();
61      
62      /***
63       * <p>
64       * setSecurityConstraint
65       * </p>
66       *
67       * @param constraints security constraints for resource
68       */
69      void setSecurityConstraints(List constraints);
70  
71      /***
72       * <p>
73       * getSecurityConstraintsRefs
74       * </p>
75       *
76       * @return security constraints references for resource
77       */
78      List getSecurityConstraintsRefs();
79      
80      /***
81       * <p>
82       * setSecurityConstraintsRefs
83       * </p>
84       *
85       * @param constraintsRefs security constraints references for resource
86       */
87      void setSecurityConstraintsRefs(List constraintsRefs);
88  
89      /***
90       * <p>
91       * isEmpty
92       * </p>
93       *
94       * @return flag indicating whether there are constraints or owner set
95       */
96      boolean isEmpty();
97  }