001    /*
002     * Copyright (C) 2012 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    public interface Shell {
025    
026      /**
027       * Returns the welcome message.
028       *
029       * @return the welcome message
030       */
031      String getWelcome();
032    
033      /**
034       * Returns the shell prompt.
035       *
036       * @return the shell prompt
037       */
038      String getPrompt();
039    
040      /**
041       * Process a request.
042       *
043       * @param request the request to process
044       * @return the process
045       * @throws IllegalStateException if the shell cannot create a process
046       */
047      ShellProcess createProcess(String request) throws IllegalStateException;
048    
049      /**
050       * Completion.
051       *
052       *
053       * @param prefix the prefix to complete
054       * @return the sorted list of available suffixes
055       */
056      CommandCompletion complete(String prefix);
057    
058    }