org.sonar.server.user.index.UserIndexDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.user.index;

import com.google.common.collect.ImmutableSortedMap;
import java.util.SortedMap;
import org.sonar.api.config.Settings;
import org.sonar.server.es.IndexDefinition;
import org.sonar.server.es.NewIndex;

/**
 * Definition of ES index "users", including settings and fields.
 */
public class UserIndexDefinition implements IndexDefinition {

  public static final String INDEX = "users";

  public static final String TYPE_USER = "user";

  public static final String FIELD_LOGIN = "login";
  public static final String FIELD_NAME = "name";
  public static final String FIELD_EMAIL = "email";
  public static final String FIELD_CREATED_AT = "createdAt";
  public static final String FIELD_UPDATED_AT = "updatedAt";
  public static final String FIELD_ACTIVE = "active";
  public static final String FIELD_SCM_ACCOUNTS = "scmAccounts";

  public static final String SEARCH_SUB_SUFFIX = "ngrams";

  private final Settings settings;

  public UserIndexDefinition(Settings settings) {
    this.settings = settings;
  }

  @Override
  public void define(IndexDefinitionContext context) {
    NewIndex index = context.create(INDEX);

    index.configureShards(settings, 1);

    index.getSettings()
      // NGram filter (not edge) for logins and names
      .put("index.analysis.filter.ngram_filter.type", "nGram")
      .put("index.analysis.filter.ngram_filter.min_gram", 2)
      .put("index.analysis.filter.ngram_filter.max_gram", 15)
      .putArray("index.analysis.filter.ngram_filter.token_chars", "letter", "digit", "punctuation", "symbol")

      // NGram index analyzer
      .put("index.analysis.analyzer.index_ngrams.type", "custom")
      .put("index.analysis.analyzer.index_ngrams.tokenizer", "whitespace")
      .putArray("index.analysis.analyzer.index_ngrams.filter", "trim", "lowercase", "ngram_filter")

      // NGram search analyzer
      .put("index.analysis.analyzer.search_ngrams.type", "custom")
      .put("index.analysis.analyzer.search_ngrams.tokenizer", "whitespace")
      .putArray("index.analysis.analyzer.search_ngrams.filter", "trim", "lowercase");

    // type "user"
    NewIndex.NewIndexType mapping = index.createType(TYPE_USER);
    mapping.stringFieldBuilder(FIELD_LOGIN).addSubField(SEARCH_SUB_SUFFIX, buildGramSearchField()).build();
    mapping.stringFieldBuilder(FIELD_NAME).addSubField(SEARCH_SUB_SUFFIX, buildGramSearchField()).build();
    mapping.stringFieldBuilder(FIELD_EMAIL).enableSorting().build();
    mapping.createDateTimeField(FIELD_CREATED_AT);
    mapping.createDateTimeField(FIELD_UPDATED_AT);
    mapping.createBooleanField(FIELD_ACTIVE);
    mapping.stringFieldBuilder(FIELD_SCM_ACCOUNTS).disableNorms().build();
  }

  private static SortedMap buildGramSearchField() {
    return ImmutableSortedMap.of(
      "type", "string",
      "index", "analyzed",
      "analyzer", "index_ngrams",
      "search_analyzer", "search_ngrams");
  }
}