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    package org.crsh.shell.impl.command;
020    
021    import org.crsh.lang.spi.Repl;
022    import org.crsh.shell.impl.command.spi.Command;
023    import org.crsh.shell.impl.command.spi.CommandException;
024    import org.crsh.plugin.PluginContext;
025    
026    import java.util.Map;
027    
028    /** @author Julien Viet */
029    public interface ShellSession extends Map<String, Object> {
030    
031      PluginContext getContext();
032    
033      Iterable<Map.Entry<String, String>> getCommands();
034    
035      Command<?> getCommand(String name) throws CommandException;
036    
037      /**
038       * @return the current repl of this session
039       */
040      Repl getRepl();
041    
042      /**
043       * Set the current repl of this session.
044       *
045       * @param repl the new repl
046       * @throws NullPointerException if the repl is null
047       */
048      void setRepl(Repl repl) throws NullPointerException;
049    
050    }