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 /***
20 * <p>Utility component used as a bridge between the login module and the security component.</p>
21 *
22 * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
23 */
24 public interface LoginModuleProxy
25 {
26 /***
27 * <p>Default .portal user role name</p>
28 */
29 String DEFAULT_PORTAL_USER_ROLE_NAME = "portal-user";
30
31 /***
32 * <p>Getter for the {@link UserManager}.</p>
33 * @return The UserManager.
34 */
35 UserManager getUserManager();
36
37 /***
38 * <p>Getter for the required portal user role name.</p>
39 *
40 * <p>Used in web.xml authorization to detect authenticated portal users.</p>
41 *
42 * @return The portal user role name.
43 */
44 String getPortalUserRole();
45 }