org.springframework.integration.support.json.JsonObjectMapperProvider.java Source code

Introduction

Here is the source code for org.springframework.integration.support.json.JsonObjectMapperProvider.java

Source

/*
 * Copyright 2002-2019 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
 *
 *      https://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 org.springframework.integration.support.json;

import org.springframework.util.ClassUtils;

/**
 * Simple factory to provide {@linkplain JsonObjectMapper}
 * instances dependently of jackson-databind or boon libs in the classpath.
 * If there are both libs in the classpath, it prefers Jackson 2 JSON-processor implementation.
 * If there is not any of them, {@linkplain IllegalStateException} will be thrown.
 *
 * @author Artem Bilan
 * @author Gary Russell
 * @author Vikas Prasad
 * @since 3.0
 *
 * @see Jackson2JsonObjectMapper
 */
public final class JsonObjectMapperProvider {

    private static final ClassLoader classLoader = JsonObjectMapperProvider.class.getClassLoader();

    private static final boolean boonPresent = ClassUtils.isPresent("org.boon.json.ObjectMapper", classLoader);

    private JsonObjectMapperProvider() {
        super();
    }

    /**
     * Return an object mapper if available.
     * @return the mapper.
     * @throws IllegalStateException if an implementation is not available.
     */
    @SuppressWarnings("deprecation")
    public static JsonObjectMapper<?, ?> newInstance() {
        if (JacksonPresent.isJackson2Present()) {
            return new Jackson2JsonObjectMapper();
        } else if (boonPresent) {
            return new org.springframework.integration.support.json.BoonJsonObjectMapper();
        } else {
            throw new IllegalStateException(
                    "Neither jackson-databind.jar, nor boon.jar is present in the classpath.");
        }
    }

    /**
     * Returns true if a supported JSON implementation is on the class path.
     * @return true if {@link #newInstance()} will return a mapper.
     * @since 4.2.7
     */
    public static boolean jsonAvailable() {
        return JacksonPresent.isJackson2Present() || boonPresent;
    }

}