001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2013-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029import java.util.List;
030
031/**
032 * This can be used to internally execute select command line utilities and
033 * return the results.  A Server SDK extension can get access to a ToolExecutor
034 * by calling the {@link ServerContext#getToolExecutor()} method.
035 */
036public interface ToolExecutor
037{
038  /**
039   * Invokes the config-diff command line utility and returns the result.
040   * All command line arguments of config-diff are supported with the
041   * exception of the debugging arguments listed in --help-debug.  Invocations
042   * of this method should behave identically to an explicit command line
043   * invocation except the command is run within the current process as
044   * opposed to launching an external process.
045   *
046   * @param args  The arguments to use when invoking config-diff.
047   *
048   * @return  The result of the config-diff invocation.
049   */
050  ToolResult runConfigDiff(List<String> args);
051}