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