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 process context is the main interaction interface between a shell process and its context.
024     *
025     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
026     * @version $Revision$
027     */
028    public interface ShellProcessContext {
029    
030      /**
031       * Returns the term width in chars. When the value is not positive it means the value could not be determined.
032       *
033       * @return the term width
034       */
035      int getWidth();
036    
037      /**
038       * Returns the property defined within this context.
039       *
040       * @param name the name of the property
041       * @return the value of the property
042       */
043      String getProperty(String name);
044    
045      /**
046       * A callback made by the process when it needs to read a line of text on the term.
047       *
048       * @param msg the message to display prior reading the term
049       * @param echo whether the input line should be echoed or not
050       * @return the line read or null if no line was possible to be read
051       */
052      String readLine(String msg, boolean echo);
053    
054      /**
055       * This method is invoked when the process ends.
056       *
057       * @param response the shell response
058       */
059      void end(ShellResponse response);
060    }