├── README.md ├── lib ├── junit-4.12.jar ├── httpcore-4.4.4.jar ├── httpclient-4.5.2.jar ├── hamcrest-core-1.3.jar └── commons-logging-1.1.3.jar ├── .gitignore ├── .project ├── .classpath ├── src └── com │ └── axatrikx │ ├── controller │ ├── RestResponse.java │ ├── RestValidator.java │ └── RestExecutor.java │ └── test │ └── TestScript.java ├── pom.xml └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # rest-framework 2 | A simple REST testing framework 3 | -------------------------------------------------------------------------------- /lib/junit-4.12.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amalbose/rest-framework/HEAD/lib/junit-4.12.jar -------------------------------------------------------------------------------- /lib/httpcore-4.4.4.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amalbose/rest-framework/HEAD/lib/httpcore-4.4.4.jar -------------------------------------------------------------------------------- /lib/httpclient-4.5.2.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amalbose/rest-framework/HEAD/lib/httpclient-4.5.2.jar -------------------------------------------------------------------------------- /lib/hamcrest-core-1.3.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amalbose/rest-framework/HEAD/lib/hamcrest-core-1.3.jar -------------------------------------------------------------------------------- /lib/commons-logging-1.1.3.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amalbose/rest-framework/HEAD/lib/commons-logging-1.1.3.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.jar 8 | *.war 9 | *.ear 10 | 11 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 12 | hs_err_pid* 13 | -------------------------------------------------------------------------------- /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | rest-framework 4 | 5 | 6 | 7 | 8 | 9 | org.eclipse.jdt.core.javabuilder 10 | 11 | 12 | 13 | 14 | org.eclipse.m2e.core.maven2Builder 15 | 16 | 17 | 18 | 19 | 20 | org.eclipse.m2e.core.maven2Nature 21 | org.eclipse.jdt.core.javanature 22 | 23 | 24 | -------------------------------------------------------------------------------- /.classpath: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/com/axatrikx/controller/RestResponse.java: -------------------------------------------------------------------------------- 1 | package com.axatrikx.controller; 2 | 3 | import java.util.HashMap; 4 | 5 | public class RestResponse { 6 | 7 | private int responseCode; 8 | private String responseBody; 9 | private HashMap headers; 10 | private String responseMessage; 11 | 12 | public RestResponse() { 13 | headers = new HashMap(); 14 | } 15 | 16 | public int getResponseCode() { 17 | return responseCode; 18 | } 19 | 20 | public void setResponseCode(int responseCode) { 21 | this.responseCode = responseCode; 22 | } 23 | 24 | public String getResponseBody() { 25 | return responseBody; 26 | } 27 | 28 | public void setResponseBody(String responseBody) { 29 | this.responseBody = responseBody; 30 | } 31 | 32 | public HashMap getHeaders() { 33 | return headers; 34 | } 35 | 36 | public String getHeader(String name) { 37 | return headers.get(name); 38 | } 39 | 40 | public void setHeader(String name, String value) { 41 | this.headers.put(name, value); 42 | } 43 | 44 | public String getResponseMessage() { 45 | return responseMessage; 46 | } 47 | 48 | public void setResponseMessage(String responseMessage) { 49 | this.responseMessage = responseMessage; 50 | } 51 | 52 | } 53 | -------------------------------------------------------------------------------- /src/com/axatrikx/controller/RestValidator.java: -------------------------------------------------------------------------------- 1 | package com.axatrikx.controller; 2 | 3 | import java.util.HashMap; 4 | import java.util.Set; 5 | 6 | import org.junit.Assert; 7 | 8 | public class RestValidator { 9 | 10 | private RestResponse response; 11 | 12 | RestValidator(RestResponse response) { 13 | this.response = response; 14 | } 15 | 16 | public RestValidator expectCode(int expectedCode) { 17 | Assert.assertEquals("Incorrect Response Code", expectedCode, response.getResponseCode()); 18 | return this; 19 | } 20 | 21 | public RestValidator expectMessage(String message) { 22 | Assert.assertEquals("Incorrect Response Message", message, response.getResponseMessage()); 23 | return this; 24 | } 25 | 26 | public RestValidator expectHeader(String headerName, String headerValue) { 27 | Assert.assertEquals("Incorrect header - " + headerName, headerValue, response.getHeader(headerName)); 28 | return this; 29 | } 30 | 31 | public RestValidator expectHeaders(HashMap headers) { 32 | Set keys = headers.keySet(); 33 | for (String key : keys) { 34 | Assert.assertEquals("Incorrect header - " + key, headers.get(key), response.getHeader(key)); 35 | } 36 | return this; 37 | } 38 | 39 | public RestValidator expectInBody(String content) { 40 | Assert.assertTrue("Body doesnt contain string : " + content, response.getResponseBody().contains(content)); 41 | return this; 42 | } 43 | 44 | public RestValidator printBody(){ 45 | System.out.println(response.getResponseBody()); 46 | return this; 47 | } 48 | 49 | public RestResponse getResponse(){ 50 | return response; 51 | } 52 | 53 | } 54 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | rest-framework 5 | rest-framework 6 | 0.0.1-SNAPSHOT 7 | 8 | 9 | 10 | commons-logging 11 | commons-logging 12 | 1.1 13 | 14 | 15 | org.hamcrest 16 | hamcrest-core 17 | 1.3 18 | 19 | 20 | org.apache.httpcomponents 21 | httpclient 22 | 4.5.2 23 | 24 | 25 | org.apache.httpcomponents 26 | httpcore 27 | 4.4.4 28 | 29 | 30 | junit 31 | junit 32 | 4.12 33 | 34 | 35 | 36 | src 37 | src/com/axatrikx/test 38 | 39 | 40 | maven-compiler-plugin 41 | 3.3 42 | 43 | 1.6 44 | 1.6 45 | 46 | 47 | 48 | org.apache.maven.plugins 49 | maven-surefire-plugin 50 | 2.16 51 | 52 | 53 | **/*.java 54 | 55 | 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /src/com/axatrikx/test/TestScript.java: -------------------------------------------------------------------------------- 1 | package com.axatrikx.test; 2 | 3 | import org.junit.BeforeClass; 4 | import org.junit.Test; 5 | 6 | import com.axatrikx.controller.RestExecutor; 7 | 8 | public class TestScript { 9 | 10 | private static final String URL = "http://localhost:3000"; 11 | 12 | private static RestExecutor executor; 13 | 14 | @BeforeClass 15 | public static void setUp() { 16 | /* 17 | * Initialize RestExecutor object using the end point URL 18 | */ 19 | executor = new RestExecutor(URL); 20 | } 21 | 22 | @Test 23 | public void testGETMethod() { 24 | /* 25 | * Performs GET operation on http://localhost:3000/posts. 26 | * Note that we give only the path in the get method as we use 27 | * the domain part while initializing the RestExecutor object 28 | */ 29 | executor.get("/posts") 30 | .expectCode(200) // Expected code of 200 31 | .expectMessage("OK") // Expected Message of 'OK' 32 | .expectHeader("Content-Type", "application/json; charset=utf-8") // Content-Type header value 33 | .expectInBody("rest testing framework") // Content inside the response body 34 | .expectInBody("webdriver framework") // Another Content inside the response body 35 | .expectInBody("axatrikx"); // Yet Another Content inside the response body 36 | 37 | /* 38 | * GET for a specific item 39 | */ 40 | executor.get("/posts/1") 41 | .expectCode(200) 42 | .expectMessage("OK") 43 | .expectHeader("Content-Type", "application/json; charset=utf-8") 44 | .expectInBody("rest testing framework") 45 | .expectInBody("axatrikx"); 46 | 47 | /* 48 | * GET for a seach query 49 | */ 50 | executor.get("/posts?title=rest%20testing%20framework&author=axatrikx") 51 | .expectCode(200) 52 | .expectMessage("OK") 53 | .expectHeader("Content-Type", "application/json; charset=utf-8") 54 | .expectInBody("rest testing framework") 55 | .expectInBody("axatrikx"); 56 | } 57 | 58 | 59 | 60 | @Test 61 | public void testPOSTMethod() { 62 | /* 63 | * POST operation for insertion providing the path, xml content and content type. 64 | */ 65 | executor.post("/posts", "{ \"title\": \"new test\", \"author\": \"axatrikx\" }", "application/json") 66 | .expectCode(201) 67 | .expectMessage("Created") 68 | .expectHeader("Content-Type", "application/json; charset=utf-8") 69 | .expectInBody("\"title\": \"new test\"") 70 | .expectInBody("axatrikx"); 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /src/com/axatrikx/controller/RestExecutor.java: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | */ 4 | package com.axatrikx.controller; 5 | 6 | import java.io.BufferedReader; 7 | import java.io.InputStreamReader; 8 | import java.util.ArrayList; 9 | import java.util.HashMap; 10 | import java.util.List; 11 | import java.util.Set; 12 | 13 | import org.apache.http.Header; 14 | import org.apache.http.HttpEntity; 15 | import org.apache.http.HttpResponse; 16 | import org.apache.http.client.HttpClient; 17 | import org.apache.http.client.entity.UrlEncodedFormEntity; 18 | import org.apache.http.client.methods.HttpDelete; 19 | import org.apache.http.client.methods.HttpGet; 20 | import org.apache.http.client.methods.HttpPatch; 21 | import org.apache.http.client.methods.HttpPost; 22 | import org.apache.http.client.methods.HttpPut; 23 | import org.apache.http.entity.StringEntity; 24 | import org.apache.http.impl.client.HttpClientBuilder; 25 | import org.apache.http.message.BasicNameValuePair; 26 | 27 | public class RestExecutor { 28 | 29 | private HttpClient client; 30 | private String url; 31 | 32 | /** 33 | * Constructor for RestExecutor 34 | * 35 | * @param url 36 | */ 37 | public RestExecutor(String url) { 38 | client = HttpClientBuilder.create().build(); 39 | this.url = url; 40 | } 41 | 42 | public RestValidator get(String path) { 43 | return get(path, null); 44 | } 45 | 46 | /** 47 | * Executes GET req and returns response json. 48 | * 49 | * @param path 50 | * @param headers 51 | * @return 52 | */ 53 | public RestValidator get(String path, HashMap headers) { 54 | HttpGet request = new HttpGet(url + path); 55 | HttpResponse response; 56 | /* 57 | * The response object which holds the details of the response. 58 | */ 59 | RestResponse resResponse = new RestResponse(); 60 | StringBuffer responseString = new StringBuffer(); 61 | try { 62 | /* 63 | * Setting the headers for the request 64 | */ 65 | if (headers != null) { 66 | Set keys = headers.keySet(); 67 | for (String key : keys) { 68 | request.addHeader(key, headers.get(key)); 69 | } 70 | } 71 | /* 72 | * Executing the GET operation 73 | */ 74 | response = client.execute(request); 75 | 76 | /* 77 | * Obtaining the response body from the response stream. 78 | */ 79 | BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent())); 80 | String line = ""; 81 | while ((line = rd.readLine()) != null) { 82 | responseString.append(line); 83 | } 84 | /* 85 | * Setting values for the response object 86 | */ 87 | resResponse.setResponseBody(responseString.toString()); 88 | resResponse.setResponseCode(response.getStatusLine().getStatusCode()); 89 | resResponse.setResponseMessage(response.getStatusLine().getReasonPhrase()); 90 | Header[] rheaders = response.getAllHeaders(); 91 | for (Header header : rheaders) { 92 | resResponse.setHeader(header.getName(), header.getValue()); 93 | } 94 | } catch (Exception e) { 95 | e.printStackTrace(); 96 | } 97 | /* 98 | * Returns the RestValidator object providing the response object 99 | */ 100 | return new RestValidator(resResponse); 101 | } 102 | 103 | public RestValidator post(String path, String xmlContent, String contentType) { 104 | return post(path, null, xmlContent, contentType); 105 | } 106 | 107 | /** 108 | * Executes POST req and returns response json. 109 | * 110 | * @param path 111 | * @param headers 112 | * @return 113 | */ 114 | public RestValidator post(String path, HashMap headers, String xmlContent, String contentType) { 115 | HttpPost post = new HttpPost(url + path); 116 | RestResponse resResponse = new RestResponse(); 117 | StringBuffer responseString = new StringBuffer(); 118 | try { 119 | if (headers != null) 120 | post.setEntity(getEntities(headers)); 121 | 122 | /* 123 | * Setting the xml content and content type. 124 | */ 125 | StringEntity input = new StringEntity(xmlContent); 126 | input.setContentType(contentType); 127 | post.setEntity(input); 128 | 129 | HttpResponse response = client.execute(post); 130 | BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent())); 131 | String line = ""; 132 | while ((line = rd.readLine()) != null) { 133 | responseString.append(line); 134 | } 135 | resResponse.setResponseBody(responseString.toString()); 136 | resResponse.setResponseCode(response.getStatusLine().getStatusCode()); 137 | resResponse.setResponseMessage(response.getStatusLine().getReasonPhrase()); 138 | Header[] rheaders = response.getAllHeaders(); 139 | for (Header header : rheaders) { 140 | resResponse.setHeader(header.getName(), header.getValue()); 141 | } 142 | } catch (Exception e) { 143 | e.printStackTrace(); // handle 144 | } 145 | return new RestValidator(resResponse); 146 | } 147 | 148 | public RestValidator delete(String path) { 149 | return delete(path, null); 150 | } 151 | 152 | /** 153 | * Executes DELETE req and returns response json. 154 | * 155 | * @param path 156 | * @param headers 157 | * @return 158 | */ 159 | public RestValidator delete(String path, HashMap headers) { 160 | HttpDelete delete = new HttpDelete(url + path); 161 | RestResponse resResponse = new RestResponse(); 162 | StringBuffer responseString = new StringBuffer(); 163 | try { 164 | if (headers != null) { 165 | Set keys = headers.keySet(); 166 | for (String key : keys) { 167 | delete.addHeader(key, headers.get(key)); 168 | } 169 | } 170 | HttpResponse response = client.execute(delete); 171 | BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent())); 172 | String line = ""; 173 | while ((line = rd.readLine()) != null) { 174 | responseString.append(line); 175 | } 176 | resResponse.setResponseBody(responseString.toString()); 177 | resResponse.setResponseCode(response.getStatusLine().getStatusCode()); 178 | resResponse.setResponseMessage(response.getStatusLine().getReasonPhrase()); 179 | Header[] rheaders = response.getAllHeaders(); 180 | for (Header header : rheaders) { 181 | resResponse.setHeader(header.getName(), header.getValue()); 182 | } 183 | } catch (Exception e) { 184 | e.printStackTrace(); 185 | } 186 | return new RestValidator(resResponse); 187 | } 188 | 189 | public RestValidator put(String path, String xmlContent, String contentType) { 190 | return put(path,null,xmlContent,contentType); 191 | } 192 | 193 | /** 194 | * Executes PUT req and returns response json. 195 | * 196 | * @param path 197 | * @param headers 198 | * @param xmlContent 199 | * @param contentType 200 | * @return 201 | */ 202 | public RestValidator put(String path, HashMap headers, String xmlContent, String contentType) { 203 | HttpPut post = new HttpPut(url + path); 204 | RestResponse resResponse = new RestResponse(); 205 | StringBuffer responseString = new StringBuffer(); 206 | try { 207 | if (headers != null) 208 | post.setEntity(getEntities(headers)); 209 | 210 | StringEntity input = new StringEntity(xmlContent); 211 | input.setContentType(contentType); 212 | post.setEntity(input); 213 | 214 | HttpResponse response = client.execute(post); 215 | BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent())); 216 | String line = ""; 217 | while ((line = rd.readLine()) != null) { 218 | responseString.append(line); 219 | } 220 | resResponse.setResponseBody(responseString.toString()); 221 | resResponse.setResponseCode(response.getStatusLine().getStatusCode()); 222 | resResponse.setResponseMessage(response.getStatusLine().getReasonPhrase()); 223 | Header[] rheaders = response.getAllHeaders(); 224 | for (Header header : rheaders) { 225 | resResponse.setHeader(header.getName(), header.getValue()); 226 | } 227 | } catch (Exception e) { 228 | e.printStackTrace(); // handle 229 | } 230 | return new RestValidator(resResponse); 231 | } 232 | 233 | public RestValidator patch(String path, String xmlContent, String contentType) { 234 | return patch(path,null,xmlContent,contentType); 235 | } 236 | 237 | /** 238 | * Executes PATCH req and returns response json. 239 | * 240 | * @param path 241 | * @param headers 242 | * @param xmlContent 243 | * @param contentType 244 | * @return 245 | */ 246 | public RestValidator patch(String path, HashMap headers, String xmlContent, String contentType) { 247 | HttpPatch post = new HttpPatch(url + path); 248 | RestResponse resResponse = new RestResponse(); 249 | StringBuffer responseString = new StringBuffer(); 250 | try { 251 | if (headers != null) 252 | post.setEntity(getEntities(headers)); 253 | 254 | StringEntity input = new StringEntity(xmlContent); 255 | input.setContentType(contentType); 256 | post.setEntity(input); 257 | 258 | HttpResponse response = client.execute(post); 259 | BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent())); 260 | String line = ""; 261 | while ((line = rd.readLine()) != null) { 262 | responseString.append(line); 263 | } 264 | resResponse.setResponseBody(responseString.toString()); 265 | resResponse.setResponseCode(response.getStatusLine().getStatusCode()); 266 | resResponse.setResponseMessage(response.getStatusLine().getReasonPhrase()); 267 | Header[] rheaders = response.getAllHeaders(); 268 | for (Header header : rheaders) { 269 | resResponse.setHeader(header.getName(), header.getValue()); 270 | } 271 | } catch (Exception e) { 272 | e.printStackTrace(); // handle 273 | } 274 | return new RestValidator(resResponse); 275 | } 276 | 277 | /** 278 | * Gets the hashmap turns it in HttpEntity nameValuePair. 279 | * 280 | * @param inputEntities 281 | * @return 282 | */ 283 | private HttpEntity getEntities(HashMap inputEntities) { 284 | List nameValuePairs = new ArrayList(inputEntities.size()); 285 | Set keys = inputEntities.keySet(); 286 | for (String key : keys) { 287 | nameValuePairs.add(new BasicNameValuePair(key, inputEntities.get(key))); 288 | } 289 | try { 290 | return new UrlEncodedFormEntity(nameValuePairs); 291 | } catch (Exception e) { 292 | e.printStackTrace(); 293 | } 294 | return null; 295 | } 296 | } 297 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------