org.zalando.problem.ProblemModule Java Examples

@Test
void shouldSerializeWithoutAutoDetect() throws JsonProcessingException {
    final JsonMapper mapper = JsonMapper.builder()
            .disable(MapperFeature.AUTO_DETECT_FIELDS)
            .disable(MapperFeature.AUTO_DETECT_GETTERS)
            .disable(MapperFeature.AUTO_DETECT_IS_GETTERS)
            .addModule(new ProblemModule())
            .addModule(new ConstraintViolationProblemModule())
            .build();

    final Violation violation = new Violation("bob", "was missing");
    final ConstraintViolationProblem unit = new ConstraintViolationProblem(BAD_REQUEST, singletonList(violation));

    with(mapper.writeValueAsString(unit))
            .assertThat("status", is(400))
            .assertThat("type", is(ConstraintViolationProblem.TYPE_VALUE))
            .assertThat("title", is("Constraint Violation"))
            .assertThat("violations", hasSize(1))
            .assertThat("violations.*.field", contains("bob"))
            .assertThat("violations.*.message", contains("was missing"));
}
 

/**
 * Construct an {@link ObjectMapper} that can be used to serialize and deserialize ProblemsJSON where JSON numbers
 * emit as non-String values. Because Problems+Json requires HTTP status codes to be serialized as numbers (and not
 * Strings) per RFC-7807, this ObjectMapper should not be used for payloads that involve Problems.
 *
 * @return An {@link ObjectMapper}.
 *
 * @see "https://tools.ietf.org/html/rfc7807"
 */
private static ObjectMapper createObjectMapperForProblemsJson() {
  return new ObjectMapper()
      .registerModule(new Jdk8Module())
      .registerModule(new InterledgerModule(Encoding.BASE64))
      .registerModule(new ProblemModule())
      .registerModule(new ConstraintViolationProblemModule())
      .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)
      .configure(JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS, false);
}
 

@Bean
@Primary
public Jackson2ObjectMapperBuilder objectMapperBuilder() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");
    dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
    return builder
            .failOnUnknownProperties(false)
            .dateFormat(dateFormat)
            .serializationInclusion(Include.NON_NULL)
            .modules(new Jdk8Module(), new ProblemModule());
}
 

@Bean
@Primary
public ObjectMapper jacksonObjectMapper() {
    final ObjectMapper objectMapper = new ObjectMapper()
            .setPropertyNamingStrategy(SNAKE_CASE);

    objectMapper.registerModule(enumModule());
    objectMapper.registerModule(new Jdk8Module());
    objectMapper.registerModule(new ProblemModule());
    objectMapper.registerModule(new JodaModule());
    objectMapper.configure(WRITE_DATES_AS_TIMESTAMPS , false);
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

    return objectMapper;
}
 

@Override
public void configureMessageConverters(final List<HttpMessageConverter<?>> converters) {
    final ObjectMapper mapper = Jackson2ObjectMapperBuilder.json()
            .modules(
                    new ProblemModule(),
                    new ConstraintViolationProblemModule())
            .build();

    converters.add(new MappingJackson2HttpMessageConverter(mapper));
}
 

@Test
void shouldSerializeCustomType() throws JsonProcessingException {
    final ObjectMapper mapper = new ObjectMapper()
            .registerModule(new ProblemModule())
            .registerModule(new ConstraintViolationProblemModule());

    final URI type = URI.create("foo");
    final ConstraintViolationProblem unit = new ConstraintViolationProblem(type, BAD_REQUEST, emptyList());

    with(mapper.writeValueAsString(unit))
            .assertThat("type", is("foo"));
}
 

@Bean
public ObjectMapper mapper() {
    return new ObjectMapper().registerModule(new ProblemModule());
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
public ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Test
void shouldConfigureProblemModule(
        @Autowired final ProblemModule module) {
    assertThat(module).isNotNull();
}
 

@Test
void shouldNotConfigureProblemModule(
        @Autowired @Nullable final ProblemModule module) {
    assertThat(module).isNull();
}
 

@Test
void shouldNotConfigureProblemModule(
        @Autowired @Nullable final ProblemModule module) {
    assertThat(module).isNull();
}
 

@Override
public ObjectMapper mapper() {
    return new ObjectMapper().registerModule(new ProblemModule().withStackTraces());
}
 

@Bean
public ProblemModule problemModule() {
  return new ProblemModule();
}
 

default ObjectMapper mapper() {
    return new ObjectMapper()
            .registerModule(new ProblemModule())
            .registerModule(new ConstraintViolationProblemModule());
}
 

@Override
protected void configureMessageConverters(final List<HttpMessageConverter<?>> converters) {
    converters.clear();
    converters.add(new MappingJackson2HttpMessageConverter(new ObjectMapper()
            .registerModule(new ProblemModule())));
}
 

default ObjectMapper mapper() {
    return new ObjectMapper().registerModule(new ProblemModule());
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
public ObjectMapper objectMapper() {
    // In this example, stack traces support is enabled by default. 
    // If you want to disable stack traces just use new ProblemModule() instead of new ProblemModule().withStackTraces()
    return new ObjectMapper().registerModules(new ProblemModule().withStackTraces(), new ConstraintViolationProblemModule());
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}
 

@Bean
ProblemModule problemModule() {
    return new ProblemModule();
}