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.security;
18  
19  import java.util.List;
20  
21  /***
22   * <p>
23   * Configures the policies.  Instantiates the <code>SecurityPolicies</code> with the security policies
24   * that need to be enforced.  It will add the default policy already configured as well as the engine policies
25   * used to enforce permission checks.
26   * </p>
27   * 
28   * @author <a href="mailto:dlestrat@apache.org">David Le Strat </a>
29   */
30  public interface AuthorizationProvider
31  {
32      /***
33       * <p>
34       * The list of configured policies.
35       * </p>
36       * 
37       * @return The list of policies.
38       */
39      List getPolicies();
40      
41      
42      /***
43       * <p>
44       * Whether to use the default policy or not in addition to the Policies configured for the AuthorizationProvider.
45       * </p>
46       * 
47       * @param whetherToUseDefaultPolicy Boolean false: does not use the default policy, true: does.
48       */
49      void useDefaultPolicy(boolean whetherToUseDefaultPolicy);
50  }