/*
   Copyright 2013 Nationale-Nederlanden

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
package nl.nn.adapterframework.configuration;

/**
 * Generic factory for instantiating beans from the Digester framework.
 *
 * <p>
 * This factory uses the name of the current element for name of the bean,
 * instead of hard-wiring a bean name. The name of current element is prefixed
 * with the string "proto-", to prevent unwanted auto-wiring cascaded of
 * other prototype beans defined in the Spring Factory which are supposed to
 * be defined in the IBIS Configuration File.
 * </p>
 * <p>
 * If a className attribute is specified in the configuration file, then
 * this is used together with the bean-name to find the bean to be
 * instantiated from the Spring Factory (see the rules laid out in
 * {@link AbstractSpringPoweredDigesterFactory}.
 * In particular, the bean-name is ignored when the class-name is specified
 * and the Spring Factory contains exactly 1 bean-definition for that
 * class.
 * </p>
 * <p>
 * This is useful for those kinds of rules in the digester-rules.xml where
 * the className was always mandatory in older versions, but also for those rules
 * where className is never specified and only 1 possible implementation
 * exists.
 * </p>
 * <p>
 * NB: The Apache Digester cannot read a factory-create-rule from XML and supply
 * parameters to the factory created from the XML digester-rules, so there is
 * no way to configure a factory instance with a bean-name from the digester-rules.
 * </p>
 *
 * @author  Tim van der Leeuw
 * @since   4.8
 */
public class GenericFactory extends AbstractSpringPoweredDigesterFactory {

    /**
     * Return name of current element prefixed with the string "proto-" as
     * bean-name.
     *
     * @see nl.nn.adapterframework.configuration.AbstractSpringPoweredDigesterFactory#getSuggestedBeanName()
     */
    @Override
    public String getSuggestedBeanName() {
        return "proto-" + getDigester().getCurrentElementName();
    }

}