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.GroovyScript;
023 import org.crsh.command.GroovyScriptCommand;
024 import org.crsh.command.NoSuchCommandException;
025 import org.crsh.command.ShellCommand;
026 import org.crsh.plugin.PluginContext;
027 import org.crsh.plugin.ResourceKind;
028
029 import java.security.Principal;
030
031 public class CRaSH {
032
033
034 /** . */
035 final AbstractClassManager<? extends ShellCommand> commandManager;
036
037 /** . */
038 final AbstractClassManager<? extends GroovyScript> scriptManager;
039
040 /** . */
041 final PluginContext context;
042
043 /**
044 * Create a new CRaSH.
045 *
046 * @param context the plugin context
047 * @throws NullPointerException if the context argument is null
048 */
049 public CRaSH(PluginContext context) throws NullPointerException {
050 this(
051 context,
052 new ClassManager<ShellCommand>(context, ResourceKind.COMMAND, ShellCommand.class, GroovyScriptCommand.class),
053 new ClassManager<GroovyScript>(context, ResourceKind.LIFECYCLE, GroovyScript.class, GroovyScript.class)
054 );
055 }
056
057 public CRaSH(PluginContext context, AbstractClassManager<ShellCommand> commandManager, AbstractClassManager<? extends GroovyScript> scriptManager) {
058 this.context = context;
059 this.commandManager = commandManager;
060 this.scriptManager = scriptManager;
061 }
062
063 public CRaSHSession createSession(Principal user) {
064 return new CRaSHSession(this, user);
065 }
066
067 /**
068 * Returns the plugin context.
069 *
070 * @return the plugin context
071 */
072 public PluginContext getContext() {
073 return context;
074 }
075
076 /**
077 * Attempt to obtain a command instance. Null is returned when such command does not exist.
078 *
079 * @param name the command name
080 * @return a command instance
081 * @throws org.crsh.command.NoSuchCommandException if an error occured preventing the command creation
082 * @throws NullPointerException if the name argument is null
083 */
084 public ShellCommand getCommand(String name) throws NoSuchCommandException, NullPointerException {
085 return commandManager.getInstance(name);
086 }
087 }