All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.fasterxml.jackson.databind.cfg.MapperBuilder Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
package com.fasterxml.jackson.databind.cfg;

import java.security.AccessController;
import java.security.PrivilegedAction;
import java.text.DateFormat;
import java.util.*;
import java.util.function.Consumer;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping;
import com.fasterxml.jackson.databind.deser.*;
import com.fasterxml.jackson.databind.introspect.AccessorNamingStrategy;
import com.fasterxml.jackson.databind.introspect.DefaultAccessorNamingStrategy;
import com.fasterxml.jackson.databind.introspect.VisibilityChecker;
import com.fasterxml.jackson.databind.jsontype.NamedType;
import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator;
import com.fasterxml.jackson.databind.jsontype.SubtypeResolver;
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.ser.*;
import com.fasterxml.jackson.databind.type.LogicalType;
import com.fasterxml.jackson.databind.type.TypeFactory;

/**
 * Jackson 3 will introduce fully immutable, builder-based system for constructing
 * {@link ObjectMapper}s. Same can not be done with 2.10 for backwards-compatibility
 * reasons; but we can offer sort of "fake" builder, which simply encapsulates
 * configuration calls. The main (and only) point is to allow gradual upgrade.
 *
 * @since 2.10
 */
public abstract class MapperBuilder>
{
    protected final M _mapper;

    /*
    /**********************************************************************
    /* Life-cycle
    /**********************************************************************
     */

    protected MapperBuilder(M mapper)
    {
        _mapper = mapper;
    }

    /**
     * Method to call to create actual mapper instance.
     *

* Implementation detail: in 2.10 (but not 3.x) underlying mapper is eagerly * constructed when builder is constructed, and method simply returns that * instance. */ public M build() { return _mapper; } /* /********************************************************************** /* Accessors, features /********************************************************************** */ public boolean isEnabled(MapperFeature f) { return _mapper.isEnabled(f); } public boolean isEnabled(DeserializationFeature f) { return _mapper.isEnabled(f); } public boolean isEnabled(SerializationFeature f) { return _mapper.isEnabled(f); } public boolean isEnabled(JsonParser.Feature f) { return _mapper.isEnabled(f); } public boolean isEnabled(JsonGenerator.Feature f) { return _mapper.isEnabled(f); } /* /********************************************************************** /* Accessors, other /********************************************************************** */ public TokenStreamFactory streamFactory() { return _mapper.tokenStreamFactory(); } /* /********************************************************************** /* Changing features: mapper, ser, deser /********************************************************************** */ @SuppressWarnings("deprecation") public B enable(MapperFeature... features) { _mapper.enable(features); return _this(); } @SuppressWarnings("deprecation") public B disable(MapperFeature... features) { _mapper.disable(features); return _this(); } @SuppressWarnings("deprecation") public B configure(MapperFeature feature, boolean state) { _mapper.configure(feature, state); return _this(); } public B enable(SerializationFeature... features) { for (SerializationFeature f : features) { _mapper.enable(f); } return _this(); } public B disable(SerializationFeature... features) { for (SerializationFeature f : features) { _mapper.disable(f); } return _this(); } public B configure(SerializationFeature feature, boolean state) { _mapper.configure(feature, state); return _this(); } public B enable(DeserializationFeature... features) { for (DeserializationFeature f : features) { _mapper.enable(f); } return _this(); } public B disable(DeserializationFeature... features) { for (DeserializationFeature f : features) { _mapper.disable(f); } return _this(); } public B configure(DeserializationFeature feature, boolean state) { _mapper.configure(feature, state); return _this(); } public B enable(DatatypeFeature... features) { for (DatatypeFeature f : features) { _mapper.configure(f, true); } return _this(); } public B disable(DatatypeFeature... features) { for (DatatypeFeature f : features) { _mapper.configure(f, false); } return _this(); } public B configure(DatatypeFeature feature, boolean state) { _mapper.configure(feature, state); return _this(); } /* /********************************************************************** /* Changing features: parser, generator, pre-2.10 /********************************************************************** */ public B enable(JsonParser.Feature... features) { _mapper.enable(features); return _this(); } public B disable(JsonParser.Feature... features) { _mapper.disable(features); return _this(); } public B configure(JsonParser.Feature feature, boolean state) { _mapper.configure(feature, state); return _this(); } public B enable(JsonGenerator.Feature... features) { _mapper.enable(features); return _this(); } public B disable(JsonGenerator.Feature... features) { _mapper.disable(features); return _this(); } public B configure(JsonGenerator.Feature feature, boolean state) { _mapper.configure(feature, state); return _this(); } /* /********************************************************************** /* Changing features: parser, generator, 2.10+ /********************************************************************** */ public B enable(StreamReadFeature... features) { for (StreamReadFeature f : features) { _mapper.enable(f.mappedFeature()); } return _this(); } public B disable(StreamReadFeature... features) { for (StreamReadFeature f : features) { _mapper.disable(f.mappedFeature()); } return _this(); } public B configure(StreamReadFeature feature, boolean state) { _mapper.configure(feature.mappedFeature(), state); return _this(); } public B enable(StreamWriteFeature... features) { for (StreamWriteFeature f : features) { _mapper.enable(f.mappedFeature()); } return _this(); } public B disable(StreamWriteFeature... features) { for (StreamWriteFeature f : features) { _mapper.disable(f.mappedFeature()); } return _this(); } public B configure(StreamWriteFeature feature, boolean state) { _mapper.configure(feature.mappedFeature(), state); return _this(); } /* /********************************************************************** /* Changing settings, config overrides /********************************************************************** */ /** * Method for changing config overrides for specific type, through * callback to specific handler. * * @param forType Type to change config overrides for * @param handler Function to call with {@link MutableConfigOverride} * * @since 2.13 */ public B withConfigOverride(Class forType, Consumer handler) { handler.accept(_mapper.configOverride(forType)); return _this(); } // Not possible to support these in 2.x, yet (added in 3.0); would require // access to "ConfigOverrides" that `ObjectMapper` holds // public B withAllConfigOverrides(Consumer handler) // public B changeDefaultVisibility(UnaryOperator handler) // public B changeDefaultPropertyInclusion(UnaryOperator handler) // public B changeDefaultNullHandling(UnaryOperator handler) // public B defaultMergeable(Boolean b) // public B defaultLeniency(Boolean b) /* /********************************************************************** /* Changing settings, coercion config /********************************************************************** */ /** * Method for changing coercion config for specific logical types, through * callback to specific handler. * * @since 2.13 */ public B withCoercionConfig(LogicalType forType, Consumer handler) { handler.accept(_mapper.coercionConfigFor(forType)); return _this(); } /** * Method for changing coercion config for specific physical type, through * callback to specific handler. * * @since 2.13 */ public B withCoercionConfig(Class forType, Consumer handler) { handler.accept(_mapper.coercionConfigFor(forType)); return _this(); } /** * Method for changing target-type-independent coercion configuration defaults. * * @since 2.13 */ public B withCoercionConfigDefaults(Consumer handler) { handler.accept(_mapper.coercionConfigDefaults()); return _this(); } // Not possible to support these in 2.x, yet (added in 3.0); would require // access to "ConfigOverrides" that `ObjectMapper` holds // public B withAllCoercionConfigs(Consumer handler) /* /********************************************************************** /* Module registration, discovery, access /********************************************************************** */ // NOTE: can not add this in 2.x (since Modules get immediately registered) // public B removeAllModules() public B addModule(com.fasterxml.jackson.databind.Module module) { _mapper.registerModule(module); return _this(); } public B addModules(com.fasterxml.jackson.databind.Module... modules) { for (com.fasterxml.jackson.databind.Module module : modules) { addModule(module); } return _this(); } public B addModules(Iterable modules) { for (com.fasterxml.jackson.databind.Module module : modules) { addModule(module); } return _this(); } /** * Method for locating available methods, using JDK {@link ServiceLoader} * facility, along with module-provided SPI. *

* Note that method does not do any caching, so calls should be considered * potentially expensive. */ public static List findModules() { return findModules(null); } /** * Method for locating available methods, using JDK {@link ServiceLoader} * facility, along with module-provided SPI. *

* Note that method does not do any caching, so calls should be considered * potentially expensive. */ public static List findModules(ClassLoader classLoader) { ArrayList modules = new ArrayList<>(); ServiceLoader loader = secureGetServiceLoader(com.fasterxml.jackson.databind.Module.class, classLoader); for (com.fasterxml.jackson.databind.Module module : loader) { modules.add(module); } return modules; } private static ServiceLoader secureGetServiceLoader(final Class clazz, final ClassLoader classLoader) { final SecurityManager sm = System.getSecurityManager(); if (sm == null) { return (classLoader == null) ? ServiceLoader.load(clazz) : ServiceLoader.load(clazz, classLoader); } return AccessController.doPrivileged(new PrivilegedAction>() { @Override public ServiceLoader run() { return (classLoader == null) ? ServiceLoader.load(clazz) : ServiceLoader.load(clazz, classLoader); } }); } /** * Convenience method that is functionally equivalent to: * * addModules(builder.findModules()); * *

* As with {@link #findModules()}, no caching is done for modules, so care * needs to be taken to either create and share a single mapper instance; * or to cache introspected set of modules. */ public B findAndAddModules() { return addModules(findModules()); } /* /********************************************************************** /* Changing base settings /********************************************************************** */ /** * Method for replacing {@link AnnotationIntrospector} used by the * mapper instance to be built. * Note that doing this will replace the current introspector, which * may lead to unavailability of core Jackson annotations. * If you want to combine handling of multiple introspectors, * have a look at {@link com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair}. * * @see com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair */ public B annotationIntrospector(AnnotationIntrospector intr) { _mapper.setAnnotationIntrospector(intr); return _this(); } /** * Method for replacing default {@link ContextAttributes} that the mapper * uses: usually one initialized with a set of default shared attributes, but * potentially also with a custom implementation. *

* NOTE: instance specified will need to be thread-safe for usage, similar to the * default ({@link ContextAttributes.Impl}). * * @param attrs Default instance to use: may not be {@code null}. * * @return This Builder instance to allow call chaining */ public B defaultAttributes(ContextAttributes attrs) { _mapper.setDefaultAttributes(attrs); return _this(); } /* /********************************************************************** /* Changing introspection helpers /********************************************************************** */ public B typeFactory(TypeFactory f) { _mapper.setTypeFactory(f); return _this(); } public B subtypeResolver(SubtypeResolver r) { _mapper.setSubtypeResolver(r); return _this(); } public B visibility(VisibilityChecker vc) { _mapper.setVisibility(vc); return _this(); } public B visibility(PropertyAccessor forMethod, JsonAutoDetect.Visibility visibility) { _mapper.setVisibility(forMethod, visibility); return _this(); } /** * Method for configuring {@link HandlerInstantiator} to use for creating * instances of handlers (such as serializers, deserializers, type and type * id resolvers), given a class. * * @param hi Instantiator to use; if null, use the default implementation * * @return Builder instance itself to allow chaining */ public B handlerInstantiator(HandlerInstantiator hi) { _mapper.setHandlerInstantiator(hi); return _this(); } /** * Method for configuring {@link PropertyNamingStrategy} to use for adapting * POJO property names (internal) into content property names (external) * * @param s Strategy instance to use; if null, use the default implementation * * @return Builder instance itself to allow chaining */ public B propertyNamingStrategy(PropertyNamingStrategy s) { _mapper.setPropertyNamingStrategy(s); return _this(); } /** * Method for configuring {@link AccessorNamingStrategy} to use for auto-detecting * accessor ("getter") and mutator ("setter") methods based on naming of methods. * * @param s Strategy instance to use; if null, use the default implementation * * @return Builder instance itself to allow chaining * * @since 2.12 */ public B accessorNaming(AccessorNamingStrategy.Provider s) { if (s == null) { s = new DefaultAccessorNamingStrategy.Provider(); } _mapper.setAccessorNaming(s); return _this(); } /* /********************************************************************** /* Changing factories, serialization /********************************************************************** */ public B serializerFactory(SerializerFactory f) { _mapper.setSerializerFactory(f); return _this(); } /** * Method for configuring this mapper to use specified {@link FilterProvider} for * mapping Filter Ids to actual filter instances. *

* Note that usually it is better to use method in {@link ObjectWriter}, but sometimes * this method is more convenient. For example, some frameworks only allow configuring * of ObjectMapper instances and not {@link ObjectWriter}s. */ public B filterProvider(FilterProvider prov) { _mapper.setFilterProvider(prov); return _this(); } public B defaultPrettyPrinter(PrettyPrinter pp) { _mapper.setDefaultPrettyPrinter(pp); return _this(); } /* /********************************************************************** /* Changing factories, related, deserialization /********************************************************************** */ public B injectableValues(InjectableValues v) { _mapper.setInjectableValues(v); return _this(); } public B nodeFactory(JsonNodeFactory f) { _mapper.setNodeFactory(f); return _this(); } /** * Method for specifying {@link ConstructorDetector} to use for * determining some aspects of creator auto-detection (specifically * auto-detection of constructor, and in particular behavior with * single-argument constructors). * * @since 2.12 */ public B constructorDetector(ConstructorDetector cd) { _mapper.setConstructorDetector(cd); return _this(); } /** * @since 2.16 */ public B cacheProvider(CacheProvider cacheProvider) { _mapper.setCacheProvider(cacheProvider); return _this(); } /** * Method used for adding a {@link DeserializationProblemHandler} for this * builder, at the head of the list (meaning it has priority over handler * registered earlier). */ public B addHandler(DeserializationProblemHandler h) { _mapper.addHandler(h); return _this(); } /** * Method that may be used to remove all {@link DeserializationProblemHandler}s added * to this builder (if any). */ public B clearProblemHandlers() { _mapper.clearProblemHandlers(); return _this(); } /* /********************************************************************** /* Changing global defaults /********************************************************************** */ public B defaultSetterInfo(JsonSetter.Value v) { _mapper.setDefaultSetterInfo(v); return _this(); } /** * Method for setting default Setter configuration, regarding things like * merging, null-handling; used for properties for which there are * no per-type or per-property overrides (via annotations or config overrides). */ public B defaultMergeable(Boolean b) { _mapper.setDefaultMergeable(b); return _this(); } /** * Method for setting default Setter configuration, regarding things like * merging, null-handling; used for properties for which there are * no per-type or per-property overrides (via annotations or config overrides). */ public B defaultLeniency(Boolean b) { _mapper.setDefaultLeniency(b); return _this(); } /* /********************************************************************** /* Changing settings, date/time /********************************************************************** */ /** * Method for configuring the default {@link DateFormat} to use when serializing time * values as Strings, and deserializing from JSON Strings. * If you need per-request configuration, factory methods in * {@link ObjectReader} and {@link ObjectWriter} instead. */ public B defaultDateFormat(DateFormat df) { _mapper.setDateFormat(df); return _this(); } /** * Method for overriding default TimeZone to use for formatting. * Default value used is UTC (NOT default TimeZone of JVM). */ public B defaultTimeZone(TimeZone tz) { _mapper.setTimeZone(tz); return _this(); } /** * Method for overriding default locale to use for formatting. * Default value used is {@link Locale#getDefault()}. */ public B defaultLocale(Locale locale) { _mapper.setLocale(locale); return _this(); } /* /********************************************************************** /* Changing settings, formatting /********************************************************************** */ /** * Method that will configure default {@link Base64Variant} that * byte[] serializers and deserializers will use. * * @param v Base64 variant to use * * @return This builder instance to allow call chaining */ public B defaultBase64Variant(Base64Variant v) { _mapper.setBase64Variant(v); return _this(); } /** * Method for configured default property inclusion to use for serialization. * * @param incl Default property inclusion to set * * @return This builder instance to allow call chaining */ public B serializationInclusion(JsonInclude.Include incl) { _mapper.setSerializationInclusion(incl); return _this(); } /** * Method for configured default property inclusion to use for serialization. * * @param incl Default property inclusion to set * * @return This builder instance to allow call chaining * * @since 2.11 */ public B defaultPropertyInclusion(JsonInclude.Value incl) { _mapper.setDefaultPropertyInclusion(incl); return _this(); } /* /********************************************************************** /* Configuring Mix-ins /********************************************************************** */ /** * Method to use for defining mix-in annotations to use for augmenting * annotations that classes have, for purpose of configuration serialization * and/or deserialization processing. * Mixing in is done when introspecting class annotations and properties. * Annotations from "mixin" class (and its supertypes) * will override * annotations that target classes (and their super-types) have. *

* Note that standard mixin handler implementations will only allow a single mix-in * source class per target, so if there was a previous mix-in defined target it will * be cleared. This also means that you can remove mix-in definition by specifying * {@code mixinSource} of {@code null} * (although preferred mechanism is {@link #removeMixIn}) * * @param target Target class on which to add annotations * @param mixinSource Class that has annotations to add * * @return This builder instance to allow call chaining */ public B addMixIn(Class target, Class mixinSource) { _mapper.addMixIn(target, mixinSource); return _this(); } /** * Method that allows making sure that specified {@code target} class * does not have associated mix-in annotations: basically can be used * to undo an earlier call to {@link #addMixIn}. *

* NOTE: removing mix-ins for given class does not try to remove possible * mix-ins for any of its super classes and super interfaces; only direct * mix-in addition, if any, is removed. * * @param target Target class for which no mix-ins should remain after call * * @return This builder instance to allow call chaining * * @since 2.13 */ public B removeMixIn(Class target) { _mapper.addMixIn(target, null); return _this(); } /* /********************************************************************** /* Subtype registration, related /********************************************************************** */ public B registerSubtypes(Class... subtypes) { _mapper.registerSubtypes(subtypes); return _this(); } public B registerSubtypes(NamedType... subtypes) { _mapper.registerSubtypes(subtypes); return _this(); } public B registerSubtypes(Collection> subtypes) { _mapper.registerSubtypes(subtypes); return _this(); } /** * Method for assigning {@link PolymorphicTypeValidator} to use for validating * subtypes when using Class name - based polymorphic deserialization * using annotations (validator used with "Default Typing" is specified by * passing in {@link #activateDefaultTyping(PolymorphicTypeValidator)} instead). *

* Validator will be called on validating types for which no default databind * deserializer, or module-provided deserializer is found: typically this * includes "POJO" (aka Bean) types, but not (for example) most container * types. * * @since 2.10 */ public B polymorphicTypeValidator(PolymorphicTypeValidator ptv) { _mapper.setPolymorphicTypeValidator(ptv); return _this(); } /* /********************************************************************** /* Default typing /********************************************************************** */ /** * Convenience method that is equivalent to calling *

     *  activateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE);
     *
*

* NOTE: choice of {@link PolymorphicTypeValidator} to pass is critical for security * as allowing all subtypes can be risky for untrusted content. */ public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator) { _mapper.activateDefaultTyping(subtypeValidator); return _this(); } /** * Convenience method that is equivalent to calling *

     *  activateDefaultTyping(subtypeValidator, dti, JsonTypeInfo.As.WRAPPER_ARRAY);
     *
*

* NOTE: choice of {@link PolymorphicTypeValidator} to pass is critical for security * as allowing all subtypes can be risky for untrusted content. */ public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, DefaultTyping dti) { _mapper.activateDefaultTyping(subtypeValidator, dti); return _this(); } /** * Method for enabling automatic inclusion of type information, needed * for proper deserialization of polymorphic types (unless types * have been annotated with {@link com.fasterxml.jackson.annotation.JsonTypeInfo}). *

* NOTE: use of JsonTypeInfo.As#EXTERNAL_PROPERTY NOT SUPPORTED; * and attempts of do so will throw an {@link IllegalArgumentException} to make * this limitation explicit. *

* NOTE: choice of {@link PolymorphicTypeValidator} to pass is critical for security * as allowing all subtypes can be risky for untrusted content. * * @param applicability Defines kinds of types for which additional type information * is added; see {@link DefaultTyping} for more information. */ public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, DefaultTyping applicability, JsonTypeInfo.As includeAs) { _mapper.activateDefaultTyping(subtypeValidator, applicability, includeAs); return _this(); } /** * Method for enabling automatic inclusion of type information -- needed * for proper deserialization of polymorphic types (unless types * have been annotated with {@link com.fasterxml.jackson.annotation.JsonTypeInfo}) -- * using "As.PROPERTY" inclusion mechanism and specified property name * to use for inclusion (default being "@class" since default type information * always uses class name as type identifier) *

* NOTE: choice of {@link PolymorphicTypeValidator} to pass is critical for security * as allowing all subtypes can be risky for untrusted content. */ public B activateDefaultTypingAsProperty(PolymorphicTypeValidator subtypeValidator, DefaultTyping applicability, String propertyName) { _mapper.activateDefaultTypingAsProperty(subtypeValidator, applicability, propertyName); return _this(); } /** * Method for disabling automatic inclusion of type information; if so, only * explicitly annotated types (ones with * {@link com.fasterxml.jackson.annotation.JsonTypeInfo}) will have * additional embedded type information. */ public B deactivateDefaultTyping() { _mapper.deactivateDefaultTyping(); return _this(); } /** * Method for enabling automatic inclusion of type information, using * specified handler object for determining which types this affects, * as well as details of how information is embedded. *

* NOTE: use of Default Typing can be a potential security risk if incoming * content comes from untrusted sources, so care should be taken to use * a {@link TypeResolverBuilder} that can limit allowed classes to * deserialize. Note in particular that * {@link com.fasterxml.jackson.databind.jsontype.impl.StdTypeResolverBuilder} * DOES NOT limit applicability but creates type (de)serializers for all * types. * * @param typer Type information inclusion handler * * @since 2.12 */ public B setDefaultTyping(TypeResolverBuilder typer) { _mapper.setDefaultTyping(typer); return _this(); } /* /********************************************************************** /* Other helper methods /********************************************************************** */ // silly convenience cast method we need @SuppressWarnings("unchecked") protected final B _this() { return (B) this; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy