Nuxeo Server

Shell Namespaces

Updated: October 13, 2017 Page Information Edit on GitHub

This page is scheduled for review and update. Check back soon for updated content!

We are getting now to the end of our breakthrough about extending the shell.

We've already seen how to add new Shell Features and how to implement new commands. This last chapter is talking a bit about Shell Namespaces.

The Shell Prompt

As we've already seen, namespaces are in fact hierarchical registries of commands. When entering a namespace all other namespaces not extended by the current namespace are hidden for the shell user. But there is still a point we have not yet discussed yet - the fact that a namespace may change the shell prompt when it is activated. This is important because it is a visual feedback for the user that it switched to another context.

To explain how a namespace is changing the shell prompt I will give the example of the local namespcae provided by the FileSystem feature. It's really easy: the FileSystem feature is registering and activating the local namespace which is implemented by a subclass of CommandRegsitry. The CommandRegistry is providing a method that any subclass may override: String getPrompt(Shell shell).

So when creating a new namespace (i.e. CommandRegistry) you can override this method to return the prompt for your namespace. Here is the implementation of String getPrompt(Shell shell) of the FileSystemCommands class (which is the materialization of the local namespace):

    public String getPrompt(Shell shell) {
        return System.getProperty("") + ":"
                + shell.getContextObject(FileSystem.class).pwd().getName()
                + "$ ";

So we can see that the prompt is dynamically updated after each command execution to reflect the new context. In this case we print the local username and the name of the current directory.

The Default Namespace

The shell will activate by default the remote namespace if any with that name exists, otherwise it is activating the local namespace if any such namespace exists, otherwise the global namespace is activated.

To force a namespace to be activated when the shell starts you can use the shell Java System Property when launching the shell application. For example, the following will activate the namespace equinox when the shell starts:

java -Dshell=equinox -jar nuxeo-shell.jar

Of course, you should provide an "equinox" namespace to have this working - otherwise the default shell namespace will be used.

Executing Initialization Code at Startup

If your namespace need to execute some code when the shell is launched and your namespace is activated (because you set it as the default one) then you should override the method CommandRegistry.autorun(Shell shell) and provide your logic there. You can use this to automatically connect to a remote host if the connection details were specified on the command line when starting the shell. See the AutomationFeature "remote" namespace - this is the way it is automatically connecting when you specify the connection details on the shell command line.


5 days ago manonlumeau NXDOC-1346-FT review screenshot
a year ago Solen Guitter 11
2 years ago Solen Guitter 10 | Update table of contents look
4 years ago Solen Guitter 8 | Added TOC
4 years ago Solen Guitter 9
5 years ago Solen Guitter 6 | Added related pages
5 years ago Solen Guitter 7 | Migrated to Confluence 4.0
7 years ago Bogdan Stefanescu 5
7 years ago Bogdan Stefanescu 4
7 years ago Bogdan Stefanescu 3
7 years ago Bogdan Stefanescu 2
7 years ago Bogdan Stefanescu 1
History: Created by Bogdan Stefanescu