1 /**
2 *
3 * Copyright 2004 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * 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.geronimo.security.realm;
18
19 import org.apache.geronimo.security.deploy.MapOfSets;
20 import org.apache.geronimo.security.deploy.PrincipalInfo;
21
22
23 /**
24 * Provides a way for security realms to provide reasonable defaults for
25 * principal to role mapping.
26 * <p/>
27 * This interface is used by the deployment code to automatically map
28 * principals to roles.
29 *
30 * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
31 */
32 public interface AutoMapAssistant {
33
34 /**
35 * Provides the realm name of the auto map assistant.
36 * @return the realm name of the auto map assistant
37 */
38 public String getRealmName();
39
40 /**
41 * Provides the default principal to be used when an unauthenticated
42 * subject uses a container.
43 *
44 * @return the default principal
45 */
46 public PrincipalInfo getDefaultPrincipal();
47
48 /**
49 * Provides a set of principal class names to be used when automatically
50 * mapping principals to roles.
51 *
52 * @return a map of logindomain name to set of principal class names
53 */
54 public MapOfSets getAutoMapPrincipalClasses();
55 }