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.page;
18  
19  import java.util.List;
20  
21  /***
22   * <p>
23   * Security
24   * </p>
25   * <p>
26   * Used to define named collections of SecurityConstraint objects.
27   *
28   * </p>
29   * @author <a href="mailto:rwatler@finali.com">Randy Watler</a>
30   * @version $Id: PageSecurity.java 516448 2007-03-09 16:25:47Z ate $
31   *
32   */
33  public interface PageSecurity extends Document
34  {   
35      String DOCUMENT_TYPE = "page.security";
36      
37      /***
38       * <p>
39       * getSecurityConstraintsDefs
40       * </p>
41       *
42       * @return security constraints definitions of type SecurityConstraintsDef
43       */
44      List getSecurityConstraintsDefs();
45      
46      /***
47       * <p>
48       * newSecurityConstraintsDef
49       * </p>
50       *
51       * @return a newly created SecurityConstraintsDef object for use in PageSecurity
52       */
53      SecurityConstraintsDef newSecurityConstraintsDef();
54  
55      /***
56       * <p>
57       * setSecurityConstraintsDefs
58       * </p>
59       *
60       * @param defintions security constraints definitions
61       */
62      void setSecurityConstraintsDefs(List definitions);
63  
64      /***
65       * <p>
66       * getSecurityConstraintsDef
67       * </p>
68       *
69       * @param name of security constraints definition to return
70       * @return security constraints definition
71       */
72      SecurityConstraintsDef getSecurityConstraintsDef(String name);
73  
74      /***
75       * <p>
76       * getGlobalSecurityConstraintsRefs
77       * </p>
78       *
79       * @return global security constraints references of element type String
80       */
81      List getGlobalSecurityConstraintsRefs();
82      
83      /***
84       * <p>
85       * setGlobalSecurityConstraintsRefs
86       * </p>
87       *
88       * @param constraintsRefs global security constraints references
89       */
90      void setGlobalSecurityConstraintsRefs(List constraintsRefs);
91  }