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.impl.command;
021
022 import org.crsh.command.NoSuchCommandException;
023 import org.crsh.command.ShellCommand;
024 import org.crsh.lang.CommandManager;
025 import org.crsh.plugin.PluginContext;
026
027 import java.security.Principal;
028
029 public class CRaSH {
030
031 /** . */
032 final PluginContext context;
033
034 /** . */
035 final CommandManager commandManager;
036
037 /**
038 * Create a new CRaSH.
039 *
040 * @param context the plugin context
041 * @throws NullPointerException if the context argument is null
042 */
043 public CRaSH(PluginContext context) throws NullPointerException {
044 this.context = context;
045 this.commandManager = CommandManager.create(context);
046 }
047
048 public CRaSHSession createSession(Principal user) {
049 return new CRaSHSession(this, user);
050 }
051
052 /**
053 * Returns the plugin context.
054 *
055 * @return the plugin context
056 */
057 public PluginContext getContext() {
058 return context;
059 }
060
061 /**
062 * Attempt to obtain a command instance. Null is returned when such command does not exist.
063 *
064 * @param name the command name
065 * @return a command instance
066 * @throws org.crsh.command.NoSuchCommandException if an error occured preventing the command creation
067 * @throws NullPointerException if the name argument is null
068 */
069 public ShellCommand getCommand(String name) throws NoSuchCommandException, NullPointerException {
070 return commandManager.getCommand(name);
071 }
072 }