-
Notifications
You must be signed in to change notification settings - Fork 3
WebUI v2 (Vaadin)
The following chapters describe the recommended complete user guide graphical user interface (WebUI).
After successfully running CRCE, the new application is available at: http://server_address:8080/crce-webui, where the server_address is the address of the computer where the storage program is running.
After successfully logging in to the application, CRCE storage is enabled. For each logged-in user, a custom session is created and the logon name is listed in the button name in the upper-right corner of the application. Here, you can opt out of the program. The application menu allows you to select from the following options:
- Upload
- Repository
- Settings
After selecting the Upload option from the menu, uploading components to the CRCE storage from the file system and from external storage. The first option is Local, that is, the local Maven repository. This is in the sense of local server-side Maven storage. Local Maven storage may exist on the server side and on the client side. It is necessary to realize that this is a web application, that is client/server. The program runs on the server side, and for security reasons, it is not possible to have access to the file system on the client side. Setting the path to the local Maven storage is enabled by selecting Settings and then Path in the application menu. The setting description will be listed below.
With the Upload button, which is displayed after you click on the file tree, you can load the selected artifact into the repository. It is only allowed to upload files, not directories. Successfully or unsuccessfully, the application artifact will be displayed. With the Remove button, you can delete files and directories from your local Maven repository. However, this option is not enabled by default, that is the button is not displayed. You can enable the deletion of objects from your local Maven storage by checking the option in the Paths form in the Settings menu. Removing items from a local Maven repository is implemented in a web interface application mainly because the configured path of the local Maven repository is used by the Aether library. The Aether library uses this storage as temporary when downloading artifacts. Even if the search artifact is not present in the external repository, the Aether library creates a record (folder) in the local Maven store that matches the group id of the artifact. These "empty" folders can then be removed using the Remove button.
By selecting Central, a form to retrieve artifacts from the central Maven store is displayed on url http://repo.maven.apache.org/maven2. You can change the address in the Paths form by selecting Settings in the menu. Finding an artifact in the central Maven store takes place in two ways, which can be selected using the Direct or search index switch. Index search is available only after the index has been created, respectively. Check its up-to-date in the Settings menu and the form Index, and also if you do not allow group searches, see below. When selecting Direct, you must fill in the exact group, artifact, version, and type identifier on the form. The subgroups in GroupId are separated by a dot. The Search button starts searching and, if successful, this artifact is displayed in the Result list dialog box. Once selected, the Upload button is automatically displayed to retrieve the file into the repository.
The application gives you the ability to view all subgroups and their artifacts from the central Maven repository. In this case, only the GroupId entry is sufficient in the form. A complete group is considered, including the parent groups separated by dots. However, it should be noted that the tree of the subgroups and artifacts can be extensive and its loading is time consuming in this case. By default, subgroups are not enabled for this reason. You can change the settings by selecting Enable only group search in the form Path in the Settings menu.
When you switch the Index option, you can search the central Maven repositories for a created index with only partial entries Group id and Artefact id (text terminated with *). The * character can be used at the end and middle of the text, but it can not be used at the beginning. If the user * does not use the character in the entry, the application searches for the exact name entered. The index must be created or validated prior to the index search function itself. Index verification is started by selecting the Index in the Settings menu and pressing the Check Index button. Updating the index, especially its complete creation, is a time-consuming issue (usually in the order of tens of minutes). For this reason, indexing runs in the background of the application and does not restrict user activity when using the graphical interface. The application searches the version of the available artifacts using the index in the user-defined range. If the user requested all available versions, he would fill version 0.0.0 in the Version form entry, and select Range >=.
By selecting Defined in the Upload menu item, a form to retrieve artifacts from Aether-enabled storage artefacts is displayed. The external storage address can be customized on the form. By default, the address of the central Maven repository is listed. The advantage of this way of downloading artifacts is that when they load into the CRCE repository, they create a copy of them in the local Maven server repository (the path is listed in the application settings, the form Path in the Settings menu as the local Maven repository parameter). When attempting to retrieve an artifact is no longer touched by a network connection, it will be used from the local Maven repository.
After successful search of the artifact or verifying the existence of groupId and artefactId in an external storage is displayed in the Result list dialog. This verification does not mean that the artifact (the filename) in the external storage is actually present. This is the property of the Aether Library. By selecting this item, the Resolve and Upload buttons are automatically available. By selecting the Resolve button, the application validates the actual availability of the artefact (file) in the external storage, and at the same time creates a copy of it in the local local Maven store (downloads the file over the network). Using the Upload button, the application saves the selected artifact to the local storage if it is not already stored (it does not download it again over the network but uses this saved artifact), and it loads it into the CRCE store.
Selecting the File/url item in the Upload menu will display a form for retrieving artifacts from the file system on the client computer or from a link url.
In the Repository entry in the application menu are available for managing the life cycle of components in CRCE. This is access to temporary Buffer storage and Store storage, and a list of installed plugins. Managing items in Store and Buffer is similar. For this reason, only the Temporary Storage Buffer user environment will be described.
In the form Buffer a user environment, you can sort or filter the list items by name. There is also the option to delete the selected item or display its metadata. In the metadata preview form of the selected item in Buffer, the list of Properties, Capabilities, and Requirements of the tagged Artifact is dispensed.
Identically for Buffer storage, a user interface for the Store is created in the application. The difference between these two environments is that items in the temporary Buffer store each logged-in user in the application within their session. Once logged out, they are deleted. In contrast, the permanent storage of artifacts Store items remain preserved and are common to all users CRCE. The application provides the ability to migrate artifacts from temporary to permanent storage by pressing the Push to Store button on the Buffer preview form.
In the Settings menu in the application menu, it is possible to run the index creation of the central Maven repository and custom parameter settings. This is a url link to the Maven central repository and the path to the local Maven repository for the Aether library. Another, selectable option is to enable or disable search and display by grouping in the form of loading artifacts from the central Maven repository and allowing or disabling the removal of items in the local (Aether) repository.
[ CRCE wiki ]