org.sdase.commons.server.starter.builder

Interface JacksonCustomizer<C extends io.dropwizard.Configuration>

All Known Subinterfaces:

CustomConfigurationProviders.SwaggerFinalBuilder<C>, PlatformBundleBuilder<C>

All Known Implementing Classes:

SdaPlatformBundle.Builder

public interface JacksonCustomizer<C extends io.dropwizard.Configuration>

Method Summary

Modifier and Type	Method and Description
PlatformBundleBuilder<C>	alwaysWriteZonedDateTimeWithMillisInJson() Registers a default serializer for ZonedDateTime that renders 3 digits of milliseconds.
PlatformBundleBuilder<C>	alwaysWriteZonedDateTimeWithoutMillisInJson() Registers a default serializer for ZonedDateTime that renders no milliseconds.
PlatformBundleBuilder<C>	withObjectMapperCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer) Allows customization of the used ObjectMapper.
PlatformBundleBuilder<C>	withoutFieldFilter() Disables the field filter entirely.
PlatformBundleBuilder<C>	withoutHalSupport() Skips registration of the HAL module.

Method Detail

withoutHalSupport

PlatformBundleBuilder<C> withoutHalSupport()

Skips registration of the HAL module. This may be used when links and embedded resources are not required or are achieved with other tooling.

Returns:

the builder

withoutFieldFilter

PlatformBundleBuilder<C> withoutFieldFilter()

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 EnableFieldFilter for each resource.

Returns:

the builder

withObjectMapperCustomization

PlatformBundleBuilder<C> withObjectMapperCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer)

Allows customization of the used ObjectMapper. More customizers may be added by calling this method multiple times.

Parameters:

customizer - receives the used ObjectMapper for customization, e.g. to enable or disable specific features or configure formatting.

Returns:

the builder

alwaysWriteZonedDateTimeWithMillisInJson

PlatformBundleBuilder<C> alwaysWriteZonedDateTimeWithMillisInJson()

Registers a default serializer for ZonedDateTime that renders 3 digits of milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.WithMillis.

This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.

Returns:

the builder

alwaysWriteZonedDateTimeWithoutMillisInJson

PlatformBundleBuilder<C> alwaysWriteZonedDateTimeWithoutMillisInJson()

Registers a default serializer for ZonedDateTime that renders no milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.

This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.

Returns:

the builder