org.crsh.shell.impl.command

Class CRaSH

java.lang.Object

org.crsh.shell.impl.command.CRaSH

public class CRaSH
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CRaSH(PluginContext context) Create a new CRaSH.

Method Summary

Methods

Modifier and Type	Method and Description
CRaSHSession	createSession(java.security.Principal user)
ShellCommand	getCommand(java.lang.String name) Attempt to obtain a command instance.
java.lang.String	getCommandDescription(java.lang.String name) Attempt to obtain a command description.
java.lang.Iterable<java.lang.String>	getCommandNames()
PluginContext	getContext() Returns the plugin context.
CommandResolution	resolveCommand(java.lang.String name) Attempt to obtain a command instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRaSH

public CRaSH(PluginContext context)
      throws java.lang.NullPointerException

Create a new CRaSH.

Parameters:

context - the plugin context

Throws:

java.lang.NullPointerException - if the context argument is null

Method Detail

createSession

public CRaSHSession createSession(java.security.Principal user)

getContext

public PluginContext getContext()

Returns the plugin context.

Returns:

the plugin context

getCommandDescription

public java.lang.String getCommandDescription(java.lang.String name)
                                       throws CommandCreationException,
                                              java.lang.NullPointerException

Attempt to obtain a command description. Null is returned when such command does not exist.

Parameters:

name - the command name

Returns:

a command description

Throws:

CommandCreationException - if an error occured preventing the command creation

java.lang.NullPointerException - if the name argument is null

getCommand

public ShellCommand getCommand(java.lang.String name)
                        throws CommandCreationException,
                               java.lang.NullPointerException

Attempt to obtain a command instance. Null is returned when such command does not exist.

Parameters:

name - the command name

Returns:

a command instance

Throws:

CommandCreationException - if an error occured preventing the command creation

java.lang.NullPointerException - if the name argument is null

resolveCommand

public CommandResolution resolveCommand(java.lang.String name)
                                 throws CommandCreationException,
                                        java.lang.NullPointerException

Attempt to obtain a command instance. Null is returned when such command does not exist.

Parameters:

name - the command name

Returns:

a command instance

Throws:

CommandCreationException - if an error occured preventing the command creation

java.lang.NullPointerException - if the name argument is null

getCommandNames

public java.lang.Iterable<java.lang.String> getCommandNames()