org.apache.geode.management.internal.cli.GfshParseResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of geode-core Show documentation

Apache Geode provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing

There is a newer version: 1.15.1

Show newest version

/*
 * 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.cli;

import java.lang.reflect.Method;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.springframework.shell.event.ParseResult;

import org.apache.geode.management.cli.CliMetaData;
import org.apache.geode.management.internal.cli.shell.GfshExecutionStrategy;
import org.apache.geode.management.internal.cli.shell.OperationInvoker;

/**
 * Immutable representation of the outcome of parsing a given shell line. * Extends
 * {@link ParseResult} to add a field to specify the command string that was input by the user.
 * 
 * 
 * Some commands are required to be executed on a remote GemFire managing member. These should be
 * marked with the annotation {@link CliMetaData#shellOnly()} set to false.
 * {@link GfshExecutionStrategy} will detect whether the command is a remote command and send it to
 * ManagementMBean via {@link OperationInvoker}.
 * 
 * 
 * @since GemFire 7.0
 */
public class GfshParseResult extends ParseResult {
  private String userInput;
  private String commandName;
  private Map paramValueStringMap;

  /**
   * Creates a GfshParseResult instance to represent parsing outcome.
   * 
   * @param method Method associated with the command
   * @param instance Instance on which this method has to be executed
   * @param arguments arguments of the method
   * @param userInput user specified commands string
   */
  protected GfshParseResult(final Method method, final Object instance, final Object[] arguments,
      final String userInput, final String commandName,
      final Map parametersAsString) {
    super(method, instance, arguments);
    this.userInput = userInput;
    this.commandName = commandName;
    this.paramValueStringMap = new HashMap(parametersAsString);
  }

  /**
   * @return the userInput
   */
  public String getUserInput() {
    return userInput;
  }


  /**
   * @return the unmodifiable paramValueStringMap
   */
  public Map getParamValueStrings() {
    return Collections.unmodifiableMap(paramValueStringMap);
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder();
    builder.append(GfshParseResult.class.getSimpleName());
    builder.append(" [method=").append(getMethod());
    builder.append(", instance=").append(getInstance());
    builder.append(", arguments=").append(CliUtil.arrayToString(getArguments()));
    builder.append("]");
    return builder.toString();
  }

  public String getCommandName() {
    return commandName;
  }
}