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 org.apache.jetspeed.security.spi.GroupSecurityHandler;
20  import org.apache.jetspeed.security.spi.RoleSecurityHandler;
21  import org.apache.jetspeed.security.spi.SecurityMappingHandler;
22  
23  /***
24   * <p>
25   * Utility component used to configure the security component and provide access
26   * to the various security handlers.
27   * </p>
28   * 
29   * @author <a href="mailto:dlestrat@apache.org">David Le Strat </a>
30   */
31  public interface SecurityProvider
32  {
33      /***
34       * <p>
35       * Getter for the {@link AuthenticationProviderProxy}
36       * </p>
37       * 
38       * @return The {@link AuthenticationProviderProxy}.
39       */
40      AuthenticationProviderProxy getAuthenticationProviderProxy();
41  
42      /***
43       * <p>
44       * Getter for the {@link RoleSecurityHandler}
45       * </p>
46       * 
47       * @return The RoleSecurityHandler.
48       */
49      RoleSecurityHandler getRoleSecurityHandler();
50  
51      /***
52       * <p>
53       * Getter for the {@link GroupSecurityHandler}
54       * </p>
55       * 
56       * @return The GroupSecurityHandler.
57       */
58      GroupSecurityHandler getGroupSecurityHandler();
59  
60      /***
61       * <p>
62       * Gettter for the {@link SecurityMappingHandler}
63       * </p>
64       * 
65       * @return The SecurityMappingHandler.
66       */
67      SecurityMappingHandler getSecurityMappingHandler();
68  
69  }