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 */
019package org.crsh.shell.impl.command;
020
021import org.crsh.command.CommandCreationException;
022import org.crsh.command.ShellCommand;
023
024import java.util.HashMap;
025import java.util.Set;
026
027/** @author Julien Viet */
028public interface CommandManager {
029
030  /**
031   * Returns the set of extensions managed by this implementation.
032   *
033   * @return the set of extensions, for instance ("groovy")
034   */
035  Set<String> getExtensions();
036
037  /**
038   * Resolve a command for the specified command name.
039   *
040   * @param name the command name
041   * @param source the command source
042   * @return the command or null if no command can be resolved
043   * @throws CommandCreationException when the command exists but cannot be created
044   * @throws NullPointerException if the command name is null
045   */
046  ShellCommand resolveCommand(String name, byte[] source) throws CommandCreationException, NullPointerException;
047
048  void init(HashMap<String, Object> session);
049
050  void destroy(HashMap<String, Object> session);
051
052  String doCallBack(HashMap<String, Object> session, String name, String defaultValue);
053
054}