org.sdase.commons.starter.builder.JacksonCustomizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sda-commons-starter Show documentation

A libraries to bootstrap services easily that follow the patterns and specifications promoted by the SDA SE

There is a newer version: 7.0.87

package org.sdase.commons.starter.builder;

import com.fasterxml.jackson.databind.ObjectMapper;
import io.dropwizard.core.Configuration;
import java.time.ZonedDateTime;
import java.util.function.Consumer;
import org.sdase.commons.server.jackson.EnableFieldFilter;
import org.sdase.commons.server.jackson.Iso8601Serializer;

public interface JacksonCustomizer {

  /**
   * Skips registration of the HAL module. This may be used when links and embedded resources are
   * not required or are achieved with other tooling.
   *
   * @return the builder
   */
  PlatformBundleBuilder withoutHalSupport();

  /**
   * Disables the field filter entirely. The field filter may be used by clients to request only a
   * subset of the properties of a resource and has to be activated with {@link EnableFieldFilter}
   * for each resource.
   *
   * @return the builder
   */
  PlatformBundleBuilder withoutFieldFilter();

  /**
   * Allows customization of the used {@link ObjectMapper}. More customizers may be added by calling
   * this method multiple times.
   *
   * @param customizer receives the used {@link ObjectMapper} for customization, e.g. to enable or
   *     disable specific features or configure formatting.
   * @return the builder
   */
  PlatformBundleBuilder withObjectMapperCustomization(Consumer customizer);

  /**
   * Registers a default serializer for {@link ZonedDateTime} that renders 3 digits of milliseconds.
   * The same serializer may be configured per field as documented in {@link
   * Iso8601Serializer.WithMillis}.
   *
   * This setting overwrites the default behaviour of Jackson which omits milliseconds if they
   * are zero or adds nanoseconds if they are set.
   *
   * @return the builder
   */
  PlatformBundleBuilder alwaysWriteZonedDateTimeWithMillisInJson();

  /**
   * Registers a default serializer for {@link ZonedDateTime} that renders no milliseconds. The same
   * serializer may be configured per field as documented in {@link Iso8601Serializer}.
   *
   * This setting overwrites the default behaviour of Jackson which omits milliseconds if they
   * are zero or adds nanoseconds if they are set.
   *
   * @return the builder
   */
  PlatformBundleBuilder alwaysWriteZonedDateTimeWithoutMillisInJson();
}