org.nuxeo.shell

Class Shell

java.lang.Object

org.nuxeo.shell.Shell

public final class Shell
extends Object

There is a single instance of the shell in the VM. To get it call get(). parse args if no cmd attempt to read from stdin a list of cmds or from a faile -f if cmd run it. A cmd line instance is parsing a single command. parsed data is injected into the command and then the command is run. a cmd type is providing the info on how a command is injected. top level params are: -h help -u username -p password -f batch file - batch from stdin

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandRegistry	activeRegistry
protected CompositeValueAdapter	adapter
protected Map<String,CommandRegistry>	cmds
protected CompositeCompletorProvider	completorProvider
protected ShellConsole	console
protected Map<String,Object>	ctx
protected Map<Class<?>,Object>	ctxObjects
protected Map<Class<?>,ShellFeature>	features
protected List<ShellConfigurationListener>	listeners
protected LinkedHashMap<String,String>	mainArgs
protected Properties	settings
protected List<String>	versions A list with all version lines to be displayed when version command is executed.

Method Summary

Modifier and Type	Method and Description
void	addCompletorProvider(CompletorProvider provider)
void	addConfigurationListener(ShellConfigurationListener listener)
void	addFeature(ShellFeature feature)
void	addRegistry(CommandRegistry reg)
void	addValueAdapter(ValueAdapter adapter)
void	bye()
LinkedHashMap<String,String>	collectArgs(String[] args)
protected ShellConsole	createConsole()
static Shell	get()
CommandRegistry	getActiveRegistry()
boolean	getBooleanSetting(String key, boolean defValue)
CompletorProvider	getCompletorProvider()
File	getConfigDir()
ShellConsole	getConsole()
<T> T	getContextObject(Class<T> type)
protected String	getDefaultNamespace()
<T extends ShellFeature> T	getFeature(Class<T> type)
ShellFeature[]	getFeatures()
File	getHistoryFile()
LinkedHashMap<String,String>	getMainArguments()
Map<String,Object>	getProperties()
Object	getProperty(String key)
Object	getProperty(String key, Object defaultValue)
CommandRegistry[]	getRegistries()
CommandRegistry	getRegistry(String name)
String[]	getRegistryNames()
String	getSetting(String key)
String	getSetting(String key, String defValue)
Properties	getSettings()
File	getSettingsFile()
ValueAdapter	getValueAdapter()
List<String>	getVersions()
void	hello()
void	loadConfig()
protected void	loadFeatures()
protected void	loadSettings()
void	main(String[] args)
jline.ANSIBuffer	newANSIBuffer()
Runnable	newCommand(String... line)
Runnable	newCommand(String cmdline)
String[]	parse(char[] cbuf)
String[]	parse(String cmdline)
<T> void	putContextObject(Class<T> type, T instance)
void	removeConfigurationChangeListener(ShellConfigurationListener listener)
<T> T	removeContextObject(Class<T> type)
CommandRegistry	removeRegistry(String key)
void	removeValueAdapter(ValueAdapter adapter)
static void	reset() Reset the shell instance.
void	run(Runnable cmd)
void	run(String... line)
void	run(String cmdline)
void	runBatch(List<String> lines)
CommandRegistry	setActiveRegistry(String name) Mark an already registered command registry as the active one.
void	setConsole(ShellConsole console)
void	setProperty(String key, Object value)
void	setSetting(String name, String value)

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected List<ShellConfigurationListener> listeners

mainArgs

protected LinkedHashMap<String,String> mainArgs

completorProvider

protected CompositeCompletorProvider completorProvider

adapter

protected CompositeValueAdapter adapter

console

protected ShellConsole console

cmds

protected Map<String,CommandRegistry> cmds

activeRegistry

protected CommandRegistry activeRegistry

ctx

protected Map<String,Object> ctx

settings

protected Properties settings

ctxObjects

protected Map<Class<?>,Object> ctxObjects

features

protected Map<Class<?>,ShellFeature> features

versions

protected List<String> versions

A list with all version lines to be displayed when version command is executed.

Method Detail

get

public static Shell get()

reset

public static void reset()

Reset the shell instance. Useful for embedded shells like applets.

getVersions

public List<String> getVersions()

addConfigurationListener

public void addConfigurationListener(ShellConfigurationListener listener)

removeConfigurationChangeListener

public void removeConfigurationChangeListener(ShellConfigurationListener listener)

loadSettings

protected void loadSettings()
                     throws IOException

Throws:

IOException

getSettings

public Properties getSettings()

setSetting

public void setSetting(String name,
                       String value)

getSetting

public String getSetting(String key)

getSetting

public String getSetting(String key,
                         String defValue)

getBooleanSetting

public boolean getBooleanSetting(String key,
                                 boolean defValue)

getConfigDir

public File getConfigDir()

getSettingsFile

public File getSettingsFile()

getHistoryFile

public File getHistoryFile()

loadFeatures

protected void loadFeatures()

getDefaultNamespace

protected String getDefaultNamespace()

getMainArguments

public LinkedHashMap<String,String> getMainArguments()

main

public void main(String[] args)
          throws Exception

Throws:

Exception

collectArgs

public LinkedHashMap<String,String> collectArgs(String[] args)

parse

public String[] parse(String cmdline)

parse

public String[] parse(char[] cbuf)

createConsole

protected ShellConsole createConsole()

addValueAdapter

public void addValueAdapter(ValueAdapter adapter)

removeValueAdapter

public void removeValueAdapter(ValueAdapter adapter)

addCompletorProvider

public void addCompletorProvider(CompletorProvider provider)

getContextObject

public <T> T getContextObject(Class<T> type)

putContextObject

public <T> void putContextObject(Class<T> type,
                                 T instance)

removeContextObject

public <T> T removeContextObject(Class<T> type)

getCompletorProvider

public CompletorProvider getCompletorProvider()

addRegistry

public void addRegistry(CommandRegistry reg)

removeRegistry

public CommandRegistry removeRegistry(String key)

getRegistry

public CommandRegistry getRegistry(String name)

getRegistries

public CommandRegistry[] getRegistries()

getRegistryNames

public String[] getRegistryNames()

getActiveRegistry

public CommandRegistry getActiveRegistry()

setActiveRegistry

public CommandRegistry setActiveRegistry(String name)

Mark an already registered command registry as the active one.

Parameters:

name -

Returns:

getConsole

public ShellConsole getConsole()

setConsole

public void setConsole(ShellConsole console)

getValueAdapter

public ValueAdapter getValueAdapter()

getProperty

public Object getProperty(String key)

getProperty

public Object getProperty(String key,
                          Object defaultValue)

setProperty

public void setProperty(String key,
                        Object value)

getProperties

public Map<String,Object> getProperties()

runBatch

public void runBatch(List<String> lines)
              throws ShellException

Throws:

ShellException

run

public void run(String cmdline)
         throws ShellException

Throws:

ShellException

run

public void run(String... line)
         throws ShellException

Throws:

ShellException

run

public void run(Runnable cmd)
         throws ShellException

Throws:

ShellException

newCommand

public Runnable newCommand(String cmdline)
                    throws ShellException

Throws:

ShellException

newCommand

public Runnable newCommand(String... line)
                    throws ShellException

Throws:

ShellException

hello

public void hello()
           throws IOException

Throws:

IOException

bye

public void bye()

getFeatures

public ShellFeature[] getFeatures()

getFeature

public <T extends ShellFeature> T getFeature(Class<T> type)

addFeature

public void addFeature(ShellFeature feature)

newANSIBuffer

public jline.ANSIBuffer newANSIBuffer()

loadConfig

public void loadConfig()
                throws IOException

Throws:

IOException