org.apache.karaf.shell.console
Class Main

java.lang.Object
  org.apache.karaf.shell.console.Main

public class Main
extends Object

Constructor Summary

Main()

Method Summary

protected void	addCommand(Command cmd, org.apache.felix.service.command.Function function, org.apache.felix.gogo.runtime.CommandProcessorImpl commandProcessor)
protected Console	createConsole(org.apache.felix.gogo.runtime.CommandProcessorImpl commandProcessor, InputStream in, PrintStream out, PrintStream err, jline.Terminal terminal) Allow sub classes of main to change the Console implementation used.
String	getApplication()
String	getDiscoveryResource() Sub classes can override so that their registered commands do not conflict with the default shell implementation.
String	getUser()
boolean	isMultiScopeMode() Returns whether or not we are in multi-scope mode.
static void	main(String[] args)
void	run(org.apache.felix.service.command.CommandSession parent, String[] args) Use this method when the shell is being executed as a command of another shell.
void	run(String[] args) Use this method when the shell is being executed as a top level shell.
void	setApplication(String application)
void	setUser(String user)

Methods inherited from class java.lang.Object

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

Constructor Detail

Main

public Main()

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

run

public void run(String[] args)
         throws Exception

Use this method when the shell is being executed as a top level shell.

Parameters:

args -

Throws:

Exception

run

public void run(org.apache.felix.service.command.CommandSession parent,
                String[] args)
         throws Exception

Use this method when the shell is being executed as a command of another shell.

Parameters:

parent -

args -

Throws:

Exception

createConsole

protected Console createConsole(org.apache.felix.gogo.runtime.CommandProcessorImpl commandProcessor,
                                InputStream in,
                                PrintStream out,
                                PrintStream err,
                                jline.Terminal terminal)
                         throws Exception

Allow sub classes of main to change the Console implementation used.

Parameters:

commandProcessor -

in -

out -

err -

terminal -

Returns:

Throws:

Exception

getDiscoveryResource

public String getDiscoveryResource()

Sub classes can override so that their registered commands do not conflict with the default shell implementation.

Returns:

addCommand

protected void addCommand(Command cmd,
                          org.apache.felix.service.command.Function function,
                          org.apache.felix.gogo.runtime.CommandProcessorImpl commandProcessor)

getApplication

public String getApplication()

setApplication

public void setApplication(String application)

getUser

public String getUser()

setUser

public void setUser(String user)

isMultiScopeMode

public boolean isMultiScopeMode()

Returns whether or not we are in multi-scope mode. The default mode is multi-scoped where we prefix commands by their scope. If we are in single scoped mode then we don't use scope prefixes when registering or tab completing commands.