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.spi;
020
021import java.util.HashMap;
022import java.util.Set;
023
024/** @author Julien Viet */
025public interface CommandManager {
026
027  /**
028   * Return true if this command manager is active. Implementation can decide based on the runtime, for instance the
029   * Groovy REPL can be inactive when Groovy is not available at runtime.
030   *
031   * @return the active status
032   */
033  boolean isActive();
034
035  /**
036   * Returns the set of extensions managed by this implementation.
037   *
038   * @return the set of extensions, for instance ("groovy")
039   */
040  Set<String> getExtensions();
041
042  /**
043   * Resolve a command for the specified command name.
044   *
045   * @param name the command name
046   * @param source the command source  @return the command or null if no command can be resolved
047   * @throws CommandCreationException when the command exists but cannot be created
048   * @throws NullPointerException if the command name is null
049   */
050  CommandResolution resolveCommand(String name, byte[] source) throws CommandCreationException, NullPointerException;
051
052  void init(HashMap<String, Object> session);
053
054  void destroy(HashMap<String, Object> session);
055
056  String doCallBack(HashMap<String, Object> session, String name, String defaultValue);
057
058}