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 javax.security.auth.login.AppConfigurationEntry;
020    
021    
022    /**
023     * A factory interface used by <code>GeronimoLoginConfiguration</code> to obtain
024     * <code>AppConfigurationEntry[]</code>s from GBean configuration entries.
025     *
026     * @version $Rev: 706640 $ $Date: 2008-10-21 14:44:05 +0000 (Tue, 21 Oct 2008) $
027     * @see GeronimoLoginConfiguration
028     * @see DirectConfigurationEntry
029     */
030    public interface ConfigurationEntryFactory {
031    
032        /**
033         * Used to obtain the configuration name to be associated with the generated
034         * <code>AppConfigurationEntry</code> array.
035         *
036         * @return the configuration name
037         */
038        public String getConfigurationName();
039    
040        /**
041         * Generate the <code>AppConfigurationEntry</code> array for the login modules in this configuration.
042         *
043         * @return a <code>AppConfigurationEntry[]</code>
044         */
045        AppConfigurationEntry[] getAppConfigurationEntries();
046    
047    }