|
| 1 | +/* |
| 2 | + * Copyright 2017 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package org.springframework.data.config; |
| 17 | + |
| 18 | +import org.springframework.beans.factory.config.BeanDefinition; |
| 19 | +import org.springframework.beans.factory.xml.XmlReaderContext; |
| 20 | +import org.springframework.core.io.ResourceLoader; |
| 21 | +import org.springframework.util.Assert; |
| 22 | + |
| 23 | +/** |
| 24 | + * Helper class to centralize common functionality that needs to be used in various places of the configuration |
| 25 | + * implementation. |
| 26 | + * |
| 27 | + * @author Oliver Gierke |
| 28 | + * @since 2.0 |
| 29 | + * @soundtrack Richard Spaven - The Self (feat. Jordan Rakei) |
| 30 | + */ |
| 31 | +public interface ConfigurationUtils { |
| 32 | + |
| 33 | + /** |
| 34 | + * Returns the {@link ResourceLoader} from the given {@link XmlReaderContext}. |
| 35 | + * |
| 36 | + * @param context must not be {@literal null}. |
| 37 | + * @return |
| 38 | + * @throws IllegalArgumentException if no {@link ResourceLoader} can be obtained from the {@link XmlReaderContext}. |
| 39 | + */ |
| 40 | + public static ResourceLoader getRequiredResourceLoader(XmlReaderContext context) { |
| 41 | + |
| 42 | + Assert.notNull(context, "XmlReaderContext must not be null!"); |
| 43 | + |
| 44 | + ResourceLoader resourceLoader = context.getResourceLoader(); |
| 45 | + |
| 46 | + if (resourceLoader == null) { |
| 47 | + throw new IllegalArgumentException("Could not obtain ResourceLoader from XmlReaderContext!"); |
| 48 | + } |
| 49 | + |
| 50 | + return resourceLoader; |
| 51 | + } |
| 52 | + |
| 53 | + /** |
| 54 | + * Returns the {@link ClassLoader} used by the given {@link XmlReaderContext}. |
| 55 | + * |
| 56 | + * @param context must not be {@literal null}. |
| 57 | + * @return |
| 58 | + * @throws IllegalArgumentException if no {@link ClassLoader} can be obtained from the given {@link XmlReaderContext}. |
| 59 | + */ |
| 60 | + public static ClassLoader getRequiredClassLoader(XmlReaderContext context) { |
| 61 | + return getRequiredClassLoader(getRequiredResourceLoader(context)); |
| 62 | + } |
| 63 | + |
| 64 | + /** |
| 65 | + * Returns the {@link ClassLoader} used by the given {@link ResourceLoader}. |
| 66 | + * |
| 67 | + * @param resourceLoader must not be {@literal null}. |
| 68 | + * @return |
| 69 | + * @throws IllegalArgumentException if the given {@link ResourceLoader} does not expose a {@link ClassLoader}. |
| 70 | + */ |
| 71 | + public static ClassLoader getRequiredClassLoader(ResourceLoader resourceLoader) { |
| 72 | + |
| 73 | + Assert.notNull(resourceLoader, "ResourceLoader must not be null!"); |
| 74 | + |
| 75 | + ClassLoader classLoader = resourceLoader.getClassLoader(); |
| 76 | + |
| 77 | + if (classLoader == null) { |
| 78 | + throw new IllegalArgumentException("Could not obtain ClassLoader from ResourceLoader!"); |
| 79 | + } |
| 80 | + |
| 81 | + return classLoader; |
| 82 | + } |
| 83 | + |
| 84 | + /** |
| 85 | + * Returns the bean class name of the given {@link BeanDefinition}. |
| 86 | + * |
| 87 | + * @param beanDefinition must not be {@literal null}. |
| 88 | + * @return |
| 89 | + * @throws IllegalArgumentException if the given {@link BeanDefinition} does not contain a bean class name. |
| 90 | + */ |
| 91 | + public static String getRequiredBeanClassName(BeanDefinition beanDefinition) { |
| 92 | + |
| 93 | + Assert.notNull(beanDefinition, "BeanDefinition must not be null!"); |
| 94 | + |
| 95 | + String result = beanDefinition.getBeanClassName(); |
| 96 | + |
| 97 | + if (result == null) { |
| 98 | + throw new IllegalArgumentException( |
| 99 | + String.format("Could not obtain required bean class name from BeanDefinition!", beanDefinition)); |
| 100 | + } |
| 101 | + |
| 102 | + return result; |
| 103 | + } |
| 104 | +} |
0 commit comments