001    /**
002     *
003     * Copyright 2004 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.security.realm;
018    
019    import org.apache.geronimo.security.deploy.MapOfSets;
020    import org.apache.geronimo.security.deploy.PrincipalInfo;
021    
022    
023    /**
024     * Provides a way for security realms to provide reasonable defaults for
025     * principal to role mapping.
026     * <p/>
027     * This interface is used by the deployment code to automatically map
028     * principals to roles.
029     *
030     * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
031     */
032    public interface AutoMapAssistant {
033    
034        /**
035         * Provides the realm name of the auto map assistant.
036         * @return the realm name of the auto map assistant
037         */
038        public String getRealmName();
039    
040        /**
041         * Provides the default principal to be used when an unauthenticated
042         * subject uses a container.
043         *
044         * @return the default principal
045         */
046        public PrincipalInfo getDefaultPrincipal();
047    
048        /**
049         * Provides a set of principal class names to be used when automatically
050         * mapping principals to roles.
051         *
052         * @return a map of logindomain name to set of principal class names
053         */
054        public MapOfSets getAutoMapPrincipalClasses();
055    }