com.consol.citrus.admin.service.spring.filter.GetSpringBeansFilter.java Source code

Introduction

Here is the source code for com.consol.citrus.admin.service.spring.filter.GetSpringBeansFilter.java

Source

/*
 * Copyright 2006-2016 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 com.consol.citrus.admin.service.spring.filter;

import org.springframework.util.xml.DomUtils;
import org.w3c.dom.Element;
import org.w3c.dom.traversal.NodeFilter;

import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchema;
import java.util.*;

/**
 * Filter searches for all Spring bean definitions of specific type in a Spring XML application context. Bean definition type is 
 * identified by JaxB root element annotation name. Element name must match this annotation value in order to qualify for this filter.
 * 
 * @author Christoph Deppisch
 */
public class GetSpringBeansFilter extends AbstractSpringBeanFilter {

    /** Element type name */
    private String elementName;

    /** Element namespace to look for */
    private String elementNamespace;

    /** Optional attributes that identify element */
    private Map<String, String> attributes = new HashMap<String, String>();

    /** Found bean definition element nodes */
    private List<Element> beanDefinitions = new ArrayList<Element>();

    /**
     * Constructor using bean definition type as field.
     */
    public GetSpringBeansFilter(Class<?> type) {
        this.elementName = type.getAnnotation(XmlRootElement.class).name();
        this.elementNamespace = type.getPackage().getAnnotation(XmlSchema.class).namespace();
    }

    /**
     * Constructor using bean definition type and attributes fields.
     */
    public GetSpringBeansFilter(Class<?> type, Map<String, String> attributes) {
        this(type);

        if (attributes != null) {
            this.attributes = attributes;
        }
    }

    /**
     * {@inheritDoc}
     */
    public short accept(Element element) {
        if (DomUtils.nodeNameEquals(element, elementName) && isEqualByNamespace(element, elementNamespace)
                && isEqualByBeanAttributes(element, attributes)) {
            beanDefinitions.add(element);
        }

        return NodeFilter.FILTER_ACCEPT;
    }

    /**
     * Gets the beanDefinitions.
     * @return the beanDefinitions the beanDefinitions to get.
     */
    public List<Element> getBeanDefinitions() {
        return beanDefinitions;
    }
}