/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.embeddable;
/**
* GlassFish has a very sophisticated command line interface (CLI) viz.,
* 'asadmin' to executive administrative commands.
*
* <p/>This is a programmatic interface equivalent to 'asadmin'.
*
* <p/>This interface allows the execution of the adminstrative commands
* from an application which embeds GlassFish.
*
* <p/>A command runner is obtained by calling
* {@link org.glassfish.embeddable.GlassFish#getCommandRunner()}.
*
* <p/>A command runner is a per-lookup type object, which means each time
* {@link GlassFish#getCommandRunner()} is called, it returns a new instance of command runner.
*
* Command specific options are passed in the var-args argument of {@link #run(String, String...)} method.
*
* @author Sanjeeb.Sahoo@Sun.COM
*/
public interface CommandRunner {
/**
* Execute an administrative command in {@link GlassFish} using the supplied
* command arguments. Refer to GlassFish Administration Guide to know about the commands supported
* in GlassFish and their usage.
*
* <p/>Example: To add an additional http listener 9090 :
*
* <pre>
* commandRunner.run("create-http-listener", "--listenerport", "9090",
* "--listeneraddress", "0.0.0.0",
* "--defaultvs", "server",
* "--securityenabled", "false",
* "listener_id", "my-http-listener-1");
*
* </pre>
* asadmin commands also allow option values to be specified using '=', so the above example can be written as:
*
* <pre>
* commandRunner.run("create-http-listener", "--listenerport=9090",
* "--listeneraddress=0.0.0.0",
* "--defaultvs=server",
* "--securityenabled=false",
* "listener_id=my-http-listener-1");
*
* </pre>
* @param command command to be executed.
* @param args command arguments.
* @return {@link CommandResult} which encapsulates exit status, command output, failure cause (if any).
*/
CommandResult run(String command, String... args);
/**
* Set the terse level.
* If true, output data is very concise and in a format that is optimized for use in programs
* instead of for reading by humans. Typically, descriptive text and detailed status messages are
* also omitted from the output data. Default is true.
*
* @param terse true to get concise output, false otherwise.
*/
void setTerse(boolean terse);
}