View Javadoc

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.jaas;
18  
19  import org.apache.geronimo.security.jaas.server.JaasLoginModuleConfiguration;
20  
21  
22  /**
23   * A factory interface used by <code>GeronimoLoginConfiguration</code> to obtain
24   * <code>JaasLoginModuleConfiguration</code>s from GBean configuration entries.
25   *
26   * @version $Rev: 355877 $ $Date: 2005-12-10 18:48:27 -0800 (Sat, 10 Dec 2005) $
27   * @see GeronimoLoginConfiguration
28   * @see DirectConfigurationEntry
29   * @see ServerRealmConfigurationEntry
30   */
31  public interface ConfigurationEntryFactory {
32  
33      /**
34       * Used to obtain the configuration name to be associated with the generated
35       * <code>JaasLoginModuleConfiguration</code>.
36       *
37       * @return the configuration name
38       */
39      public String getConfigurationName();
40  
41      /**
42       * Generate a <code>JaasLoginModuleConfiguration</code>
43       *
44       * @return a <code>JaasLoginModuleConfiguration</code>
45       */
46      public JaasLoginModuleConfiguration generateConfiguration();
47  
48  }