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    package org.apache.geronimo.security.jaas;
018    
019    import org.apache.geronimo.security.jaas.server.JaasLoginModuleConfiguration;
020    
021    
022    /**
023     * A factory interface used by <code>GeronimoLoginConfiguration</code> to obtain
024     * <code>JaasLoginModuleConfiguration</code>s from GBean configuration entries.
025     *
026     * @version $Rev: 487175 $ $Date: 2006-12-14 03:10:31 -0800 (Thu, 14 Dec 2006) $
027     * @see GeronimoLoginConfiguration
028     * @see DirectConfigurationEntry
029     * @see ServerRealmConfigurationEntry
030     */
031    public interface ConfigurationEntryFactory {
032    
033        /**
034         * Used to obtain the configuration name to be associated with the generated
035         * <code>JaasLoginModuleConfiguration</code>.
036         *
037         * @return the configuration name
038         */
039        public String getConfigurationName();
040    
041        /**
042         * Generate a <code>JaasLoginModuleConfiguration</code>
043         *
044         * @return a <code>JaasLoginModuleConfiguration</code>
045         */
046        public JaasLoginModuleConfiguration generateConfiguration();
047    
048    }