phaselistenerbeandefinitionparser.java

Please read your package and describe it at least 40 bytes in English. System will automatically de

/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * 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 de.mindmatters.faces.spring.factory.xml;

import javax.faces.lifecycle.LifecycleFactory;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.parsing.BeanComponentDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.w3c.dom.Element;

/**
 * {@link org.springframework.beans.factory.xml.BeanDefinitionParser}
 * implementation for parsing '<code>phase-listener</code>' tags and
 * creating {@link javax.faces.event.PhaseListener} definitions.
 * 
 * @author Andreas Kuhrwahl
 * 
 */
final class PhaseListenerBeanDefinitionParser implements BeanDefinitionParser {

    /**
     * {@inheritDoc}
     */
    public BeanDefinition parse(final Element element,
            final ParserContext parserContext) {
        BeanDefinitionHolder phaseListener = parserContext.getDelegate()
                .parseBeanDefinitionElement(element);
        if (phaseListener != null) {
            parserContext.getDelegate().decorateBeanDefinitionIfRequired(
                    element, phaseListener);
            BeanDefinitionReaderUtils.registerBeanDefinition(phaseListener,
                    parserContext.getRegistry());
            registerPhaseListenerDefinition(
                    element
                            .getAttribute(JsfBeanDefinitionParserUtils.LIFECYCLE_ID_ATTRIBUTE),
                    phaseListener.getBeanDefinition(), parserContext);
            parserContext.getReaderContext().fireComponentRegistered(
                    new BeanComponentDefinition(phaseListener));
        }
        return null;
    }

    /**
     * Registers a {@link PhaseListenerDefinition}.
     * 
     * @param id
     *            the lifecycle-id
     * @param phaseListener
     *            the {@link javax.faces.event.PhaseListener} bean definition
     * @param parserContext
     *            the {@link ParserContext}
     */
    private void registerPhaseListenerDefinition(final String id,
            final BeanDefinition phaseListener,
            final ParserContext parserContext) {
        String lifecycleId = id;
        if (lifecycleId == null) {
            lifecycleId = LifecycleFactory.DEFAULT_LIFECYCLE;
        }
        BeanDefinitionBuilder builder = BeanDefinitionBuilder
                .rootBeanDefinition(PhaseListenerDefinition.class);
        builder.addConstructorArg(lifecycleId);
        builder.addConstructorArg(phaseListener);
        builder.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
        BeanDefinitionReaderUtils.registerWithGeneratedName(builder
                .getBeanDefinition(), parserContext.getRegistry());
    }

}