001    /*
002     * Copyright (C) 2010 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.shell;
021    
022    /**
023     * The shell process.
024     *
025     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
026     * @version $Revision$
027     */
028    public interface ShellProcess {
029    
030      /**
031       * Begin the process. The client of this method should make no assumption whether the process is executed
032       * in a synchronous or asynchronous manner. The process will be termined when the process signals it
033       * with an invocation of the {@link ShellProcessContext#end(ShellResponse)} method.
034       *
035       * @param processContext the process context
036       * @throws IllegalStateException if the process cannot be executed for some reason
037       */
038      void execute(ShellProcessContext processContext) throws IllegalStateException;
039    
040      /**
041       * Signals the process it should be cancelled.
042       */
043      void cancel();
044    
045    }