| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content=""> |
| <meta name="keywords" content="extensionsdev-docs, framework, plugin, extension, project import, file system"> |
| <title>Handling Projects in Server and Client Side Plugins | Eclipse Che Documentation</title> |
| <link rel="stylesheet" href="css/syntax.css"> |
| |
| <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" crossorigin="anonymous"> |
| <!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">--> |
| <link rel="stylesheet" href="css/modern-business.css"> |
| <!-- Latest compiled and minified CSS --> |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"> |
| <link rel="stylesheet" href="css/customstyles.css"> |
| <link rel="stylesheet" href="css/boxshadowproperties.css"> |
| <!-- most color styles are extracted out to here --> |
| <link rel="stylesheet" href="css/theme-che.css"> |
| |
| |
| <link rel="stylesheet" href="/css/coderay.css" media="screen" type="text/css"> |
| |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" crossorigin="anonymous"></script> |
| |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script> |
| <script src="js/jquery.navgoco.min.js"></script> |
| |
| |
| <!-- Latest compiled and minified JavaScript --> |
| <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script> |
| <!-- Anchor.js --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" crossorigin="anonymous"></script> |
| <script src="js/toc.js"></script> |
| <script src="js/customscripts.js"></script> |
| |
| <link rel="shortcut icon" href="che/docs/images/favicon.ico"> |
| |
| <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries --> |
| <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> |
| <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| |
| <link rel="alternate" type="application/rss+xml" title="che" href="http://0.0.0.0:4000/feed.xml"> |
| |
| <script> |
| $(document).ready(function() { |
| // Initialize navgoco with default options |
| $("#mysidebar").navgoco({ |
| caretHtml: '', |
| accordion: true, |
| openClass: 'active', // open |
| save: false, // leave false or nav highlighting doesn't work right |
| cookie: { |
| name: 'navgoco', |
| expires: false, |
| path: '/' |
| }, |
| slide: { |
| duration: 400, |
| easing: 'swing' |
| } |
| }); |
| |
| $("#collapseAll").click(function(e) { |
| e.preventDefault(); |
| $("#mysidebar").navgoco('toggle', false); |
| }); |
| |
| $("#expandAll").click(function(e) { |
| e.preventDefault(); |
| $("#mysidebar").navgoco('toggle', true); |
| }); |
| |
| }); |
| |
| </script> |
| <script> |
| $(function () { |
| $('[data-toggle="tooltip"]').tooltip() |
| }) |
| </script> |
| <script> |
| $(document).ready(function() { |
| $("#tg-sb-link").click(function() { |
| $("#tg-sb-sidebar").toggle(); |
| $("#tg-sb-content").toggleClass('col-md-9'); |
| $("#tg-sb-content").toggleClass('col-md-12'); |
| $("#tg-sb-icon").toggleClass('fa-toggle-on'); |
| $("#tg-sb-icon").toggleClass('fa-toggle-off'); |
| }); |
| }); |
| </script> |
| |
| |
| </head> |
| <body> |
| <!-- Navigation --> |
| <nav class="navbar navbar-inverse navbar-static-top"> |
| <div class="container topnavlinks"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> Eclipse Che Documentation</span></a> |
| </div> |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav navbar-right"> |
| <!-- toggle sidebar button --> |
| <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li> |
| <!-- entries without drop-downs appear here --> |
| |
| |
| |
| |
| |
| |
| |
| <li><a href="https://medium.com/eclipse-che-blog/" target="_blank">Blog</a></li> |
| |
| |
| |
| <li><a href="https://github.com/eclipse/che" target="_blank">Source Code</a></li> |
| |
| |
| |
| <!-- entries with drop-downs appear here --> |
| <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.--> |
| |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Support<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| |
| |
| <li><a href="https://github.com/eclipse/che/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fbug" target="_blank">Known Bugs</a></li> |
| |
| |
| |
| <li><a href="https://github.com/eclipse/che/issues/new" target="_blank">File an Issue</a></li> |
| |
| |
| |
| <li><a href="https://stackoverflow.com/questions/tagged/eclipse-che" target="_blank">Che on StackOverflow</a></li> |
| |
| |
| </ul> |
| </li> |
| |
| |
| <!-- |
| <li> |
| |
| |
| |
| <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:?subject= feedback&body=I have some feedback about the Handling Projects in Server and Client Side Plugins page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a> |
| |
| </li> |
| --> |
| |
| <!--comment out this block if you want to hide search--> |
| <li> |
| <!--start search--> |
| <div id="search-demo-container"> |
| <input type="text" id="search-input" placeholder="search..."> |
| <ul id="results-container"></ul> |
| </div> |
| <script src="js/jekyll-search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| SimpleJekyllSearch.init({ |
| searchInput: document.getElementById('search-input'), |
| resultsContainer: document.getElementById('results-container'), |
| dataSource: 'search.json', |
| searchResultTemplate: '<li><a href="{url}" title="Handling Projects in Server and Client Side Plugins">{title}</a></li>', |
| noResultsText: 'No results found.', |
| limit: 10, |
| fuzzy: true, |
| }) |
| </script> |
| <!--end search--> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- /.container --> |
| </nav> |
| |
| <!-- Page Content --> |
| <div class="container"> |
| <div id="main"> |
| <!-- Content Row --> |
| <div class="row"> |
| |
| |
| <!-- Sidebar Column --> |
| <div class="col-md-3" id="tg-sb-sidebar"> |
| |
| |
| <ul id="mysidebar" class="nav"> |
| <li class="sidebarTitle"> </li> |
| |
| |
| |
| |
| |
| <li> |
| <a href="#">Overview</a> |
| <ul> |
| |
| |
| |
| <li><a href="index.html">Introduction</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="quick-start.html">Getting Started</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="single-multi-user.html">Single and Multi-User Flavors</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="infra-support.html">Supported Infrastructures</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Che on Docker</a> |
| <ul> |
| |
| |
| |
| <li><a href="docker-single-user.html">Docker - Single User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="docker-multi-user.html">Docker - Multi User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="docker-config.html">Docker - Configuration</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="docker-cli.html">Docker - CLI Reference</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Che on Kubernetes</a> |
| <ul> |
| |
| |
| |
| <li><a href="kubernetes-single-user.html">Kubernetes - Single User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="kubernetes-multi-user.html">Kubernetes - Multi User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="kubernetes-config.html">Kubernetes - Configuration</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="kubernetes-admin-guide.html">Kubernetes - Admin Guide</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Che on OpenShift</a> |
| <ul> |
| |
| |
| |
| <li><a href="openshift-single-user.html">OpenShift - Single User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="openshift-multi-user.html">OpenShift - Multi User</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="openshift-config.html">OpenShift - Configuration</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="openshift-admin-guide.html">OpenShift - Admin Guide</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">User Management</a> |
| <ul> |
| |
| |
| |
| <li><a href="user-management.html">Authentication and Authorization</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="authentication.html">Security Model</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="permissions.html">Permissions</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="organizations.html">Organizations in UD</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="resource-management.html">Resource Management</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">User Guides</a> |
| <ul> |
| |
| |
| |
| <li><a href="creating-starting-workspaces.html">Creating and starting Workspaces</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="ide-projects.html">Projects</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="editor-code-assistance.html">Editor and Code-Assistance</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="dependency-management.html">Dependency Management</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="commands-ide-macro.html">Commands and IDE Macros</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="version-control.html">Version Control</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="debug.html">Debug</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Workspace Administration</a> |
| <ul> |
| |
| |
| |
| <li><a href="what-are-workspaces.html">Workspace Overview</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="stacks.html">Workspace - Stacks</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="recipes.html">Workspace - Recipes</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="servers.html">Workspace - Servers</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="installers.html">Workspace - Installers</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="volumes.html">Workspace - Volumes Mount</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="env-variables.html">Workspace - Environment Variables</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="projects.html">Workspace - Projects</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="workspaces-troubleshooting.html">Workspace - Troubleshooting</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="workspace-data-model.html">Workspace Data Model</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Portable Workspaces</a> |
| <ul> |
| |
| |
| |
| <li><a href="chedir-getting-started.html">Chedir - Getting Started</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="why-chedir.html">Chedir - Why Chedir?</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="chedir-installation.html">Chedir - Installation</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="chedir-project-setup.html">Chedir - Project Setup</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="chedir-up-and-down.html">Chedir - Up and Down</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="chefile.html">Chedir - Chefile</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="chedir-ssh.html">Chedir - SSH</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="factories-getting-started.html">Factory - Getting Started</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="creating-factories.html">Factory - Creating</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="factories_json_reference.html">Factory - JSON Reference</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Developer Guides</a> |
| <ul> |
| |
| |
| |
| <li><a href="framework-overview.html">Overview</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="rest-api.html">SDK - REST API</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="che-in-che-quickstart.html">SDK - Your First Plugin</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="build-reqs.html">SDK - Building Che</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="assemblies.html">SDK - Assemblies</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="logging.html">SDK - Logging</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="ide-extensions-gwt.html">SDK - GWT IDE Extensions</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="server-side-extensions.html">SDK - Server Side Extensions</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="custom-installers.html">SDK - Installers</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="project-types.html">SDK - Project Types</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="language-servers.html">SDK - Language Support</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="parts.html">IDE UI: Parts</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="actions.html">IDE UI: Actions</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Dev Essentials</a> |
| <ul> |
| |
| |
| |
| <li><a href="guice.html">Dependency Injection</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="dto.html">Transport: DTO</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="json-rpc.html">Communication: JSON-RPC</a></li> |
| |
| |
| |
| |
| |
| |
| <li class="active"><a href="handling-projects-in-plugins.html">Handling Projects in Plugins</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="dao.html">Persistence, DAO</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="properties.html">Properties</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| <a href="#">Infrastructure and SPI</a> |
| <ul> |
| |
| |
| |
| <li><a href="spi_overview.html">Overview</a></li> |
| |
| |
| |
| |
| |
| |
| <li><a href="spi-implementation.html">Implementation Notes</a></li> |
| |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <!-- if you aren't using the accordion, uncomment this block: |
| <p class="external"> |
| <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a> |
| </p> |
| --> |
| </ul> |
| |
| <!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.--> |
| <script>$("li.active").parents('li').toggleClass("active");</script> |
| |
| </div> |
| |
| |
| |
| |
| <!-- Content Column --> |
| <div class="col-md-9" id="tg-sb-content"> |
| <div class="post-header"> |
| <h1 class="post-title-main">Handling Projects in Server and Client Side Plugins</h1> |
| </div> |
| |
| |
| |
| <div class="post-content"> |
| |
| |
| |
| |
| |
| <!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. --> |
| <script> |
| $( document ).ready(function() { |
| // Handler for .ready() called. |
| $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2' }); |
| /* this offset helps account for the space taken up by the floating toolbar. */ |
| $('#toc').on('click', 'a', function() { |
| var target = $(this.getAttribute('href')) |
| , scroll_target = target.offset().top |
| $(window).scrollTop(scroll_target - 10); |
| return false |
| }) |
| |
| }); |
| </script> |
| |
| <div id="toc"></div> |
| |
| |
| |
| |
| <!-- |
| |
| |
| --> |
| |
| <div class="sect1"> |
| <h2 id="overview">Overview</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>In Che there is a bunch of project operations that can be performed via REST, JSON-RPC or programmatically (on server side). Most valuable will be covered by this chapter.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="project-import">Project import</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>In is possible to import a project using several ways, Che supports project import via REST, JSON-RPC and ProjectManager, those will be described further with examples.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="using-rest-to-import-a-project">Using REST to import a project</h3> |
| <div class="paragraph"> |
| <p>Most popular way of project import for clients is using corresponding REST service <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/ProjectService.java"><code>org.eclipse.che.api.project.server.ProjectService</code></a>. It has quite extensive API, so please check the service to have complete understanding of it’s capabilities. In Eclipse Che IDE there is already implemented <a href="https://github.com/eclipse/che/blob/master/ide/che-core-ide-app/src/main/java/org/eclipse/che/ide/project/ProjectServiceClient.java"><code>org.eclipse.che.ide.project.ProjectServiceClient</code></a> that we can use in order to communicate with project service. Most basic use case is:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="java">Path path = Path.valueOf(<span class="string"><span class="delimiter">"</span><span class="content">/DemoProject</span><span class="delimiter">"</span></span>); |
| |
| <span class="predefined-type">String</span> location = <span class="string"><span class="delimiter">"</span><span class="content">location</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">String</span> storage = <span class="string"><span class="delimiter">"</span><span class="content">git</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">Map</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>> parameters = <span class="keyword">new</span> <span class="predefined-type">HashMap</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>>() { |
| { |
| put(<span class="string"><span class="delimiter">"</span><span class="content">branch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">master</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">commitId</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">123456</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepVcs</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">true</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">fetch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">12345</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepDir</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">/src</span><span class="delimiter">"</span></span>); |
| } |
| } |
| |
| SourceStorageDto sourceStorage = dtoFactory.createDto(SourceStorageDto.class); |
| sourceStorage.setLocation(location); |
| sourceStorage.setStorage(git); |
| sourceStorage.setParameters(); |
| |
| projectServiceClient.importProject(path, sourceStorage) |
| .then((ignored)->{});</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Where:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>path</code></strong> - project path in workspace file system</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>sourceStorage</code></strong> - source storage metadata container</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>location</code></strong> - project location in a storage (can be URL, or any other storage dependent location descriptor)</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>storage</code></strong> - storage identifier, in our example it is "git"</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>parameters</code></strong> - storage related parameters</p> |
| </div> |
| <div class="paragraph"> |
| <p>Example can be found <a href="https://github.com/eclipse/che/blob/master/ide/che-core-ide-app/src/main/java/org/eclipse/che/ide/resources/impl/ResourceManager.java#L497">here</a></p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="using-json-rpc-to-import-a-project">Using JSON-RPC to import a project</h3> |
| <div class="paragraph"> |
| <p>Another approach is to use JSON-RPC calls instead of REST, that may be more convenient for JSON-RPC based clients. JSON-RPC service is represented by a range of JSON-RPC method handlers that are all configured within <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/ProjectJsonRpcServiceConfigurator.java"><code>org.eclipse.che.api.project.server.ProjectJsonRpcServiceConfigurator</code></a> class and utilize JSON-RPC protocol Eclipse Che implementation. In order to import a project we must call <code>"project/import"</code> method, that has <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project-shared/src/main/java/org/eclipse/che/api/project/shared/dto/service/ImportRequestDto.java"><code>org.eclipse.che.api.project.shared.dto.service.ImportRequestDto</code></a> as request params and <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project-shared/src/main/java/org/eclipse/che/api/project/shared/dto/service/ImportResponseDto.java"><code>org.eclipse.che.api.project.shared.dto.service.ImportResponseDto</code></a> as a result. Inside those DTOs you will need to configure <a href="https://github.com/eclipse/che/blob/master/core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/config/SourceStorage.java"><code>org.eclipse.che.api.core.model.workspace.config.SourceStorage</code></a> in order to start import procedure and will receive <a href="https://github.com/eclipse/che/blob/master/core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/config/ProjectConfig.java"><code>org.eclipse.che.api.core.model.workspace.config.ProjectConfig</code></a> after import is finished. Most basic example is:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> projectWsPath = <span class="string"><span class="delimiter">"</span><span class="content">/DemoProject</span><span class="delimiter">"</span></span> |
| |
| <span class="predefined-type">String</span> method = <span class="string"><span class="delimiter">"</span><span class="content">project/import</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">String</span> endpointId = <span class="string"><span class="delimiter">"</span><span class="content">ws-agent</span><span class="delimiter">"</span></span>; |
| |
| <span class="predefined-type">String</span> location = <span class="string"><span class="delimiter">"</span><span class="content">location</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">String</span> storage = <span class="string"><span class="delimiter">"</span><span class="content">git</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">Map</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>> parameters = <span class="keyword">new</span> <span class="predefined-type">HashMap</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>>() { |
| { |
| put(<span class="string"><span class="delimiter">"</span><span class="content">branch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">master</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">commitId</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">123456</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepVcs</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">true</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">fetch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">12345</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepDir</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">/src</span><span class="delimiter">"</span></span>); |
| } |
| } |
| |
| SourceStorageDto sourceStorage = dtoFactory.createDto(SourceStorageDto.class); |
| sourceStorage.setLocation(location); |
| sourceStorage.setStorage(git); |
| sourceStorage.setParameters(); |
| |
| |
| ImportRequestDto params = dtoFactory.createDto(ImportRequestDto.class); |
| params.setWsPath(projectWsPath); |
| params.setSourceStorage(sourceStorage); |
| |
| <span class="predefined-type">Class</span><?> resultClass = ImportResponseDto.class; |
| |
| requestTransmitter |
| .newRequest() |
| .endpointId(endpointId) |
| .methodName(method) |
| .paramsAsDto(params) |
| .sendAndReceiveResultAsDto(resultClass) |
| .onSuccess((importResponse) -> {}) |
| .onFailure((jsonRpcError) -> {});</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Where:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>method</code></strong> - JSON-RPC compliant method name that we want to call on server side, in our case it is <code>"project/import"</code></p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>endpointId</code></strong> - identifier of endpoint where we want to call our method, in our case it is <code>"ws-agent"</code></p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>projectWsPath</code></strong> - project path in workspace file system</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>resultClass</code></strong> - class of resulting dto</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>importResponse</code></strong> - import response DTO that contains business logic objects, in our case it contains imported project configuration</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="using-projectmanager-to-import-a-project">Using ProjectManager to import a project</h3> |
| <div class="paragraph"> |
| <p>On server side we can use <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/ProjectManager.java"><code>org.eclipse.che.api.project.server.ProjectManager</code></a> in order to perform project import operations. Most basic use case:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="java">BiConsumer<<span class="predefined-type">String</span>, <span class="predefined-type">String</span>> consumer = (s1, s2) -> {}; |
| |
| <span class="type">boolean</span> rewrite = <span class="predefined-constant">false</span>; |
| |
| <span class="predefined-type">String</span> projectWsPath = <span class="string"><span class="delimiter">"</span><span class="content">/DemoProject</span><span class="delimiter">"</span></span> |
| |
| <span class="predefined-type">String</span> location = <span class="string"><span class="delimiter">"</span><span class="content">location</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">String</span> storage = <span class="string"><span class="delimiter">"</span><span class="content">git</span><span class="delimiter">"</span></span>; |
| <span class="predefined-type">Map</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>> parameters = <span class="keyword">new</span> <span class="predefined-type">HashMap</span><<span class="predefined-type">String</span>, <span class="predefined-type">String</span>>() { |
| { |
| put(<span class="string"><span class="delimiter">"</span><span class="content">branch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">master</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">commitId</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">123456</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepVcs</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">true</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">fetch</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">12345</span><span class="delimiter">"</span></span>); |
| put(<span class="string"><span class="delimiter">"</span><span class="content">keepDir</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">/src</span><span class="delimiter">"</span></span>); |
| } |
| } |
| |
| SourceStorageDto sourceStorage = DtoFactory.newInstance().createDto(SourceStorageDto.class); |
| sourceStorage.setLocation(location); |
| sourceStorage.setStorage(git); |
| sourceStorage.setParameters(); |
| |
| projectManager.doImport(projectWsPath, sourceStorage, rewrite, consumer);</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Where:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>consumer</code></strong> - binary consumer that may accept project import progression reports as string lines and pass it further, e.g. it is used to track project import progression on clients</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong><code>rewrite</code></strong> - boolean parameter to indicate if an old project can be rewritten by new one during import</p> |
| </div> |
| <div class="paragraph"> |
| <p>Example can be found <a href="https://github.com/eclipse/che/blob/master/wsagent/che-core-api-project/src/main/java/org/eclipse/che/api/project/server/impl/SynchronizingProjectManager.java#L227">here</a></p> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="tags"> |
| |
| <b>Tags: </b> |
| |
| |
| |
| <a href="tag_extensions.html" class="btn btn-default navbar-btn cursorNorm" role="button">extensions</a> |
| |
| |
| |
| <a href="tag_dev-docs.html" class="btn btn-default navbar-btn cursorNorm" role="button">dev-docs</a> |
| |
| |
| |
| </div> |
| |
| <!-- |
| --> |
| |
| </div> |
| |
| <hr class="shaded"/> |
| |
| <footer> |
| <div class="row"> |
| <div class="col-lg-12 footer"> |
| Eclipse Che - Documentation <br/> |
| Site last generated: Sep 13, 2018 <br/> |
| <hr> |
| <a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a><br/> |
| <a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a><br/> |
| <a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a><br/> |
| <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a><br/> |
| <a href="http://www.eclipse.org/legal" target="_blank">Legal Resources</a><br/> |
| </div> |
| </div> |
| </footer> |
| |
| |
| |
| |
| <!-- /.row --> |
| </div> |
| <!-- /.container --> |
| </div> |
| <!-- /#main --> |
| </div> |
| |
| </body> |
| |
| </html> |
