├── archetypes ├── uuf.app.creator │ ├── src │ │ ├── test │ │ │ └── resources │ │ │ │ └── projects │ │ │ │ └── basic │ │ │ │ ├── goal.txt │ │ │ │ └── archetype.properties │ │ └── main │ │ │ └── resources │ │ │ ├── archetype-resources │ │ │ ├── docs │ │ │ │ └── ReadMe.txt │ │ │ ├── resource.xml │ │ │ └── pom.xml │ │ │ └── META-INF │ │ │ └── maven │ │ │ └── archetype-metadata.xml │ └── pom.xml ├── uuf.unit.creator │ ├── src │ │ ├── test │ │ │ └── resources │ │ │ │ └── projects │ │ │ │ └── basic │ │ │ │ ├── goal.txt │ │ │ │ └── archetype.properties │ │ └── main │ │ │ └── resources │ │ │ ├── archetype-resources │ │ │ ├── unit_name.hbs │ │ │ ├── unit_name.json │ │ │ ├── unit_name.js │ │ │ ├── docs │ │ │ │ └── ReadMe.txt │ │ │ ├── resource.xml │ │ │ └── pom.xml │ │ │ └── META-INF │ │ │ └── maven │ │ │ └── archetype-metadata.xml │ └── pom.xml ├── uuf.multiple.unit.container │ ├── src │ │ ├── test │ │ │ └── resources │ │ │ │ └── projects │ │ │ │ └── basic │ │ │ │ ├── goal.txt │ │ │ │ └── archetype.properties │ │ └── main │ │ │ └── resources │ │ │ ├── archetype-resources │ │ │ ├── resource.xml │ │ │ └── pom.xml │ │ │ └── META-INF │ │ │ └── maven │ │ │ └── archetype-metadata.xml │ └── pom.xml └── pom.xml ├── sample-app └── pom.xml ├── pom.xml ├── .gitignore ├── README.md └── LICENSE /archetypes/uuf.app.creator/src/test/resources/projects/basic/goal.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/test/resources/projects/basic/goal.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/src/test/resources/projects/basic/goal.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/unit_name.hbs: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/unit_name.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "1.0.0" 3 | } -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/unit_name.js: -------------------------------------------------------------------------------- 1 | function onRequest(context) { 2 | 3 | } -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/docs/ReadMe.txt: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | Sample ReadMe text -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/src/test/resources/projects/basic/archetype.properties: -------------------------------------------------------------------------------- 1 | #Thu Sep 17 12:33:23 IST 2015 2 | package=it.pkg 3 | version=0.1-SNAPSHOT 4 | groupId=archetype.it 5 | artifactId=basic 6 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/test/resources/projects/basic/archetype.properties: -------------------------------------------------------------------------------- 1 | #Tue Sep 15 12:55:19 IST 2015 2 | package=it.pkg 3 | version=0.1-SNAPSHOT 4 | groupId=archetype.it 5 | artifactId=basic 6 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/src/test/resources/projects/basic/archetype.properties: -------------------------------------------------------------------------------- 1 | #Thu Sep 17 09:46:02 IST 2015 2 | package=it.pkg 3 | version=0.1-SNAPSHOT 4 | groupId=archetype.it 5 | artifactId=basic 6 | -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/src/main/resources/archetype-resources/docs/ReadMe.txt: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | This is the readMe on how to use the application -------------------------------------------------------------------------------- /sample-app/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | uuf-maven-tools 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | 1.0-SNAPSHOT 9 | 10 | 4.0.0 11 | 12 | uuf-sample-app 13 | WSO2 Carbon UI- Sample App 14 | 15 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/src/main/resources/archetype-resources/resource.xml: -------------------------------------------------------------------------------- 1 | 2 | resources 3 | 4 | zip 5 | 6 | false 7 | 8 | 9 | 10 | units 11 | 12 | / 13 | 14 | 15 | **/pom.xml 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | uuf-maven-tools 9 | 1.0-SNAPSHOT 10 | WSO2 Carbon UI - UUF Maven Tools 11 | 12 | 13 | sample-app 14 | archetypes 15 | 16 | pom 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /archetypes/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | uuf-maven-tools 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | 1.0-SNAPSHOT 9 | 10 | 11 | 4.0.0 12 | uuf-maven-archetypes 13 | WSO2 Carbon UI - UUF Archetypes 14 | 15 | 16 | uuf.multiple.unit.container 17 | uuf.app.creator 18 | uuf.unit.creator 19 | 20 | pom 21 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/resource.xml: -------------------------------------------------------------------------------- 1 | 2 | resources 3 | 4 | zip 5 | 6 | 7 | 8 | 9 | 10 | 11 | / 12 | 13 | 14 | pom.xml 15 | *.iml 16 | *.jar 17 | **/src/** 18 | **/target/** 19 | resource.xml 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | / 8 | 9 | resource.xml 10 | 11 | 12 | **/.idea/** 13 | *.iml 14 | 15 | 16 | 17 | units 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | uuf-maven-archetypes 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | 1.0-SNAPSHOT 9 | 10 | 4.0.0 11 | uuf-app-creator 12 | maven-archetype 13 | WSO2 Carbon UI - UUF App Creator Archetype 14 | 15 | 16 | 17 | 18 | org.apache.maven.archetype 19 | archetype-packaging 20 | 2.4 21 | 22 | 23 | 24 | 25 | 26 | maven-archetype-plugin 27 | 2.4 28 | 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/src/main/resources/archetype-resources/resource.xml: -------------------------------------------------------------------------------- 1 | 2 | resources 3 | 4 | zip 5 | 6 | false 7 | 8 | 9 | 10 | / 11 | 12 | 13 | pom.xml 14 | *.iml 15 | **/src/** 16 | **/target/** 17 | resource.xml 18 | **/layouts/** 19 | **/pages/** 20 | **/units/** 21 | 22 | 23 | 24 | 25 | app 26 | 27 | 28 | **/layouts/** 29 | **/pages/** 30 | **/units/** 31 | 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | uuf-maven-archetypes 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | 1.0-SNAPSHOT 9 | 10 | 11 | 4.0.0 12 | 13 | uuf-unit-creator 14 | maven-archetype 15 | WSO2 Carbon UI - UUF Unit Creator Archetype 16 | 17 | 18 | 19 | 20 | org.apache.maven.archetype 21 | archetype-packaging 22 | 2.4 23 | 24 | 25 | 26 | 27 | 28 | 29 | maven-archetype-plugin 30 | 2.4 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | uuf-maven-archetypes 7 | org.wso2.carbon.ui.uuf.maven.tools 8 | 1.0-SNAPSHOT 9 | 10 | 4.0.0 11 | 12 | uuf-multiple-unit-container 13 | maven-archetype 14 | WSO2 Carbon UI - UUF Multiple Unit Container Archetype 15 | 16 | 17 | 18 | org.apache.maven.archetype 19 | archetype-packaging 20 | 2.4 21 | 22 | 23 | 24 | 25 | 26 | maven-archetype-plugin 27 | 2.4 28 | 29 | 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | docs 8 | 9 | **/*.txt 10 | 11 | 12 | 13 | 14 | 15 | resource.xml 16 | 17 | 18 | *.iml 19 | .idea 20 | 21 | 22 | 23 | units 24 | 25 | 26 | pages 27 | 28 | 29 | layouts 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /archetypes/uuf.multiple.unit.container/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | ${groupId} 5 | ${artifactId} 6 | ${version} 7 | pom 8 | ${artifactId} 9 | 10 | 11 | 12 | 13 | org.apache.maven.plugins 14 | maven-assembly-plugin 15 | 16 | 17 | pack 18 | 19 | single 20 | 21 | package 22 | 23 | 24 | resource.xml 25 | 26 | ${project.artifactId} 27 | false 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | docs 9 | 10 | **/*.txt 11 | 12 | 13 | 14 | 15 | 16 | *.iml 17 | **/.idea/** 18 | 19 | 20 | resource.xml 21 | .gitignore 22 | unit_name.js 23 | unit_name.json 24 | unit_name.hbs 25 | 26 | 27 | 28 | public/less 29 | 30 | 31 | public/css 32 | 33 | 34 | public/js 35 | 36 | 37 | public/img 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ################# 2 | ## Java 3 | ################# 4 | *.class 5 | 6 | # Package files 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | 12 | ################# 13 | ## Eclipse 14 | ################# 15 | *.pydevproject 16 | .metadata 17 | .gradle 18 | bin/ 19 | tmp/ 20 | *.tmp 21 | *.bak 22 | *.swp 23 | *~.nib 24 | local.properties 25 | .settings/ 26 | .loadpath 27 | 28 | # Eclipse Core 29 | .project 30 | 31 | # External tool builders 32 | .externalToolBuilders/ 33 | 34 | # Locally stored "Eclipse launch configurations" 35 | *.launch 36 | 37 | # CDT-specific 38 | .cproject 39 | 40 | # JDT-specific (Eclipse Java Development Tools) 41 | .classpath 42 | 43 | # Java annotation processor (APT) 44 | .factorypath 45 | 46 | # PDT-specific 47 | .buildpath 48 | 49 | # sbteclipse plugin 50 | .target 51 | 52 | # TeXlipse plugin 53 | .texlipse 54 | 55 | 56 | ################# 57 | ## JetBrains IDEs 58 | ## IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio 59 | ################# 60 | *.iml 61 | 62 | ## Directory-based project format: 63 | .idea/ 64 | # if you remove the above rule, at least ignore the following: 65 | 66 | # User-specific stuff: 67 | # .idea/workspace.xml 68 | # .idea/tasks.xml 69 | # .idea/dictionaries 70 | 71 | # Sensitive or high-churn files: 72 | # .idea/dataSources.ids 73 | # .idea/dataSources.xml 74 | # .idea/sqlDataSources.xml 75 | # .idea/dynamic.xml 76 | # .idea/uiDesigner.xml 77 | 78 | # Gradle: 79 | # .idea/gradle.xml 80 | # .idea/libraries 81 | 82 | # Mongo Explorer plugin: 83 | # .idea/mongoSettings.xml 84 | 85 | ## File-based project format: 86 | *.ipr 87 | *.iws 88 | 89 | ## Plugin-specific files: 90 | 91 | # IntelliJ 92 | /out/ 93 | 94 | # mpeltonen/sbt-idea plugin 95 | .idea_modules/ 96 | 97 | # JIRA plugin 98 | atlassian-ide-plugin.xml 99 | 100 | # Crashlytics plugin (for Android Studio and IntelliJ) 101 | com_crashlytics_export_strings.xml 102 | crashlytics.properties 103 | crashlytics-build.properties 104 | 105 | 106 | ################# 107 | ## NetBeans 108 | ################# 109 | nbproject/private/ 110 | build/ 111 | nbbuild/ 112 | dist/ 113 | nbdist/ 114 | nbactions.xml 115 | nb-configuration.xml 116 | .nb-gradle/ 117 | 118 | 119 | ################# 120 | ## Linux 121 | ################# 122 | *~ 123 | 124 | # KDE directory preferences 125 | .directory 126 | 127 | # Linux trash folder which might appear on any partition or disk 128 | .Trash-* 129 | 130 | 131 | ################# 132 | ## OSX 133 | ################# 134 | .DS_Store 135 | .AppleDouble 136 | .LSOverride 137 | 138 | # Icon must end with two \r 139 | Icon 140 | 141 | 142 | # Thumbnails 143 | ._* 144 | 145 | # Files that might appear in the root of a volume 146 | .DocumentRevisions-V100 147 | .fseventsd 148 | .Spotlight-V100 149 | .TemporaryItems 150 | .Trashes 151 | .VolumeIcon.icns 152 | 153 | # Directories potentially created on remote AFP share 154 | .AppleDB 155 | .AppleDesktop 156 | Network Trash Folder 157 | Temporary Items 158 | .apdisk 159 | 160 | ################# 161 | ## Windows 162 | ################# 163 | # Windows image file caches 164 | Thumbs.db 165 | ehthumbs.db 166 | 167 | # Folder config file 168 | Desktop.ini 169 | 170 | # Recycle Bin used on file shares 171 | $RECYCLE.BIN/ 172 | 173 | # Windows Installer files 174 | *.cab 175 | *.msi 176 | *.msm 177 | *.msp 178 | 179 | # Windows shortcuts 180 | *.lnk 181 | -------------------------------------------------------------------------------- /archetypes/uuf.unit.creator/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | ${groupId} 6 | ${artifactId} 7 | ${version} 8 | pom 9 | ${artifactId} 10 | 11 | 12 | 13 | 14 | 15 | org.apache.maven.plugins 16 | maven-assembly-plugin 17 | 18 | 19 | pack 20 | 21 | single 22 | 23 | package 24 | 25 | 26 | resource.xml 27 | 28 | ${project.artifactId} 29 | false 30 | 31 | 32 | 33 | 34 | 35 | 36 | com.coderplus.maven.plugins 37 | copy-rename-maven-plugin 38 | 39 | 40 | rename-file 41 | compile 42 | 43 | rename 44 | 45 | 46 | 47 | 48 | ${project.basedir}/unit_name.hbs 49 | ${project.basedir}/${project.artifactId}.hbs 50 | 51 | 52 | ${project.basedir}/unit_name.json 53 | ${project.basedir}/${project.artifactId}.json 54 | 55 | 56 | ${project.basedir}/unit_name.js 57 | ${project.basedir}/${project.artifactId}.JS 58 | 59 | 60 | ${project.basedir}/unit_name.hbs 61 | ${project.basedir}/${project.artifactId}.hbs 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /archetypes/uuf.app.creator/src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | ${groupId} 6 | ${artifactId} 7 | ${version} 8 | ${artifactId} 9 | pom 10 | 11 | 12 | 13 | 14 | 15 | org.apache.maven.plugins 16 | maven-assembly-plugin 17 | 18 | 19 | pack 20 | 21 | single 22 | 23 | package 24 | 25 | 26 | resource.xml 27 | 28 | ${project.artifactId} 29 | false 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | org.apache.maven.plugins 38 | maven-dependency-plugin 39 | 2.10 40 | 41 | 42 | copy 43 | process-resources 44 | 45 | unpack 46 | 47 | 48 | 49 | 50 | carbon.uuf 51 | carbon-uuf 52 | 1.0-SNAPSHOT 53 | zip 54 | false 55 | ${project.basedir} 56 | 57 | 58 | ${project.basedir} 59 | false 60 | true 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | maven-antrun-plugin 69 | 70 | 71 | generate-sources 72 | compile 73 | 74 | 75 | 76 | 77 | 78 | 79 | run 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # uuf-maven-tools 2 | 3 | This repository contains three main modules. 4 | 5 | 1. uuf.unit.creator - contains the archetype of unit component 6 | 2. uuf.app.creator- contains the archetype of app component 7 | 3. uuf.multiple.unit.container - contains the archetype of multiple unit skeleton 8 | 9 | ## Prerequisites : 10 | 11 | Apache maven `https://maven.apache.org/install.html` 12 | 13 | ## How to install archetypes 14 | 15 | 1. Clone this repository. git clone `https://github.com/wso2-incubator/uuf-maven-tools.git` 16 | 17 | 2. Build the project with `maven install` to install the archetypes to the local machine. 18 | 19 | The details of the archetypes installed are as follows. 20 | 21 | 22 | #### unit.creator 23 | group-id : org.wso2.carbon.ui.uuf.maven.tools 24 | 25 | artifact-id : uuf-unit-creator 26 | 27 | #### app.creator 28 | group-id : org.wso2.carbon.ui.uuf.maven.tools 29 | 30 | artifact-id : uuf-app-creator 31 | 32 | #### multiple.unit.container 33 | group-id : org.wso2.carbon.ui.uuf.maven.tools 34 | 35 | artifact-id : uuf-multiple-unit-container 36 | 37 | 38 | ## How to create a unit 39 | 40 | Go to the directory that you want to create the unit and type the following command. 41 | 42 | mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=org.wso2.carbon.ui.uuf.maven.tools -DarchetypeArtifactId=uuf-unit-creator -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=org.wso2.carbon.ui.uuf.. -DartifactId= -DinteractiveMode=false 43 | 44 | 45 | This will create a project for the unit including a pom file in the directory you are in. Then open up the project using an IDE and modify the created unit as per your need. 46 | 47 | ## How to get unit zip 48 | 49 | After finishing the unit implementation build the module with `mvn clean install` 50 | 51 | It creates a zip file with the deployable unit in the target directory. 52 | 53 | ## How to get set of units as a zip 54 | 55 | To get a bundle of units as a single zip file use the `uuf.multiple.unit.container` which is installed as an archetype when the project build. 56 | 57 | Follow the same process of unit project to create a multiple unit container with following details. 58 | Archetype to select : 59 | 60 | mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=org.wso2.carbon.ui.uuf.maven.tools -DarchetypeArtifactId=uuf-multiple-unit-container -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=org.wso2.carbon.ui.uuf. -DartifactId= -DinteractiveMode=false 61 | 62 | This will create a container of units with a empty folder named `units` 63 | 64 | ## Adding units to the units container : 65 | 66 | 1. Go to the directory `units` inside the container project. 67 | 68 | 2. If you want to create a unit use the same way of unit creation being inside this folder. 69 | 70 | 3. After implementation of units is done build the project 71 | 72 | A zip file containing the set of deployable units is created in the target folder of the container when the 73 | project is build. 74 | 75 | 76 | ## How to Create an App : 77 | 78 | Go to the directory that you want to create the app and type the following command. 79 | 80 | mvn archetype:generate -DarchetypeCatalog=local -DarchetypeGroupId=org.wso2.carbon.ui.uuf.maven.tools -DarchetypeArtifactId=uuf-app-creator -DarchetypeVersion=1.0-SNAPSHOT -DgroupId=org.wso2.carbon.ui.uuf. -DartifactId= -DinteractiveMode=false 81 | 82 | This will create a project for the app including a pom file in the directory you are in. 83 | 84 | Then open up the project using an IDE and modify the created app as per your need by creating units inside the units directory as mentioned above or importing units into the app. 85 | 86 | ## How to get the deployable app : 87 | 88 | There are two types of dependencies which need to be added to the app. 89 | 90 | Those are : 91 | 92 | ### 1. Dependency of uuf-template-app 93 | 94 | To do this you have to first build the uuf-template-app. 95 | 96 | 1. Clone this repository. `git clone https://github.com/sajithar/carbin-uuf.git` to your machine. 97 | 98 | 2. Go to the root directory of the uuf-template-app and build it using `mvn clean install` 99 | 100 | This will add the dependencies of the uuf-template app to your local maven repository. 101 | 102 | 3. Again go to the app project that you created using the uuf.app.creator archetype and build the project with `mvn clean install` 103 | 104 | This will add the libraries and configurations from the uuf-template-app to the application project you created. 105 | 106 | ### 2. Dependencies of units which are imported. 107 | 108 | You can add units which are created by other users to your application 109 | 110 | -- This feature is under development -- 111 | 112 | 113 | After finishing the unit implementation build the project with `mvn clean install` 114 | 115 | It creates a zip file with the deployable app in the target directory which can be copied to 116 | `/repository/deployment/server/jaggeryapps/` directory of the WSO2 product to use. 117 | 118 | 119 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------