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    import org.crsh.cmdline.CommandCompletion;
023    
024    /**
025     * A shell, it defines the interactions provided by a shell.
026     *
027     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
028     * @version $Revision$
029     */
030    public interface Shell {
031    
032      /**
033       * Returns the welcome message.
034       *
035       * @return the welcome message
036       */
037      String getWelcome();
038    
039      /**
040       * Returns the shell prompt.
041       *
042       * @return the shell prompt
043       */
044      String getPrompt();
045    
046      /**
047       * Process a request.
048       *
049       * @param request the request to process
050       * @return the process
051       * @throws IllegalStateException if the shell cannot create a process
052       */
053      ShellProcess createProcess(String request) throws IllegalStateException;
054    
055      /**
056       * Completion.
057       *
058       *
059       * @param prefix the prefix to complete
060       * @return the sorted list of available suffixes
061       */
062      CommandCompletion complete(String prefix);
063    
064    }