Managing Namespaces

September 25, 2020 ยท View on GitHub

What is a Namespace ?
A namespace provides a secure workspace for saving models, without interfering with models of other users.


Creating your Namespace

When you first login with your account, you won't be able to create Vorto Models.
In order to create them, you need to either own your own namespace or be part of a project in which you've been assigned the role of Model Creator.

Creating a new namespace can easily be done by clicking on the Manage tab and then Create. namespace tab


This will trigger a dialog box which let's you enter the namespace you want to use.

Note: Each newly created Namespace will use the vorto.private prefix. If you want to claim an official namespace like e.g. org.eclipse.vorto you need to reach out to the Vorto Team.

namespace tab


Once the create button is clicked, your new namespace will be created.
By default, you as the namespace owner will have all permissions and are able to manage the namespace and it's collaborators.

namespace tab


Claiming an official Namespace

If you want to make the models you've created publicly available, you need to own the according official namespace.
In order to claim an official namespace, like e.g. org.eclipse.vorto, you need to reach out to the Vorto Team.

When reaching out to the Vorto Dev Team, please make sure to include the name of the namespace and UserId of its Owner.


In case you're having difficulties or facing any issues, feel free to create a new question on StackOverflow and we'll answer it as soon as possible!
Please make sure to use eclipse-vorto as one of the tags.


Sub-namespaces

What is a "sub-namespace"?

Namespaces are expressed as dot-separated sequences of characters, reflecting some organizational hierarchy much like package names in most programming languages.

Sub-namespaces are "virtual" namespaces that allow models to be placed "one or more levels deeper" than their "parent" namespace, purely for aesthetical or organizational purposes.

Access criteria for models are identical between a namespace and any sub-namespace it might feature.

It is also worth noting that sub-namespaces are the only way to create hierarchical namespaces.

In other words, if the namespace com.mycompany exists, one can only create models in com.mycompany.examples via a sub-namespace. However, creating another namespace called com.mycompany.examples is not possible.