org.fabric3.admin.interpreter.Command Maven / Gradle / Ivy

Go to download
/*
 * Fabric3
 * Copyright ? 2008 Metaform Systems Limited
 *
 * This proprietary software may be used only connection with the Fabric3 license
 * (the ?License?), a copy of which is included in the software or may be
 * obtained at: http://www.metaformsystems.com/licenses/license.html.

 * Software distributed under the License is distributed on an ?as is? basis,
 * without warranties or conditions of any kind.  See the License for the
 * specific language governing permissions and limitations of use of the software.
 * This software is distributed in conjunction with other software licensed under
 * different terms.  See the separate licenses for those programs included in the
 * distribution for the permitted and restricted uses of such software.
 *
 */
package org.fabric3.admin.interpreter;

import java.io.PrintStream;

/**
 * Commands are constructed by a CommandParser that walks the AST generated from a instructions submitted to the Interpreter. Typically, Commands
 * operate against the DomainController.
 *
 * @version $Revision$ $Date$
 */
public interface Command {

    void setUsername(String username);

    void setPassword(String password);

    /**
     * Executes the command.
     *
     * @param out the PrintStream where command output is sent
     * @throws CommandException if  there is an exception executing the command
     * @return true if the command completed successfully, false of there was an error
     */
    boolean execute(PrintStream out) throws CommandException;

}