org.apache.solr.util.SolrJacksonAnnotationInspector Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *     http://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.apache.solr.util;

import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyName;
import com.fasterxml.jackson.databind.introspect.Annotated;
import com.fasterxml.jackson.databind.introspect.AnnotatedField;
import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
import com.fasterxml.jackson.databind.introspect.AnnotatedMethod;
import com.fasterxml.jackson.databind.util.BeanUtil;
import org.apache.solr.common.annotation.JsonProperty;

/**this class provides a mapping between Solr's {@link JsonProperty} annotation to a corresponding annotation
 * in jackson
 see SOLR-13841 for more details
 *  ObjectMapper mapper = new ObjectMapper();
 mapper.setAnnotationIntrospector(new SolrJacksonAnnotationInspector());
 * 
 **/
public class SolrJacksonAnnotationInspector extends AnnotationIntrospector {
  public static final SolrJacksonAnnotationInspector INSTANCE = new SolrJacksonAnnotationInspector();

  @Override
  public Version version() {
    return Version.unknownVersion();
  }

  @Override
  public PropertyName findNameForSerialization(Annotated a) {
    if (a instanceof AnnotatedMethod) {
      AnnotatedMethod am = (AnnotatedMethod) a;
      JsonProperty prop = am.getAnnotation(JsonProperty.class);
      if (prop == null) return null;
      if (prop.value().isEmpty()) {
        return new PropertyName(BeanUtil.okNameForGetter(am, true));
      } else {
        return new PropertyName(prop.value());
      }

    }
    if (a instanceof AnnotatedField) {
      AnnotatedField af = (AnnotatedField) a;
      JsonProperty prop = af.getAnnotation(JsonProperty.class);
      if (prop == null) return null;
      return prop.value().isEmpty() ?
          new PropertyName(af.getName()) :
          new PropertyName(prop.value());
    }
    return null;
  }

  @Override
  public Boolean hasRequiredMarker(AnnotatedMember m) {
    JsonProperty prop = m.getAnnotation(JsonProperty.class);
    if (prop == null) return Boolean.FALSE;
    return prop.required();
  }

  @Override
  public String findPropertyDefaultValue(Annotated m) {
    JsonProperty prop = m.getAnnotation(JsonProperty.class);
    if (prop == null) return "";
    return prop.defaultValue();
  }

  @Override
  public PropertyName findNameForDeserialization(Annotated a) {
    return findNameForSerialization(a);
  }

  public static ObjectMapper createObjectMapper(){
    ObjectMapper mapper = new ObjectMapper();
    mapper.setAnnotationIntrospector(INSTANCE);
    return mapper;
  }
}