001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  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    
018    package org.apache.geronimo.security.realm;
019    
020    import org.apache.geronimo.security.jaas.JaasLoginModuleChain;
021    
022    
023    /**
024     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
025     */
026    public interface SecurityRealm extends org.apache.geronimo.management.geronimo.SecurityRealm {
027    
028        /**
029         * If this attribute is true, then the principals will be wrapped in
030         * realm principals.
031         */
032        public boolean isWrapPrincipals();
033    
034        /**
035         * Gets a list of the login domains that make up this security realm.  A
036         * particular LoginModule represents 0 or 1 login domains, and a realm is
037         * composed of a number of login modules, so the realm may cover any
038         * number of login domains, though typically that number will be 1.
039         */
040        public String[] getLoginDomains();
041    
042        /**
043         * Gets the first JaasLoginModuleChain node in the chain of LoginModules
044         * for this realm.
045         */
046        public JaasLoginModuleChain getLoginModuleChain();
047    }