├── images ├── ssl-config.png └── Snipaste_2022-09-08_08-51-03.png ├── Dockerfile ├── src └── main │ ├── java │ └── com │ │ └── wxy97 │ │ ├── repository │ │ └── ShortUrlRepository.java │ │ ├── service │ │ ├── ShortUrlService.java │ │ └── ShortUrlServiceImpl.java │ │ ├── ShortUrlApplication.java │ │ ├── param │ │ └── ShortUrlParam.java │ │ ├── entity │ │ └── ShortUrl.java │ │ ├── filter │ │ └── ShortUrlBloomFilter.java │ │ ├── controller │ │ └── ShortUrlController.java │ │ └── util │ │ └── URLUtil.java │ └── resources │ ├── application.yml │ └── templates │ └── index.html ├── .gitignore ├── README.md ├── pom.xml └── LICENSE /images/ssl-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wxyShine/short-url/HEAD/images/ssl-config.png -------------------------------------------------------------------------------- /images/Snipaste_2022-09-08_08-51-03.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wxyShine/short-url/HEAD/images/Snipaste_2022-09-08_08-51-03.png -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # 定义父镜像 2 | FROM anapsix/alpine-java:8_server-jre_unlimited 3 | # 维护者信息 4 | MAINTAINER wxy 5 | # 暴漏端口 6 | EXPOSE 8090 7 | # 将jar包添加到容器 8 | ADD /target/short-url.jar /root/short-url.jar 9 | # 定义容器启动执行的命令 10 | ENTRYPOINT ["java", "-jar", "/root/short-url.jar"] 11 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/repository/ShortUrlRepository.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.repository; 2 | 3 | import com.wxy97.entity.ShortUrl; 4 | import org.springframework.data.jpa.repository.JpaRepository; 5 | 6 | public interface ShortUrlRepository extends JpaRepository { 7 | } 8 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/service/ShortUrlService.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.service; 2 | 3 | import com.wxy97.entity.ShortUrl; 4 | 5 | import java.util.List; 6 | 7 | public interface ShortUrlService { 8 | 9 | 10 | ShortUrl genShortUrl(String longUrl, String baseUrl); 11 | 12 | ShortUrl genLongUrl(String shorts); 13 | 14 | List getAllShort(); 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/ShortUrlApplication.java: -------------------------------------------------------------------------------- 1 | package com.wxy97; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class ShortUrlApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(ShortUrlApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/** 5 | !**/src/test/** 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | **/rebel.xml 22 | .fastRequest 23 | ### NetBeans ### 24 | /nbproject/private/ 25 | /nbbuild/ 26 | /dist/ 27 | /nbdist/ 28 | /.nb-gradle/ 29 | build/ 30 | 31 | ### VS Code ### 32 | .vscode/ 33 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/param/ShortUrlParam.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.param; 2 | 3 | import lombok.Data; 4 | 5 | import javax.validation.constraints.NotNull; 6 | import javax.validation.constraints.Pattern; 7 | 8 | /** 9 | * @author: wxy 10 | * @create: 2022-02-23 17:29 11 | * @email: admin@mail.wxy97.com 12 | * @description: 13 | **/ 14 | @Data 15 | public class ShortUrlParam { 16 | @NotNull(message = "参数错误") 17 | @Pattern(regexp = "http(s*)://[^\\s]*",message = "不是合法的url") 18 | private String longUrl; 19 | } 20 | -------------------------------------------------------------------------------- /src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | server: 2 | port: 8090 3 | spring: 4 | application: 5 | name: short-url 6 | datasource: 7 | driver-class-name: org.h2.Driver 8 | url: jdbc:h2:file:~/.short-url/short-db 9 | username: admin 10 | password: 123456 11 | jpa: 12 | database-platform: org.hibernate.dialect.H2Dialect 13 | hibernate: 14 | ddl-auto: update 15 | properties: 16 | hibernate: 17 | show_sql: true 18 | format_sql: true 19 | open-in-view: false 20 | h2: 21 | console: 22 | enabled: false 23 | path: /h2 24 | settings: 25 | trace: false 26 | web-allow-others: false 27 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/entity/ShortUrl.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.entity; 2 | 3 | import com.fasterxml.jackson.annotation.JsonFormat; 4 | import lombok.AllArgsConstructor; 5 | import lombok.Builder; 6 | import lombok.Data; 7 | import lombok.NoArgsConstructor; 8 | import org.hibernate.annotations.CreationTimestamp; 9 | 10 | import javax.persistence.*; 11 | import java.time.LocalDateTime; 12 | 13 | @Entity 14 | @Table(name = "short_url",indexes = {@Index(name = "idx_shorts",columnList = "shorts",unique = true)}) 15 | @Data 16 | @Builder 17 | @AllArgsConstructor 18 | @NoArgsConstructor 19 | public class ShortUrl { 20 | 21 | @Id 22 | @GeneratedValue(strategy = GenerationType.AUTO) 23 | private Long id; 24 | 25 | private String shorts; 26 | 27 | @Lob @Basic(fetch = FetchType.LAZY) @Column(columnDefinition = "text") 28 | private String longUrl; 29 | 30 | private String shortUrl; 31 | 32 | @CreationTimestamp 33 | @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") 34 | private LocalDateTime createTime; 35 | } 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 短链接生成服务 2 | > 基于spring boot + H2 数据库实现的短链接生成服务(jdk1.8) 3 | 4 | ## ~~演示 https://a-url.tk ~~ 5 | > 演示站为公共服务(不能保证永久链接),如需使用请自行部署。 6 | 7 | ![demo](./images/Snipaste_2022-09-08_08-51-03.png) 8 | 9 | ## 提供API wiki 10 | 11 | 12 | ## 部署方式一 🖥️ 13 | 需要环境:jdk1.8 14 | 15 | > 下载jar包 直接启动 默认端口 8090 16 | 17 | ```shell 18 | # 自行替换版本号 19 | java -jar -Xms128m -Xmx512m -XX:PermSize=128M -XX:MaxPermSize=256M short-url-版本号.jar 20 | 21 | ``` 22 | 23 | ## 部署方式二 🐋 24 | 需要已经安装docker 参考 25 | [docker hub](https://hub.docker.com/r/wxyshine/short-url) 26 | 27 | > 使用docker方式部署 `latest`默认最新版本 可以指定版本 28 | 29 | ```shell 30 | docker run -d -p 8090:8090 -v ~/.short-url:/root/.short-url --name short-url --restart=always wxyshine/short-url:latest 31 | ``` 32 | 33 | 34 | > 如nginx 配置ssl后 生成的短链接不带https 35 | > 在nginx 配置加上 `proxy_set_header X-Forwarded-Scheme $scheme;` 36 | 37 | ![conf](./images/ssl-config.png) 38 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/filter/ShortUrlBloomFilter.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.filter; 2 | 3 | import com.google.common.hash.BloomFilter; 4 | import com.google.common.hash.Funnels; 5 | import com.wxy97.service.ShortUrlService; 6 | import lombok.RequiredArgsConstructor; 7 | import lombok.extern.slf4j.Slf4j; 8 | import org.springframework.beans.factory.InitializingBean; 9 | import org.springframework.stereotype.Service; 10 | 11 | import java.nio.charset.Charset; 12 | import java.util.List; 13 | 14 | @Service 15 | @Slf4j 16 | @RequiredArgsConstructor 17 | public class ShortUrlBloomFilter implements InitializingBean { 18 | 19 | private static BloomFilter bloomFilter = BloomFilter.create( 20 | Funnels.stringFunnel(Charset.defaultCharset()), 1000000); 21 | 22 | 23 | private final ShortUrlService shortUrlService; 24 | 25 | public static boolean mightContain(String shorts) { 26 | return bloomFilter.mightContain(shorts); 27 | } 28 | 29 | public static void put(String shorts) { 30 | bloomFilter.put(shorts); 31 | } 32 | 33 | @Override 34 | public void afterPropertiesSet() { 35 | log.info("===============初始化BloomFilter......=============="); 36 | long startTime = System.currentTimeMillis(); 37 | long count = 0; 38 | //从数据加载数据到 BloomFilter 39 | List allShorts = shortUrlService.getAllShort(); 40 | for (String hash : allShorts) { 41 | bloomFilter.put(hash); 42 | } 43 | count = allShorts.size(); 44 | long costTime = System.currentTimeMillis() - startTime; 45 | log.info("===============初始化BloomFilter完成,costTime:[{}],Count:[{}]==============", costTime, count); 46 | } 47 | } -------------------------------------------------------------------------------- /src/main/java/com/wxy97/controller/ShortUrlController.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.controller; 2 | 3 | import com.wxy97.entity.ShortUrl; 4 | import com.wxy97.param.ShortUrlParam; 5 | import com.wxy97.service.ShortUrlService; 6 | import com.wxy97.util.URLUtil; 7 | import lombok.RequiredArgsConstructor; 8 | import org.springframework.http.HttpStatus; 9 | import org.springframework.http.ResponseEntity; 10 | import org.springframework.stereotype.Controller; 11 | import org.springframework.validation.annotation.Validated; 12 | import org.springframework.web.bind.annotation.*; 13 | 14 | import javax.servlet.http.HttpServletRequest; 15 | import javax.servlet.http.HttpServletResponse; 16 | import java.io.IOException; 17 | import java.util.Objects; 18 | 19 | /** 20 | * @author wxy 21 | */ 22 | @Controller 23 | @RequiredArgsConstructor 24 | public class ShortUrlController { 25 | 26 | private final ShortUrlService shortUrlServiceImpl; 27 | 28 | @GetMapping("/") 29 | public String index() { 30 | return "index"; 31 | } 32 | 33 | /** 34 | * 生成短链接 35 | * 36 | * @param param 需要转换的链接 37 | * @param request 38 | * @return 39 | */ 40 | @PostMapping("/") 41 | @ResponseBody 42 | public ResponseEntity shortUrl(@Validated @RequestBody ShortUrlParam param, HttpServletRequest request) { 43 | return new ResponseEntity(shortUrlServiceImpl.genShortUrl(param.getLongUrl(), URLUtil.getUrlStart(request)), HttpStatus.OK); 44 | } 45 | 46 | /** 47 | * 访问短链接 48 | * 49 | * @param response 50 | * @param shorts 51 | * @return 52 | */ 53 | @GetMapping("/s/{shorts}") 54 | @ResponseBody 55 | public ResponseEntity redirectUrl(HttpServletResponse response, @PathVariable String shorts) { 56 | ShortUrl shortUrl = shortUrlServiceImpl.genLongUrl(shorts); 57 | if (Objects.nonNull(shortUrl)) { 58 | try { 59 | response.sendRedirect(shortUrl.getLongUrl()); 60 | } catch (IOException e) { 61 | e.printStackTrace(); 62 | } 63 | return null; 64 | } else { 65 | return ResponseEntity.status(HttpStatus.NOT_FOUND).body("不存在的短链接"); 66 | } 67 | } 68 | 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/util/URLUtil.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.util; 2 | 3 | import com.wxy97.filter.ShortUrlBloomFilter; 4 | import lombok.extern.slf4j.Slf4j; 5 | 6 | import javax.servlet.http.HttpServletRequest; 7 | import java.util.Random; 8 | 9 | /** 10 | * @author wxy 11 | */ 12 | @Slf4j 13 | public class URLUtil { 14 | /** 15 | * 生成短链接的6个字符 16 | * 17 | * @return 18 | */ 19 | public static String getShortURL() { 20 | Random random = new Random(); 21 | // 要使用生成 URL 的字符 22 | char[] chars = new char[]{'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 23 | 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 24 | 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', 25 | '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 26 | 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 27 | 'U', 'V', 'W', 'X', 'Y', 'Z' 28 | }; 29 | int ln = chars.length; 30 | StringBuilder key = new StringBuilder(); 31 | for (int i = 0; i < 6; ++i) { 32 | key.append(chars[random.nextInt(ln)]); 33 | } 34 | String s = key.toString(); 35 | //从 BloomFilter 查看是否存在 36 | boolean mightContain = ShortUrlBloomFilter.mightContain(s); 37 | if (mightContain) { 38 | String newS = getShortURL(); 39 | s = newS; 40 | log.debug("{}已存在shorts,重新生成{}", s, newS); 41 | } 42 | return s; 43 | } 44 | 45 | /** 46 | * 获取请求的协议域名,端口号生成连接的前半部分 47 | * 48 | * @param request 49 | * @return 50 | */ 51 | public static String getUrlStart(HttpServletRequest request) { 52 | StringBuilder url = new StringBuilder(); 53 | String header = request.getHeader("X-Forwarded-Scheme"); 54 | if (header != null) { 55 | url.append(header); 56 | } else { 57 | url.append(request.getScheme()); 58 | } 59 | url.append("://").append(request.getServerName()); 60 | if (request.getServerPort() != 80 && request.getServerPort() != 443) { 61 | url.append(":").append(request.getServerPort()); 62 | } 63 | return url.toString(); 64 | } 65 | } 66 | 67 | -------------------------------------------------------------------------------- /src/main/java/com/wxy97/service/ShortUrlServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.wxy97.service; 2 | 3 | import com.wxy97.entity.ShortUrl; 4 | import com.wxy97.filter.ShortUrlBloomFilter; 5 | import com.wxy97.repository.ShortUrlRepository; 6 | import com.wxy97.util.URLUtil; 7 | import lombok.RequiredArgsConstructor; 8 | import org.springframework.data.domain.Example; 9 | import org.springframework.stereotype.Service; 10 | import org.springframework.validation.BindException; 11 | import org.springframework.web.bind.MethodArgumentNotValidException; 12 | 13 | import java.util.List; 14 | import java.util.Optional; 15 | import java.util.stream.Collectors; 16 | 17 | @Service 18 | @RequiredArgsConstructor 19 | public class ShortUrlServiceImpl implements ShortUrlService { 20 | 21 | private final ShortUrlRepository shortUrlRepository; 22 | 23 | /** 24 | * 生成短链接 25 | * 26 | * @param longUrl 27 | * @param baseUrl 28 | * @return 29 | */ 30 | @Override 31 | public ShortUrl genShortUrl(String longUrl, String baseUrl) { 32 | String shortURL = URLUtil.getShortURL(); 33 | ShortUrl build = ShortUrl.builder() 34 | .shorts(shortURL) 35 | .longUrl(longUrl) 36 | .shortUrl(baseUrl + "/s/" + shortURL).build(); 37 | ShortUrl save = shortUrlRepository.save(build); 38 | ShortUrlBloomFilter.put(save.getShorts()); 39 | return save; 40 | } 41 | 42 | /** 43 | * 转换为原链接 44 | * 45 | * @param shorts 46 | * @return 47 | */ 48 | @Override 49 | public ShortUrl genLongUrl(String shorts) { 50 | if (ShortUrlBloomFilter.mightContain(shorts)) { 51 | ShortUrl build = ShortUrl.builder().shorts(shorts).build(); 52 | Example example = Example.of(build); 53 | Optional one = shortUrlRepository.findOne(example); 54 | if (one.isPresent()) { 55 | build = one.get(); 56 | return build; 57 | } 58 | } 59 | return null; 60 | } 61 | 62 | /** 63 | * 获取全部数据 64 | * 65 | * @return 66 | */ 67 | @Override 68 | public List getAllShort() { 69 | return shortUrlRepository.findAll().stream().map(ShortUrl::getShorts).collect(Collectors.toList()); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | com.wxy97 6 | short-url 7 | 1.0.5 8 | short-url 9 | 短链接服务 10 | 11 | 12 | 1.8 13 | UTF-8 14 | UTF-8 15 | 2.6.6 16 | 30.1.1-jre 17 | 2.1.210 18 | 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-web 24 | 25 | 26 | org.springframework.boot 27 | spring-boot-starter-data-jpa 28 | 29 | 30 | org.springframework.boot 31 | spring-boot-starter-thymeleaf 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-validation 36 | 37 | 38 | com.h2database 39 | h2 40 | ${h2.version} 41 | 42 | 43 | org.projectlombok 44 | lombok 45 | 46 | 47 | com.google.guava 48 | guava 49 | ${guava.version} 50 | 51 | 52 | 53 | 54 | 55 | 56 | org.springframework.boot 57 | spring-boot-dependencies 58 | ${spring-boot.version} 59 | pom 60 | import 61 | 62 | 63 | 64 | 65 | 66 | short-url 67 | 68 | 69 | org.apache.maven.plugins 70 | maven-compiler-plugin 71 | 3.9.0 72 | 73 | 1.8 74 | 1.8 75 | UTF-8 76 | 77 | 78 | 79 | org.springframework.boot 80 | spring-boot-maven-plugin 81 | 2.4.1 82 | 83 | com.wxy97.ShortUrlApplication 84 | 85 | 86 | 87 | repackage 88 | 89 | repackage 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | -------------------------------------------------------------------------------- /src/main/resources/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Short-Url 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 25 | 26 | 51 |
52 | 53 | 54 |
55 |

短链接生成服务

56 | 58 | 59 | 60 | 62 | 64 | 65 |
66 |
67 |
68 |
69 | 70 | 156 | 157 | 179 | 180 | 181 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------