geode-core/src/main/java/org/apache/geode/management/internal/configuration/realizers/IndexRealizer.java

/*
 * 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.geode.management.internal.configuration.realizers;


import static org.apache.geode.cache.Region.SEPARATOR;

import org.apache.logging.log4j.Logger;

import org.apache.geode.annotations.Immutable;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.query.IndexExistsException;
import org.apache.geode.cache.query.IndexNameConflictException;
import org.apache.geode.cache.query.QueryService;
import org.apache.geode.cache.query.RegionNotFoundException;
import org.apache.geode.internal.cache.InternalCache;
import org.apache.geode.logging.internal.log4j.api.LogService;
import org.apache.geode.management.api.RealizationResult;
import org.apache.geode.management.configuration.Index;
import org.apache.geode.management.configuration.IndexType;
import org.apache.geode.management.runtime.IndexInfo;

public class IndexRealizer implements ConfigurationRealizer<Index, IndexInfo> {
  @Immutable
  private static final Logger logger = LogService.getLogger();

  @Override
  public RealizationResult create(Index config, InternalCache cache) {
    QueryService queryService = cache.getQueryService();
    String indexName = config.getName();
    String indexedExpression = config.getExpression();
    String fromClause = config.getRegionPath();
    RealizationResult realizationResult = new RealizationResult();
    try {
      if (config.getIndexType() == IndexType.KEY) {
        queryService.createKeyIndex(indexName, indexedExpression, fromClause);
      } else {
        queryService.createIndex(indexName, indexedExpression, fromClause);
      }
      realizationResult.setSuccess(true);
      realizationResult.setMessage("Index " + indexName + " successfully created");
      return realizationResult;
    } catch (IndexNameConflictException | IndexExistsException e) {
      // index creation is a distributed operation. sometimes the index might already be created
      // via actions on another server.
      realizationResult.setSuccess(true);
      realizationResult.setMessage(e.getMessage());
    } catch (RegionNotFoundException e) {
      realizationResult.setSuccess(false);
      realizationResult.setMessage(e.getMessage());
    } catch (RuntimeException r) {
      logger.error(r.getMessage(), r);
      realizationResult.setSuccess(false);
      realizationResult.setMessage(r.getMessage());
    }

    return realizationResult;
  }

  @Override
  public IndexInfo get(Index config, InternalCache cache) {
    String regionName = config.getRegionName();
    String indexName = config.getName();
    if (regionName == null || indexName == null) {
      return null;
    }
    Region<Object, Object> region = cache.getRegion(SEPARATOR + regionName);
    if (region == null) {
      return null;
    }
    QueryService queryService = cache.getQueryService();
    org.apache.geode.cache.query.Index index = queryService.getIndex(region, indexName);
    if (index == null) {
      return null;
    }

    return new IndexInfo();
  }

  @Override
  public RealizationResult update(Index config, InternalCache cache) {
    return null;
  }

  @Override
  public RealizationResult delete(Index config, InternalCache cache) {
    QueryService queryService = cache.getQueryService();
    RealizationResult realizationResult = new RealizationResult();
    Region<Object, Object> region = cache.getRegion(SEPARATOR + config.getRegionName());
    if (region == null) {
      realizationResult.setSuccess(false);
      realizationResult.setMessage("Region for index not found: " + config.getRegionName());
      return realizationResult;
    }
    org.apache.geode.cache.query.Index index = queryService.getIndex(region, config.getName());
    if (index == null) {
      realizationResult.setSuccess(false);
      realizationResult.setMessage("Index not found for Region: "
          + config.getRegionName()
          + ", "
          + config.getName());
      return realizationResult;
    }
    try {
      queryService.removeIndex(index);
      realizationResult.setSuccess(true);
      realizationResult.setMessage("Index "
          + config.getName()
          + " successfully removed from "
          + config.getRegionName());
      return realizationResult;
    } catch (RuntimeException e) {
      logger.error(e.getMessage(), e);
      realizationResult.setSuccess(false);
      realizationResult.setMessage(e.getMessage());
    }

    return realizationResult;
  }
}