├── src └── main │ ├── resources │ └── META-INF │ │ ├── spring.provides │ │ ├── spring │ │ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports │ │ └── spring.factories │ └── java │ └── org │ └── mvnsearch │ └── spring │ └── boot │ └── trpc │ ├── TrpcInput.java │ ├── TrpcQuery.java │ ├── TrpcMutate.java │ ├── mvc │ ├── TrpcWebMvcConfigurer.java │ └── TrpcInputArgumentResolver.java │ ├── flux │ ├── TrpcWebFluxConfigurer.java │ └── TrpcInputArgumentResolver.java │ └── TrpcResponse.java ├── README.md ├── .gitignore ├── pom.xml └── LICENSE.txt /src/main/resources/META-INF/spring.provides: -------------------------------------------------------------------------------- 1 | provides: trpc-spring-boot-starter -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports: -------------------------------------------------------------------------------- 1 | org.mvnsearch.spring.boot.trpc.flux.TrpcWebFluxConfigurer 2 | org.mvnsearch.spring.boot.trpc.mvc.TrpcWebMvcConfigurer -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 2 | org.mvnsearch.spring.boot.trpc.flux.TrpcWebFluxConfigurer,\ 3 | org.mvnsearch.spring.boot.trpc.mvc.TrpcWebMvcConfigurer 4 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/TrpcInput.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc; 2 | 3 | import java.lang.annotation.*; 4 | 5 | @Target(ElementType.PARAMETER) 6 | @Retention(RetentionPolicy.RUNTIME) 7 | @Documented 8 | public @interface TrpcInput { 9 | } 10 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/TrpcQuery.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc; 2 | 3 | import org.springframework.core.annotation.AliasFor; 4 | import org.springframework.http.MediaType; 5 | import org.springframework.web.bind.annotation.RequestMapping; 6 | import org.springframework.web.bind.annotation.RequestMethod; 7 | import org.springframework.web.bind.annotation.ResponseBody; 8 | 9 | import java.lang.annotation.*; 10 | 11 | /** 12 | * tRPC Query 13 | * 14 | * @author linux_china 15 | */ 16 | @Target(ElementType.METHOD) 17 | @Retention(RetentionPolicy.RUNTIME) 18 | @Documented 19 | @RequestMapping(method = RequestMethod.GET) 20 | @ResponseBody 21 | public @interface TrpcQuery { 22 | @AliasFor(annotation = RequestMapping.class) 23 | String[] value() default {}; 24 | 25 | @AliasFor(annotation = RequestMapping.class) 26 | String[] produces() default {MediaType.APPLICATION_JSON_VALUE}; 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/TrpcMutate.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc; 2 | 3 | import org.springframework.core.annotation.AliasFor; 4 | import org.springframework.http.MediaType; 5 | import org.springframework.web.bind.annotation.RequestMapping; 6 | import org.springframework.web.bind.annotation.RequestMethod; 7 | import org.springframework.web.bind.annotation.ResponseBody; 8 | 9 | import java.lang.annotation.*; 10 | 11 | /** 12 | * tRPC mutate 13 | * 14 | * @author linux_china 15 | */ 16 | @Target(ElementType.METHOD) 17 | @Retention(RetentionPolicy.RUNTIME) 18 | @Documented 19 | @RequestMapping(method = RequestMethod.POST) 20 | @ResponseBody 21 | public @interface TrpcMutate { 22 | @AliasFor(annotation = RequestMapping.class) 23 | String[] value() default {}; 24 | 25 | @AliasFor(annotation = RequestMapping.class) 26 | String[] produces() default {MediaType.APPLICATION_JSON_VALUE}; 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/mvc/TrpcWebMvcConfigurer.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc.mvc; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import org.springframework.beans.factory.annotation.Autowired; 5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; 6 | import org.springframework.context.annotation.Configuration; 7 | import org.springframework.http.converter.HttpMessageConverter; 8 | import org.springframework.web.method.support.HandlerMethodArgumentResolver; 9 | import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; 10 | 11 | import java.util.List; 12 | 13 | @Configuration 14 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) 15 | public class TrpcWebMvcConfigurer implements WebMvcConfigurer { 16 | @Autowired 17 | private ObjectMapper objectMapper; 18 | @Autowired 19 | private List> converters; 20 | 21 | @Override 22 | public void addArgumentResolvers(List resolvers) { 23 | resolvers.add(new TrpcInputArgumentResolver(this.converters, objectMapper)); 24 | } 25 | 26 | } 27 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/flux/TrpcWebFluxConfigurer.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc.flux; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import org.springframework.beans.factory.annotation.Autowired; 5 | import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; 6 | import org.springframework.context.annotation.Configuration; 7 | import org.springframework.context.annotation.Lazy; 8 | import org.springframework.core.ReactiveAdapterRegistry; 9 | import org.springframework.http.codec.HttpMessageReader; 10 | import org.springframework.http.codec.ServerCodecConfigurer; 11 | import org.springframework.web.reactive.config.WebFluxConfigurer; 12 | import org.springframework.web.reactive.result.method.annotation.ArgumentResolverConfigurer; 13 | 14 | import java.util.List; 15 | 16 | @Configuration 17 | @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE) 18 | public class TrpcWebFluxConfigurer implements WebFluxConfigurer { 19 | @Autowired 20 | private ObjectMapper objectMapper; 21 | @Autowired 22 | @Lazy 23 | private ReactiveAdapterRegistry registry; 24 | private List> readers; 25 | 26 | @Override 27 | public void configureArgumentResolvers(ArgumentResolverConfigurer configurer) { 28 | configurer.addCustomResolver(new TrpcInputArgumentResolver(this.readers, this.registry, this.objectMapper)); 29 | } 30 | 31 | @Override 32 | public void configureHttpMessageCodecs(ServerCodecConfigurer configurer) { 33 | this.readers = configurer.getReaders(); 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/mvc/TrpcInputArgumentResolver.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc.mvc; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import org.mvnsearch.spring.boot.trpc.TrpcInput; 5 | import org.springframework.core.MethodParameter; 6 | import org.springframework.http.converter.HttpMessageConverter; 7 | import org.springframework.web.bind.support.WebDataBinderFactory; 8 | import org.springframework.web.context.request.NativeWebRequest; 9 | import org.springframework.web.method.support.ModelAndViewContainer; 10 | import org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor; 11 | 12 | import java.util.List; 13 | 14 | public class TrpcInputArgumentResolver extends RequestResponseBodyMethodProcessor { 15 | private ObjectMapper objectMapper; 16 | 17 | public TrpcInputArgumentResolver(List> converters, ObjectMapper objectMapper) { 18 | super(converters); 19 | this.objectMapper = objectMapper; 20 | } 21 | 22 | @Override 23 | public boolean supportsParameter(MethodParameter parameter) { 24 | return parameter.hasParameterAnnotation(TrpcInput.class); 25 | } 26 | 27 | protected boolean checkRequired(MethodParameter parameter) { 28 | return true; 29 | } 30 | 31 | @Override 32 | public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception { 33 | final String input = webRequest.getParameter("input"); 34 | if (input != null) { //tRPC query 35 | return objectMapper.readValue(input, parameter.getParameterType()); 36 | } else { 37 | return super.resolveArgument(parameter, mavContainer, webRequest, binderFactory); 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Spring Boot Starter tRPC 2 | ============================================= 3 | 4 | Spring Boot starter for [tRPC](https://trpc.io/), and compatible with webmvc/webflux of Spring Boot 2.x/3.0. 5 | 6 | # Get Started 7 | 8 | * Add dependency in your pom.xml 9 | 10 | ```xml 11 | 12 | 13 | org.mvnsearch 14 | trpc-spring-boot-starter 15 | 0.1.0 16 | 17 | ``` 18 | 19 | * Write controller for tRPC query/mutate 20 | 21 | ```java 22 | 23 | import org.mvnsearch.spring.boot.trpc.TrpcInput; 24 | import org.mvnsearch.spring.boot.trpc.TrpcMutate; 25 | import org.mvnsearch.spring.boot.trpc.TrpcQuery; 26 | import org.mvnsearch.spring.boot.trpc.TrpcResponse; 27 | import org.springframework.stereotype.Controller; 28 | 29 | import java.util.UUID; 30 | 31 | @Controller 32 | public class TrpcHelloController { 33 | record Hello(String name) { 34 | } 35 | 36 | @TrpcQuery("/greeting.hello") 37 | public TrpcResponse hello(@TrpcInput Hello hello) { 38 | return TrpcResponse.of("Hello " + hello.name); 39 | } 40 | 41 | record Poster(String id, String title, String text) { 42 | } 43 | 44 | @TrpcMutate("/poster.createPost") 45 | public TrpcResponse createPost(@TrpcInput Poster poster) { 46 | return TrpcResponse.of(new Poster(UUID.randomUUID().toString(), poster.title, poster.text)); 47 | } 48 | } 49 | ``` 50 | 51 | * Test your tRPC service with [httpx](https://httpx.sh/docs/tutorial-basics/trpc-testing) 52 | 53 | ``` 54 | ### trpc query 55 | TRPC http://localhost:8080/greeting.hello 56 | Content-Type: application/json 57 | 58 | { 59 | "name": "world" 60 | } 61 | 62 | ### trpc mutate 63 | TRPCM http://localhost:8080/poster.createPost 64 | Content-Type: application/json 65 | 66 | { 67 | "title": "title", 68 | "text": "hello world" 69 | } 70 | ``` 71 | 72 | # FAQ 73 | 74 | ### Could I use Spring Framework 6 HTTP Interface with tRPC? 75 | 76 | Please refer to [tRPC Spring HTTP Interface](https://github.com/linux-china/trpc-http-interface) 77 | 78 | # References 79 | 80 | * tRPC: https://trpc.io/ 81 | * tRPC testing: https://servicex.sh/docs/tutorial-basics/trpc-testing 82 | * tRPC Spring HTTP Interface: https://github.com/linux-china/trpc-http-interface -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/flux/TrpcInputArgumentResolver.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc.flux; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import org.mvnsearch.spring.boot.trpc.TrpcInput; 5 | import org.springframework.core.MethodParameter; 6 | import org.springframework.core.ReactiveAdapterRegistry; 7 | import org.springframework.http.HttpMethod; 8 | import org.springframework.http.codec.HttpMessageReader; 9 | import org.springframework.web.bind.annotation.RequestBody; 10 | import org.springframework.web.reactive.BindingContext; 11 | import org.springframework.web.reactive.result.method.annotation.AbstractMessageReaderArgumentResolver; 12 | import org.springframework.web.server.ServerWebExchange; 13 | import reactor.core.publisher.Mono; 14 | 15 | import java.util.List; 16 | 17 | 18 | public class TrpcInputArgumentResolver extends AbstractMessageReaderArgumentResolver { 19 | private final ObjectMapper objectMapper; 20 | 21 | public TrpcInputArgumentResolver(List> readers, ReactiveAdapterRegistry registry, ObjectMapper objectMapper) { 22 | super(readers, registry); 23 | this.objectMapper = objectMapper; 24 | } 25 | 26 | @Override 27 | public boolean supportsParameter(MethodParameter parameter) { 28 | return parameter.hasParameterAnnotation(TrpcInput.class); 29 | } 30 | 31 | @Override 32 | public Mono resolveArgument(MethodParameter parameter, BindingContext bindingContext, ServerWebExchange exchange) { 33 | if (exchange.getRequest().getMethod() == HttpMethod.POST) { 34 | return this.readBody(parameter, true, bindingContext, exchange); 35 | } else { 36 | return Mono.create(monoSink -> { 37 | try { 38 | String input = exchange.getRequest().getQueryParams().getFirst("input"); 39 | if (input == null) { 40 | monoSink.error(new Exception("input parameter is required!")); 41 | } else { 42 | monoSink.success(objectMapper.readValue(input, parameter.getParameterType())); 43 | } 44 | } catch (Exception e) { 45 | monoSink.error(e); 46 | } 47 | }); 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /src/main/java/org/mvnsearch/spring/boot/trpc/TrpcResponse.java: -------------------------------------------------------------------------------- 1 | package org.mvnsearch.spring.boot.trpc; 2 | 3 | import com.fasterxml.jackson.annotation.JsonInclude; 4 | 5 | @JsonInclude(JsonInclude.Include.NON_NULL) 6 | public class TrpcResponse { 7 | private Result result; 8 | private Error error; 9 | 10 | public TrpcResponse() { 11 | } 12 | 13 | public TrpcResponse(Result result) { 14 | this.result = result; 15 | } 16 | 17 | public TrpcResponse(Error error) { 18 | this.error = error; 19 | } 20 | 21 | public Result getResult() { 22 | return result; 23 | } 24 | 25 | public void setResult(Result result) { 26 | this.result = result; 27 | } 28 | 29 | public Error getError() { 30 | return error; 31 | } 32 | 33 | public void setError(Error error) { 34 | this.error = error; 35 | } 36 | 37 | public static TrpcResponse of(T data) { 38 | return new TrpcResponse<>(new Result(data)); 39 | } 40 | 41 | public static TrpcResponse error(String code, String message, Object data) { 42 | return new TrpcResponse<>(new Error(code, message, data)); 43 | } 44 | 45 | public static class Result { 46 | private T data; 47 | 48 | public Result() { 49 | } 50 | 51 | public Result(T data) { 52 | this.data = data; 53 | } 54 | 55 | public T getData() { 56 | return data; 57 | } 58 | 59 | public void setData(T data) { 60 | this.data = data; 61 | } 62 | 63 | } 64 | 65 | public static class Error { 66 | private String code; 67 | private String message; 68 | private Object data; 69 | 70 | public Error() { 71 | } 72 | 73 | public Error(String code, String message, Object data) { 74 | this.code = code; 75 | this.message = message; 76 | this.data = data; 77 | } 78 | 79 | public String getCode() { 80 | return code; 81 | } 82 | 83 | public void setCode(String code) { 84 | this.code = code; 85 | } 86 | 87 | public String getMessage() { 88 | return message; 89 | } 90 | 91 | public void setMessage(String message) { 92 | this.message = message; 93 | } 94 | 95 | public Object getData() { 96 | return data; 97 | } 98 | 99 | public void setData(Object data) { 100 | this.data = data; 101 | } 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/java,maven,jetbrains+all 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=java,maven,jetbrains+all 3 | 4 | ### Java ### 5 | # Compiled class file 6 | *.class 7 | 8 | # Log file 9 | *.log 10 | 11 | # BlueJ files 12 | *.ctxt 13 | 14 | # Mobile Tools for Java (J2ME) 15 | .mtj.tmp/ 16 | 17 | # Package Files # 18 | *.jar 19 | *.war 20 | *.nar 21 | *.ear 22 | *.zip 23 | *.tar.gz 24 | *.rar 25 | 26 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 27 | hs_err_pid* 28 | replay_pid* 29 | 30 | ### JetBrains+all ### 31 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 32 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 33 | 34 | # User-specific stuff 35 | .idea/**/workspace.xml 36 | .idea/**/tasks.xml 37 | .idea/**/usage.statistics.xml 38 | .idea/**/dictionaries 39 | .idea/**/shelf 40 | 41 | # AWS User-specific 42 | .idea/**/aws.xml 43 | 44 | # Generated files 45 | .idea/**/contentModel.xml 46 | 47 | # Sensitive or high-churn files 48 | .idea/**/dataSources/ 49 | .idea/**/dataSources.ids 50 | .idea/**/dataSources.local.xml 51 | .idea/**/sqlDataSources.xml 52 | .idea/**/dynamic.xml 53 | .idea/**/uiDesigner.xml 54 | .idea/**/dbnavigator.xml 55 | 56 | # Gradle 57 | .idea/**/gradle.xml 58 | .idea/**/libraries 59 | 60 | # Gradle and Maven with auto-import 61 | # When using Gradle or Maven with auto-import, you should exclude module files, 62 | # since they will be recreated, and may cause churn. Uncomment if using 63 | # auto-import. 64 | # .idea/artifacts 65 | # .idea/compiler.xml 66 | # .idea/jarRepositories.xml 67 | # .idea/modules.xml 68 | # .idea/*.iml 69 | # .idea/modules 70 | # *.iml 71 | # *.ipr 72 | 73 | # CMake 74 | cmake-build-*/ 75 | 76 | # Mongo Explorer plugin 77 | .idea/**/mongoSettings.xml 78 | 79 | # File-based project format 80 | *.iws 81 | 82 | # IntelliJ 83 | out/ 84 | 85 | # mpeltonen/sbt-idea plugin 86 | .idea_modules/ 87 | 88 | # JIRA plugin 89 | atlassian-ide-plugin.xml 90 | 91 | # Cursive Clojure plugin 92 | .idea/replstate.xml 93 | 94 | # SonarLint plugin 95 | .idea/sonarlint/ 96 | 97 | # Crashlytics plugin (for Android Studio and IntelliJ) 98 | com_crashlytics_export_strings.xml 99 | crashlytics.properties 100 | crashlytics-build.properties 101 | fabric.properties 102 | 103 | # Editor-based Rest Client 104 | .idea/httpRequests 105 | 106 | # Android studio 3.1+ serialized cache file 107 | .idea/caches/build_file_checksums.ser 108 | 109 | ### JetBrains+all Patch ### 110 | # Ignore everything but code style settings and run configurations 111 | # that are supposed to be shared within teams. 112 | 113 | .idea/* 114 | 115 | !.idea/codeStyles 116 | !.idea/runConfigurations 117 | 118 | ### Maven ### 119 | target/ 120 | pom.xml.tag 121 | pom.xml.releaseBackup 122 | pom.xml.versionsBackup 123 | pom.xml.next 124 | release.properties 125 | dependency-reduced-pom.xml 126 | buildNumber.properties 127 | .mvn/timing.properties 128 | # https://github.com/takari/maven-wrapper#usage-without-binary-jar 129 | .mvn/wrapper/maven-wrapper.jar 130 | 131 | # Eclipse m2e generated files 132 | # Eclipse Core 133 | .project 134 | # JDT-specific (Eclipse Java Development Tools) 135 | .classpath 136 | 137 | # End of https://www.toptal.com/developers/gitignore/api/java,maven,jetbrains+all 138 | 139 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.mvnsearch 7 | trpc-spring-boot-starter 8 | 0.1.1-SNAPSHOT 9 | jar 10 | 11 | trpc-spring-boot-starter 12 | Spring Boot starter tRPC 13 | https://github.com/linux-china/trpc-spring-boot-starter 14 | 15 | 16 | UTF-8 17 | 1.8 18 | ${java.version} 19 | ${java.version} 20 | 2.7.9 21 | 22 | 23 | 24 | 25 | linux_china 26 | Jacky Chan 27 | libing.chen@gmail.com 28 | https://twitter.com/linux_china 29 | 30 | Developer 31 | 32 | 33 | 34 | 35 | 36 | 37 | The Apache License, Version 2.0 38 | https://www.apache.org/licenses/LICENSE-2.0.txt 39 | 40 | 41 | 42 | 43 | scm:git:git@github.com:linux-china/trpc-spring-boot-starter.git 44 | scm:git:git@github.com:linux-china/trpc-spring-boot-starter.git 45 | https://github.com/linux-china/trpc-spring-boot-starter 46 | 47 | 48 | 49 | 50 | ossrh 51 | https://oss.sonatype.org/content/repositories/snapshots 52 | 53 | 54 | ossrh 55 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 56 | 57 | 58 | 59 | 60 | 61 | org.springframework.boot 62 | spring-boot-starter-web 63 | true 64 | 65 | 66 | org.springframework.boot 67 | spring-boot-starter-webflux 68 | true 69 | 70 | 71 | org.springframework.boot 72 | spring-boot-starter-test 73 | test 74 | 75 | 76 | 77 | 78 | 79 | 80 | org.apache.maven.plugins 81 | maven-compiler-plugin 82 | 3.11.0 83 | 84 | true 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | org.springframework.boot 94 | spring-boot-dependencies 95 | ${spring-boot.version} 96 | pom 97 | import 98 | 99 | 100 | 101 | 102 | 103 | 104 | release 105 | 106 | 107 | 108 | org.sonatype.plugins 109 | nexus-staging-maven-plugin 110 | 1.6.12 111 | true 112 | 113 | ossrh 114 | https://s01.oss.sonatype.org/ 115 | true 116 | 117 | 118 | 119 | org.apache.maven.plugins 120 | maven-source-plugin 121 | 3.2.1 122 | 123 | 124 | attach-sources 125 | 126 | jar-no-fork 127 | 128 | 129 | 130 | 131 | 132 | org.apache.maven.plugins 133 | maven-javadoc-plugin 134 | 3.1.1 135 | 136 | 137 | attach-javadocs 138 | 139 | jar 140 | 141 | 142 | 143 | 144 | 145 | org.apache.maven.plugins 146 | maven-gpg-plugin 147 | 1.6 148 | 149 | 150 | sign-artifacts 151 | verify 152 | 153 | sign 154 | 155 | 156 | 157 | --pinentry-mode 158 | loopback 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------