winery/org.eclipse.winery.topologymodeler/README.md

   1 # Winery Topoloy Modeler
   2
   3 This is the topology modeler component of Winery.
   4
   5 ## Installation
   6
   7 See [README.md of Winery](../README.md).
   8
   9 ## Implementation hints
  10
  11 * use `div.NodeTemplateShape` as selector for node templates
  12
  13 ## About the Code
  14
  15 This code is in a prototypcial status. These are the main issues:
  16 * Instead of using EL, it directly uses Java code in the JSPs.
  17 * Instead of including the libraries using AMD, they are directly included via `script` tags.
  18 * Instead of using [AngularJS] (or a similar framework), we manually do the life update from the properties section to the node
  19 * Saving generates the XML manually (in index.jsp:save()). Therefore the extensibility of TOSCA is not supported here.
  20 * We depend on both bootstrap and jquery UI as jsPlumb does not support a bootstrap binding.
  21
  22 ### Trouble shooting
  23 When the topology modeler does not fully load (i.e., a white background is still there), look at the TOMCAT log file (of the repository).
  24 You'll see something like `TOSCA component id class org.eclipse.winery.common.ids.definitions.NodeTypeId / {http://www.example.org/tosca/nodetypes}VirtualMachine not found`.
  25 This is in indicator that you manually edited a `.definitions` file and did not change the location in the repository.
  26 The directory structure and the namespace and id/name settings in the `.definitions` file have to be in sync.
  27 As quick solution, you can open the type, switch to the XML tab and press "Save".
  28 Then, the namespace and id/name setting in the `.definitions` is changed according to the storage.
  29
  30 ## License
  31 Copyright (c) 2012-2014 University of Stuttgart.
  32
  33 All rights reserved. This program and the accompanying materials
  34 are made available under the terms of the [Eclipse Public License v1.0]
  35 and the [Apache License v2.0] which both accompany this distribution,
  36 and are available at http://www.eclipse.org/legal/epl-v10.html
  37 and http://www.apache.org/licenses/LICENSE-2.0
  38
  39 Contributors:
  40 * Oliver Kopp - initial API and implementation
  41
  42  [AngularJS]: http://angularjs.org/
  43  [Apache License v2.0]: http://www.apache.org/licenses/LICENSE-2.0.html
  44  [Eclipse Public License v1.0]: http://www.eclipse.org/legal/epl-v10.html