├── .jdk8 ├── spring-cloud-starter-stream-app-function ├── .jdk8 ├── src │ ├── test │ │ ├── resources │ │ │ ├── README │ │ │ └── function-sample-1.0.0.BUILD-SNAPSHOT.jar │ │ ├── support │ │ │ ├── src │ │ │ │ └── main │ │ │ │ │ └── java │ │ │ │ │ └── com │ │ │ │ │ └── example │ │ │ │ │ └── functions │ │ │ │ │ ├── DoubleLogger.java │ │ │ │ │ ├── LengthCounter.java │ │ │ │ │ └── Emitter.java │ │ │ └── pom.xml │ │ └── java │ │ │ └── org │ │ │ └── springframework │ │ │ └── cloud │ │ │ └── stream │ │ │ └── app │ │ │ └── function │ │ │ └── app │ │ │ └── FunctionAppConfigurationTests.java │ └── main │ │ ├── resources │ │ └── META-INF │ │ │ └── spring-configuration-metadata-whitelist.properties │ │ └── java │ │ └── org │ │ └── springframework │ │ └── cloud │ │ └── stream │ │ └── app │ │ └── function │ │ └── app │ │ ├── FunctionProperties.java │ │ └── FunctionAppConfiguration.java ├── README.adoc └── pom.xml ├── README.md ├── .mvn ├── jvm.config ├── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties └── maven.config ├── README.adoc ├── .gitignore ├── CODE_OF_CONDUCT.adoc ├── pom.xml ├── function-app-dependencies └── pom.xml ├── mvnw.cmd ├── mvnw └── LICENSE /.jdk8: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/.jdk8: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # function is no longer actively maintained by VMware, Inc. 2 | 3 | -------------------------------------------------------------------------------- /.mvn/jvm.config: -------------------------------------------------------------------------------- 1 | -Xmx1024m -XX:CICompilerCount=1 -XX:TieredStopAtLevel=1 -Djava.security.egd=file:/dev/./urandom -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/spring-attic/function/main/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/maven.config: -------------------------------------------------------------------------------- 1 | -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local -P spring 2 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.3.3/apache-maven-3.3.3-bin.zip -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/resources/README: -------------------------------------------------------------------------------- 1 | The jar file found in this directory has been built using the maven project found in src/test/support. 2 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/main/resources/META-INF/spring-configuration-metadata-whitelist.properties: -------------------------------------------------------------------------------- 1 | configuration-properties.classes=org.springframework.cloud.stream.app.function.app.FunctionProperties 2 | 3 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/resources/function-sample-1.0.0.BUILD-SNAPSHOT.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/spring-attic/function/main/spring-cloud-starter-stream-app-function/src/test/resources/function-sample-1.0.0.BUILD-SNAPSHOT.jar -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = Spring Cloud Function versatile app 2 | 3 | Allows one to turn any plain jar containing a `Supplier`, `Function` or `Consumer` 4 | into a Spring Cloud Stream `Source`, `Processor` or `Sink` respectively. 5 | 6 | To learn more about this application and the supported properties, please 7 | review link:spring-cloud-starter-stream-app-function/README.adoc[this file]. 8 | 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | apps/ 2 | /application.yml 3 | /application.properties 4 | asciidoctor.css 5 | *~ 6 | .#* 7 | *# 8 | target/ 9 | build/ 10 | bin/ 11 | _site/ 12 | .classpath 13 | .project 14 | .settings 15 | .springBeans 16 | .DS_Store 17 | *.sw* 18 | *.iml 19 | *.ipr 20 | *.iws 21 | .idea/ 22 | .factorypath 23 | spring-xd-samples/*/xd 24 | dump.rdb 25 | coverage-error.log 26 | .apt_generated 27 | aws.credentials.properties 28 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/support/src/main/java/com/example/functions/DoubleLogger.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.example.functions; 18 | 19 | import java.util.function.Consumer; 20 | 21 | public class DoubleLogger implements Consumer { 22 | 23 | @Override 24 | public void accept(Integer i) { 25 | System.out.println(2 * i); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/support/src/main/java/com/example/functions/LengthCounter.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.example.functions; 18 | 19 | import java.util.function.Function; 20 | 21 | /** 22 | * @author Eric Bottard 23 | */ 24 | public class LengthCounter implements Function { 25 | 26 | @Override 27 | public Integer apply(String string) { 28 | return string.length(); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/support/src/main/java/com/example/functions/Emitter.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.example.functions; 18 | 19 | import java.util.function.Supplier; 20 | 21 | /** 22 | * @author Eric Bottard 23 | */ 24 | public class Emitter implements Supplier { 25 | 26 | private int i = 0; 27 | 28 | private String[] values = {"one", "two", "three", "four"}; 29 | 30 | @Override 31 | public String get() { 32 | return values[i++ % values.length]; 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/main/java/org/springframework/cloud/stream/app/function/app/FunctionProperties.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package org.springframework.cloud.stream.app.function.app; 18 | 19 | import javax.validation.constraints.Size; 20 | 21 | import org.hibernate.validator.constraints.NotBlank; 22 | 23 | /** 24 | * Configuration properties for deciding how to locate the functional class to execute. 25 | * 26 | * @author Eric Bottard 27 | */ 28 | public class FunctionProperties { 29 | 30 | /** 31 | * Location(s) of jar archives containing the supplier/function/consumer class to run. 32 | */ 33 | @Size(min = 1) 34 | private String[] location; 35 | 36 | /** 37 | * The fully qualified class name of the supplier/function/consumer to run. 38 | */ 39 | @NotBlank 40 | private String className; 41 | 42 | public String getClassName() { 43 | return className; 44 | } 45 | 46 | public void setClassName(String className) { 47 | this.className = className; 48 | } 49 | 50 | public String[] getLocation() { 51 | return location; 52 | } 53 | 54 | public void setLocation(String[] location) { 55 | this.location = location; 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/README.adoc: -------------------------------------------------------------------------------- 1 | //tag::ref-doc[] 2 | = Spring Cloud Function Bridge 3 | 4 | This application can be used to turn any plain jar containing a `Supplier`, `Function` or `Consumer` 5 | into a Spring Cloud Stream `Source`, `Processor` or `Sink` respectively. 6 | 7 | == Input 8 | 9 | Depends on the actual concrete type of the functional class used at runtime. 10 | 11 | == Output 12 | 13 | Depends on the actual concrete type of the functional class used at runtime. 14 | 15 | == Options 16 | 17 | The **$$function-app$$** application has the following options: 18 | 19 | //tag::configuration-properties[] 20 | $$function.class-name$$:: $$The fully qualified class name of the supplier/function/consumer to run.$$ *($$String$$, default: `$$$$`)* 21 | $$function.location$$:: $$Location(s) of jar archives containing the supplier/function/consumer class to run.$$ *($$String[]$$, default: `$$$$`)* 22 | //end::configuration-properties[] 23 | 24 | //end::ref-doc[] 25 | 26 | == Build 27 | 28 | ``` 29 | $ ./mvnw clean install -PgenerateApps 30 | $ cd apps 31 | 32 | You can find the corresponding binder based projects here. You can then cd into one one of the folders and build it: 33 | 34 | $ ./mvnw clean package 35 | ``` 36 | 37 | == Examples 38 | 39 | Assuming `length-counter.jar` contains the following class 40 | ``` 41 | package com.example.functions; 42 | 43 | import java.util.function.Function; 44 | 45 | public class LengthCounter implements Function { 46 | 47 | @Override 48 | public Integer apply(String string) { 49 | return string.length(); 50 | } 51 | } 52 | 53 | ``` 54 | 55 | Then you can turn it into a processor like so: 56 | ``` 57 | java -jar function-app.jar --function.location=file:length-counter.jar --function.className=com.example.functions.LengthCounter 58 | ``` 59 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | spring-cloud-starter-stream-app-function 7 | jar 8 | Spring Cloud Stream function app core 9 | 10 | 11 | org.springframework.cloud.stream.app 12 | funtion-app-starters-build 13 | 1.0.0.BUILD-SNAPSHOT 14 | 15 | 16 | 17 | 18 | org.springframework.cloud 19 | spring-cloud-function-stream 20 | compile 21 | 22 | 23 | io.projectreactor 24 | reactor-core 25 | 26 | 27 | org.springframework.cloud 28 | spring-cloud-deployer-resource-maven 29 | 30 | 31 | org.springframework.cloud 32 | spring-cloud-deployer-resource-support 33 | 34 | 35 | 36 | 37 | 38 | 39 | org.springframework.cloud 40 | spring-cloud-app-starter-doc-maven-plugin 41 | 42 | 43 | org.springframework.cloud.stream.app.plugin 44 | spring-cloud-stream-app-maven-plugin 45 | 46 | ${session.executionRootDirectory}/apps 47 | ${project.version} 48 | 49 | 50 | 51 | 52 | scs-bom 53 | org.springframework.cloud.stream.app 54 | function-app-dependencies 55 | ${project.version} 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.adoc: -------------------------------------------------------------------------------- 1 | = Contributor Code of Conduct 2 | 3 | As contributors and maintainers of this project, and in the interest of fostering an open 4 | and welcoming community, we pledge to respect all people who contribute through reporting 5 | issues, posting feature requests, updating documentation, submitting pull requests or 6 | patches, and other activities. 7 | 8 | We are committed to making participation in this project a harassment-free experience for 9 | everyone, regardless of level of experience, gender, gender identity and expression, 10 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age, 11 | religion, or nationality. 12 | 13 | Examples of unacceptable behavior by participants include: 14 | 15 | * The use of sexualized language or imagery 16 | * Personal attacks 17 | * Trolling or insulting/derogatory comments 18 | * Public or private harassment 19 | * Publishing other's private information, such as physical or electronic addresses, 20 | without explicit permission 21 | * Other unethical or unprofessional conduct 22 | 23 | Project maintainers have the right and responsibility to remove, edit, or reject comments, 24 | commits, code, wiki edits, issues, and other contributions that are not aligned to this 25 | Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors 26 | that they deem inappropriate, threatening, offensive, or harmful. 27 | 28 | By adopting this Code of Conduct, project maintainers commit themselves to fairly and 29 | consistently applying these principles to every aspect of managing this project. Project 30 | maintainers who do not follow or enforce the Code of Conduct may be permanently removed 31 | from the project team. 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an 34 | individual is representing the project or its community. 35 | 36 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 37 | contacting a project maintainer at spring-code-of-conduct@pivotal.io . All complaints will 38 | be reviewed and investigated and will result in a response that is deemed necessary and 39 | appropriate to the circumstances. Maintainers are obligated to maintain confidentiality 40 | with regard to the reporter of an incident. 41 | 42 | This Code of Conduct is adapted from the 43 | https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at 44 | https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/] 45 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/support/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.example 7 | function-sample 8 | 1.0.0.M1 9 | jar 10 | 11 | 12 | 1.8 13 | 1.0.0.M1 14 | 1.0.5.RELEASE 15 | 3.2.0.M1 16 | 17 | 18 | 19 | 20 | spring-snapshots 21 | Spring Snapshots 22 | https://repo.spring.io/libs-snapshot-local 23 | 24 | true 25 | 26 | 27 | false 28 | 29 | 30 | 31 | spring-milestones 32 | Spring Milestones 33 | https://repo.spring.io/libs-milestone-local 34 | 35 | false 36 | 37 | 38 | 39 | spring-releases 40 | Spring Releases 41 | https://repo.spring.io/release 42 | 43 | false 44 | 45 | 46 | 47 | 48 | 49 | spring-snapshots 50 | Spring Snapshots 51 | https://repo.spring.io/libs-snapshot-local 52 | 53 | true 54 | 55 | 56 | false 57 | 58 | 59 | 60 | spring-milestones 61 | Spring Milestones 62 | https://repo.spring.io/libs-milestone-local 63 | 64 | false 65 | 66 | 67 | 68 | spring-releases 69 | Spring Releases 70 | https://repo.spring.io/libs-release-local 71 | 72 | false 73 | 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | funtion-app-starters-build 6 | 1.0.0.BUILD-SNAPSHOT 7 | pom 8 | 9 | 10 | org.springframework.cloud.stream.app 11 | app-starters-build 12 | 2.0.1.RELEASE 13 | 14 | 15 | 16 | 17 | 1.8 18 | 19 | 20 | 21 | spring-cloud-starter-stream-app-function 22 | function-app-dependencies 23 | 24 | 25 | 26 | 27 | 28 | org.springframework.cloud.stream.app 29 | function-app-dependencies 30 | 1.0.0.BUILD-SNAPSHOT 31 | pom 32 | import 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | spring 41 | 42 | 43 | spring-snapshots 44 | Spring Snapshots 45 | https://repo.spring.io/libs-snapshot-local 46 | 47 | true 48 | 49 | 50 | 51 | spring-milestones 52 | Spring Milestones 53 | https://repo.spring.io/libs-milestone-local 54 | 55 | false 56 | 57 | 58 | 59 | spring-releases 60 | Spring Releases 61 | https://repo.spring.io/release 62 | 63 | false 64 | 65 | 66 | 67 | spring-libs-release 68 | Spring Libs Release 69 | https://repo.spring.io/libs-release 70 | 71 | false 72 | 73 | 74 | 75 | 76 | false 77 | 78 | spring-milestone-release 79 | Spring Milestone Release 80 | https://repo.spring.io/libs-milestone 81 | 82 | 83 | 84 | 85 | spring-snapshots 86 | Spring Snapshots 87 | https://repo.spring.io/libs-snapshot-local 88 | 89 | true 90 | 91 | 92 | 93 | spring-milestones 94 | Spring Milestones 95 | https://repo.spring.io/libs-milestone-local 96 | 97 | false 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/test/java/org/springframework/cloud/stream/app/function/app/FunctionAppConfigurationTests.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package org.springframework.cloud.stream.app.function.app; 18 | 19 | import java.util.concurrent.TimeUnit; 20 | 21 | import org.hamcrest.Matchers; 22 | import org.junit.Test; 23 | import org.junit.runner.RunWith; 24 | 25 | import org.springframework.beans.factory.annotation.Autowired; 26 | import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 27 | import org.springframework.boot.test.context.SpringBootTest; 28 | import org.springframework.cloud.stream.messaging.Processor; 29 | import org.springframework.cloud.stream.messaging.Sink; 30 | import org.springframework.cloud.stream.messaging.Source; 31 | import org.springframework.cloud.stream.test.binder.MessageCollector; 32 | import org.springframework.messaging.Message; 33 | import org.springframework.messaging.support.MessageBuilder; 34 | import org.springframework.test.context.TestPropertySource; 35 | import org.springframework.test.context.junit4.SpringRunner; 36 | 37 | import static org.junit.Assert.assertThat; 38 | 39 | @RunWith(SpringRunner.class) 40 | @SpringBootTest(classes = FunctionAppConfiguration.class, webEnvironment = SpringBootTest.WebEnvironment.NONE) 41 | @TestPropertySource(properties = { 42 | "function.location=file:src/test/resources/function-sample-1.0.0.BUILD-SNAPSHOT.jar", 43 | }) 44 | public abstract class FunctionAppConfigurationTests { 45 | 46 | @Autowired 47 | protected MessageCollector messageCollector; 48 | 49 | 50 | @EnableAutoConfiguration 51 | @TestPropertySource(properties = { 52 | "function.className=com.example.functions.Emitter"}) 53 | public static class SourceTests extends FunctionAppConfigurationTests { 54 | 55 | @Autowired 56 | private Source source; 57 | 58 | @Test 59 | public void test() throws Exception { 60 | 61 | Message received = messageCollector.forChannel(source.output()).poll(2, TimeUnit.SECONDS); 62 | assertThat(received.getPayload(), Matchers.is("one")); 63 | 64 | } 65 | 66 | } 67 | 68 | @EnableAutoConfiguration 69 | @TestPropertySource(properties = { 70 | "function.className=com.example.functions.LengthCounter"}) 71 | public static class ProcessorTests extends FunctionAppConfigurationTests { 72 | 73 | @Autowired 74 | private Processor processor; 75 | 76 | @Test 77 | public void test() throws Exception { 78 | processor.input().send(MessageBuilder.withPayload("hello").build()); 79 | Message received = messageCollector.forChannel(processor.output()).poll(1, TimeUnit.SECONDS); 80 | assertThat(Integer.valueOf(received.getPayload().toString()), Matchers.is("hello".length())); 81 | 82 | } 83 | 84 | } 85 | 86 | @EnableAutoConfiguration 87 | @TestPropertySource(properties = { 88 | "function.className=com.example.functions.DoubleLogger"}) 89 | public static class SinkTests extends FunctionAppConfigurationTests { 90 | 91 | @Autowired 92 | private Sink sink; 93 | 94 | @Test 95 | public void test() throws Exception { 96 | // Can't assert side effects. 97 | sink.input().send(MessageBuilder.withPayload(5).build()); 98 | } 99 | 100 | } 101 | 102 | 103 | } -------------------------------------------------------------------------------- /function-app-dependencies/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | org.springframework.cloud.stream.app 6 | function-app-dependencies 7 | 1.0.0.BUILD-SNAPSHOT 8 | pom 9 | Spring Cloud Stream Function App Dependencies 10 | 11 | 12 | spring-cloud-dependencies-parent 13 | org.springframework.cloud 14 | 2.0.2.RELEASE 15 | 16 | 17 | 18 | 19 | 3.2.0.M2 20 | 1.0.0.RELEASE 21 | 1.3.3.RELEASE 22 | 23 | 24 | 25 | 26 | 27 | org.springframework.cloud.stream.app 28 | spring-cloud-starter-stream-app-function 29 | ${spring.cloud.function.version} 30 | 31 | 32 | 33 | org.springframework.cloud 34 | spring-cloud-function-stream 35 | ${spring.cloud.function.version} 36 | 37 | 38 | io.projectreactor 39 | reactor-core 40 | ${reactor.version} 41 | 42 | 43 | org.springframework.cloud 44 | spring-cloud-deployer-resource-maven 45 | ${spring.cloud.deployer.version} 46 | 47 | 48 | org.springframework.cloud 49 | spring-cloud-deployer-resource-support 50 | ${spring.cloud.deployer.version} 51 | 52 | 53 | 54 | 55 | 56 | 57 | spring 58 | 59 | 60 | spring-snapshots 61 | Spring Snapshots 62 | https://repo.spring.io/libs-snapshot-local 63 | 64 | true 65 | 66 | 67 | 68 | spring-milestones 69 | Spring Milestones 70 | https://repo.spring.io/libs-milestone-local 71 | 72 | false 73 | 74 | 75 | 76 | spring-releases 77 | Spring Releases 78 | https://repo.spring.io/release 79 | 80 | false 81 | 82 | 83 | 84 | spring-libs-release 85 | Spring Libs Release 86 | https://repo.spring.io/libs-release 87 | 88 | false 89 | 90 | 91 | 92 | 93 | false 94 | 95 | spring-milestone-release 96 | Spring Milestone Release 97 | https://repo.spring.io/libs-milestone 98 | 99 | 100 | 101 | 102 | spring-snapshots 103 | Spring Snapshots 104 | https://repo.spring.io/libs-snapshot-local 105 | 106 | true 107 | 108 | 109 | 110 | spring-milestones 111 | Spring Milestones 112 | https://repo.spring.io/libs-milestone-local 113 | 114 | false 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | -------------------------------------------------------------------------------- /spring-cloud-starter-stream-app-function/src/main/java/org/springframework/cloud/stream/app/function/app/FunctionAppConfiguration.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package org.springframework.cloud.stream.app.function.app; 18 | 19 | import java.io.IOException; 20 | import java.io.UncheckedIOException; 21 | import java.net.URL; 22 | import java.net.URLClassLoader; 23 | import java.util.Arrays; 24 | import java.util.Collections; 25 | import java.util.HashMap; 26 | import java.util.Map; 27 | import java.util.function.Function; 28 | 29 | import org.springframework.beans.BeanUtils; 30 | import org.springframework.beans.factory.annotation.Autowired; 31 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 32 | import org.springframework.boot.context.properties.ConfigurationProperties; 33 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 34 | import org.springframework.cloud.deployer.resource.maven.MavenProperties; 35 | import org.springframework.cloud.deployer.resource.maven.MavenResource; 36 | import org.springframework.cloud.deployer.resource.maven.MavenResourceLoader; 37 | import org.springframework.cloud.deployer.resource.support.DelegatingResourceLoader; 38 | import org.springframework.cloud.function.context.FunctionRegistration; 39 | import org.springframework.context.annotation.Bean; 40 | import org.springframework.context.annotation.Configuration; 41 | import org.springframework.core.io.ResourceLoader; 42 | 43 | /** 44 | * Registers beans that will be picked up by spring-cloud-function-context magic. 45 | * 46 | *

Resolves jar location provided by the user using a flexible ResourceLoader.

47 | * 48 | * @author Eric Bottard 49 | */ 50 | @Configuration 51 | @EnableConfigurationProperties 52 | public class FunctionAppConfiguration { 53 | 54 | @Autowired 55 | private DelegatingResourceLoader delegatingResourceLoader; 56 | 57 | @Autowired 58 | private FunctionProperties functionProperties; 59 | 60 | @Bean 61 | @ConfigurationProperties("maven") 62 | public MavenProperties mavenProperties() { 63 | return new MavenProperties(); 64 | } 65 | 66 | @Bean 67 | @ConfigurationProperties("function") 68 | public FunctionProperties functionProperties() { 69 | return new FunctionProperties(); 70 | } 71 | 72 | @Bean 73 | @ConditionalOnMissingBean(DelegatingResourceLoader.class) 74 | public DelegatingResourceLoader delegatingResourceLoader(MavenProperties mavenProperties) { 75 | Map loaders = new HashMap<>(); 76 | loaders.put(MavenResource.URI_SCHEME, new MavenResourceLoader(mavenProperties)); 77 | return new DelegatingResourceLoader(loaders); 78 | } 79 | 80 | @Bean 81 | public Map> registrations() throws Exception { 82 | URL[] urls = Arrays.stream(functionProperties.getLocation()) 83 | .map(toResourceURL()) 84 | .toArray(URL[]::new); 85 | 86 | try (URLClassLoader cl = new URLClassLoader(urls, this.getClass().getClassLoader())) { 87 | Object target = BeanUtils.instantiateClass(cl.loadClass(functionProperties.getClassName())); 88 | FunctionRegistration functionRegistration = new FunctionRegistration(target); 89 | return Collections.singletonMap("function-bean", functionRegistration); 90 | } 91 | } 92 | 93 | private Function toResourceURL() { 94 | return l -> { 95 | try { 96 | return delegatingResourceLoader.getResource(l).getFile().toURI().toURL(); 97 | } 98 | catch (IOException e) { 99 | throw new UncheckedIOException(e); 100 | } 101 | }; 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 39 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 40 | 41 | @REM set %HOME% to equivalent of $HOME 42 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 43 | 44 | @REM Execute a user defined script before this one 45 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 46 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 47 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 48 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 49 | :skipRcPre 50 | 51 | @setlocal 52 | 53 | set ERROR_CODE=0 54 | 55 | @REM To isolate internal variables from possible post scripts, we use another setlocal 56 | @setlocal 57 | 58 | @REM ==== START VALIDATION ==== 59 | if not "%JAVA_HOME%" == "" goto OkJHome 60 | 61 | echo. 62 | echo Error: JAVA_HOME not found in your environment. >&2 63 | echo Please set the JAVA_HOME variable in your environment to match the >&2 64 | echo location of your Java installation. >&2 65 | echo. 66 | goto error 67 | 68 | :OkJHome 69 | if exist "%JAVA_HOME%\bin\java.exe" goto init 70 | 71 | echo. 72 | echo Error: JAVA_HOME is set to an invalid directory. >&2 73 | echo JAVA_HOME = "%JAVA_HOME%" >&2 74 | echo Please set the JAVA_HOME variable in your environment to match the >&2 75 | echo location of your Java installation. >&2 76 | echo. 77 | goto error 78 | 79 | @REM ==== END VALIDATION ==== 80 | 81 | :init 82 | 83 | set MAVEN_CMD_LINE_ARGS=%* 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | 121 | set WRAPPER_JAR="".\.mvn\wrapper\maven-wrapper.jar"" 122 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 123 | 124 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CMD_LINE_ARGS% 125 | if ERRORLEVEL 1 goto error 126 | goto end 127 | 128 | :error 129 | set ERROR_CODE=1 130 | 131 | :end 132 | @endlocal & set ERROR_CODE=%ERROR_CODE% 133 | 134 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 135 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 136 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 137 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 138 | :skipRcPost 139 | 140 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 141 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 142 | 143 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 144 | 145 | exit /B %ERROR_CODE% 146 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # 58 | # Look for the Apple JDKs first to preserve the existing behaviour, and then look 59 | # for the new JDKs provided by Oracle. 60 | # 61 | if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK ] ; then 62 | # 63 | # Apple JDKs 64 | # 65 | export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home 66 | fi 67 | 68 | if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Java/JavaVirtualMachines/CurrentJDK ] ; then 69 | # 70 | # Apple JDKs 71 | # 72 | export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home 73 | fi 74 | 75 | if [ -z "$JAVA_HOME" ] && [ -L "/Library/Java/JavaVirtualMachines/CurrentJDK" ] ; then 76 | # 77 | # Oracle JDKs 78 | # 79 | export JAVA_HOME=/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home 80 | fi 81 | 82 | if [ -z "$JAVA_HOME" ] && [ -x "/usr/libexec/java_home" ]; then 83 | # 84 | # Apple JDKs 85 | # 86 | export JAVA_HOME=`/usr/libexec/java_home` 87 | fi 88 | ;; 89 | esac 90 | 91 | if [ -z "$JAVA_HOME" ] ; then 92 | if [ -r /etc/gentoo-release ] ; then 93 | JAVA_HOME=`java-config --jre-home` 94 | fi 95 | fi 96 | 97 | if [ -z "$M2_HOME" ] ; then 98 | ## resolve links - $0 may be a link to maven's home 99 | PRG="$0" 100 | 101 | # need this for relative symlinks 102 | while [ -h "$PRG" ] ; do 103 | ls=`ls -ld "$PRG"` 104 | link=`expr "$ls" : '.*-> \(.*\)$'` 105 | if expr "$link" : '/.*' > /dev/null; then 106 | PRG="$link" 107 | else 108 | PRG="`dirname "$PRG"`/$link" 109 | fi 110 | done 111 | 112 | saveddir=`pwd` 113 | 114 | M2_HOME=`dirname "$PRG"`/.. 115 | 116 | # make it fully qualified 117 | M2_HOME=`cd "$M2_HOME" && pwd` 118 | 119 | cd "$saveddir" 120 | # echo Using m2 at $M2_HOME 121 | fi 122 | 123 | # For Cygwin, ensure paths are in UNIX format before anything is touched 124 | if $cygwin ; then 125 | [ -n "$M2_HOME" ] && 126 | M2_HOME=`cygpath --unix "$M2_HOME"` 127 | [ -n "$JAVA_HOME" ] && 128 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 129 | [ -n "$CLASSPATH" ] && 130 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 131 | fi 132 | 133 | # For Migwn, ensure paths are in UNIX format before anything is touched 134 | if $mingw ; then 135 | [ -n "$M2_HOME" ] && 136 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 137 | [ -n "$JAVA_HOME" ] && 138 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 139 | # TODO classpath? 140 | fi 141 | 142 | if [ -z "$JAVA_HOME" ]; then 143 | javaExecutable="`which javac`" 144 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 145 | # readlink(1) is not available as standard on Solaris 10. 146 | readLink=`which readlink` 147 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 148 | if $darwin ; then 149 | javaHome="`dirname \"$javaExecutable\"`" 150 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 151 | else 152 | javaExecutable="`readlink -f \"$javaExecutable\"`" 153 | fi 154 | javaHome="`dirname \"$javaExecutable\"`" 155 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 156 | JAVA_HOME="$javaHome" 157 | export JAVA_HOME 158 | fi 159 | fi 160 | fi 161 | 162 | if [ -z "$JAVACMD" ] ; then 163 | if [ -n "$JAVA_HOME" ] ; then 164 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 165 | # IBM's JDK on AIX uses strange locations for the executables 166 | JAVACMD="$JAVA_HOME/jre/sh/java" 167 | else 168 | JAVACMD="$JAVA_HOME/bin/java" 169 | fi 170 | else 171 | JAVACMD="`which java`" 172 | fi 173 | fi 174 | 175 | if [ ! -x "$JAVACMD" ] ; then 176 | echo "Error: JAVA_HOME is not defined correctly." >&2 177 | echo " We cannot execute $JAVACMD" >&2 178 | exit 1 179 | fi 180 | 181 | if [ -z "$JAVA_HOME" ] ; then 182 | echo "Warning: JAVA_HOME environment variable is not set." 183 | fi 184 | 185 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 186 | 187 | # For Cygwin, switch paths to Windows format before running java 188 | if $cygwin; then 189 | [ -n "$M2_HOME" ] && 190 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 191 | [ -n "$JAVA_HOME" ] && 192 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 193 | [ -n "$CLASSPATH" ] && 194 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 195 | fi 196 | 197 | # traverses directory structure from process work directory to filesystem root 198 | # first directory with .mvn subdirectory is considered project base directory 199 | find_maven_basedir() { 200 | local basedir=$(pwd) 201 | local wdir=$(pwd) 202 | while [ "$wdir" != '/' ] ; do 203 | if [ -d "$wdir"/.mvn ] ; then 204 | basedir=$wdir 205 | break 206 | fi 207 | wdir=$(cd "$wdir/.."; pwd) 208 | done 209 | echo "${basedir}" 210 | } 211 | 212 | # concatenates all lines of a file 213 | concat_lines() { 214 | if [ -f "$1" ]; then 215 | echo "$(tr -s '\n' ' ' < "$1")" 216 | fi 217 | } 218 | 219 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-$(find_maven_basedir)} 220 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 221 | 222 | # Provide a "standardized" way to retrieve the CLI args that will 223 | # work with both Windows and non-Windows executions. 224 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 225 | export MAVEN_CMD_LINE_ARGS 226 | 227 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 228 | 229 | echo "Running version check" 230 | VERSION=$( sed '\!//' -e 's!.*$!!' ) 231 | echo "The found version is [${VERSION}]" 232 | 233 | if echo $VERSION | egrep -q 'M|RC'; then 234 | echo Activating \"milestone\" profile for version=\"$VERSION\" 235 | echo $MAVEN_ARGS | grep -q milestone || MAVEN_ARGS="$MAVEN_ARGS -Pmilestone" 236 | else 237 | echo Deactivating \"milestone\" profile for version=\"$VERSION\" 238 | echo $MAVEN_ARGS | grep -q milestone && MAVEN_ARGS=$(echo $MAVEN_ARGS | sed -e 's/-Pmilestone//') 239 | fi 240 | 241 | exec "$JAVACMD" \ 242 | $MAVEN_OPTS \ 243 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 244 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 245 | ${WRAPPER_LAUNCHER} ${MAVEN_ARGS} "$@" 246 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | https://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 | https://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 | --------------------------------------------------------------------------------