├── .gitignore ├── src ├── test │ ├── resources │ │ └── logback-test.xml │ └── java │ │ └── com │ │ └── boundary │ │ └── config │ │ └── ConsulWatchedConfigurationSourceTest.java └── main │ └── java │ └── com │ └── boundary │ └── config │ └── ConsulWatchedConfigurationSource.java ├── README.md ├── pom.xml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | *.iml 3 | target/ 4 | -------------------------------------------------------------------------------- /src/test/resources/logback-test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # archaius-consul 2 | 3 | 4 | ## A [consul](https://www.consul.io/)-backed configuration source for [Archaius](https://github.com/Netflix/archaius) 5 | 6 | ### Basic Usage: 7 | 8 | ```java 9 | // setup a consul client ( see https://github.com/Ecwid/consul-api for more info) 10 | final ConsulClient client = new ConsulClient("localhost"); 11 | 12 | final String rootPath = "my-app/config"; // values will correspond to consul values stored at /v1/kv/my-app/config 13 | 14 | // create and start the configuration source 15 | final ConsulWatchedConfigurationSource configSource = new ConsulWatchedConfigurationSource(rootPath, client); 16 | configSource.startAsync(); 17 | 18 | // register the configuration source with archaius 19 | 20 | ConcurrentCompositeConfiguration finalConfig = new ConcurrentCompositeConfiguration(); 21 | finalConfig.addConfiguration(new DynamicWatchedConfiguration(configSource), "consul-dynamic"); 22 | 23 | // install / configure other archaius sources as needed 24 | 25 | ConfigurationManager.install(finalConfig); 26 | 27 | ``` 28 | 29 | ### registering callbacks 30 | 31 | To register a callback on the "example" property, an integer with default value of 2: 32 | 33 | ```java 34 | 35 | final DynamicIntProperty example = DynamicPropertyFactory.getInstance().getIntProperty("example", 2); 36 | example.addCallback(new Runnable() { 37 | @Override 38 | public void run() { 39 | System.out.println("example changed: " + example.get()); 40 | } 41 | }); 42 | ``` 43 | 44 | Now you should be able to see watched callbacks in action by updating the corresponding configuration variable: 45 | 46 | ```bash 47 | curl -X PUT -d `date +%s` localhost:8500/v1/kv/my-app/config/example 48 | ``` 49 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | com.boundary.config 6 | archaius-consul 7 | jar 8 | 0.2-SNAPSHOT 9 | 10 | archaius-consul 11 | A consul-backed configuration source for Archaius 12 | https://github.com/boundary/archaius-consul 13 | 14 | 15 | 4.2.5 16 | 17 | 18 | 19 | 20 | com.netflix.archaius 21 | archaius-core 22 | 0.6.5 23 | 24 | 25 | com.google.guava 26 | guava 27 | 28 | 29 | 30 | 31 | 32 | com.google.guava 33 | guava 34 | 18.0 35 | 36 | 37 | 38 | com.ecwid.consul 39 | consul-api 40 | 1.0.6 41 | 42 | 43 | 44 | com.google.code.gson 45 | gson 46 | 2.3 47 | 48 | 49 | 50 | org.apache.httpcomponents 51 | httpcore 52 | ${httpcomp.version} 53 | 54 | 55 | 56 | org.apache.httpcomponents 57 | httpclient 58 | ${httpcomp.version} 59 | 60 | 61 | 62 | 63 | junit 64 | junit 65 | 4.12 66 | test 67 | 68 | 69 | 70 | org.mockito 71 | mockito-core 72 | 1.10.19 73 | test 74 | 75 | 76 | 77 | com.carrotsearch.randomizedtesting 78 | randomizedtesting-runner 79 | 2.1.11 80 | test 81 | 82 | 83 | 84 | ch.qos.logback 85 | logback-classic 86 | 1.1.2 87 | test 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | org.apache.maven.plugins 97 | maven-compiler-plugin 98 | 3.1 99 | 100 | 1.7 101 | 1.7 102 | 103 | 104 | 105 | org.jacoco 106 | jacoco-maven-plugin 107 | 0.7.2.201409121644 108 | 109 | 110 | default-prepare-agent 111 | 112 | prepare-agent 113 | 114 | 115 | 116 | default-report 117 | prepare-package 118 | 119 | report 120 | 121 | 122 | 123 | 124 | 125 | 126 | org.apache.maven.plugins 127 | maven-source-plugin 128 | 2.2.1 129 | 130 | 131 | attach-sources 132 | package 133 | 134 | jar 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | scm:git:git@github.com:boundary/archaius-consul.git 144 | HEAD 145 | 146 | 147 | 148 | 149 | ecwid 150 | Ecwid 151 | http://nexus.ecwid.com/content/groups/public 152 | 153 | 154 | 155 | 156 | 157 | maven.boundary.com 158 | maven.boundary.com-releases 159 | http://maven.boundary.com/artifactory/external 160 | 161 | 162 | maven.boundary.com 163 | maven.boundary.com-snapshots 164 | http://maven.boundary.com/artifactory/external 165 | 166 | 167 | 168 | -------------------------------------------------------------------------------- /src/main/java/com/boundary/config/ConsulWatchedConfigurationSource.java: -------------------------------------------------------------------------------- 1 | package com.boundary.config; 2 | 3 | import com.ecwid.consul.v1.QueryParams; 4 | import com.ecwid.consul.v1.Response; 5 | import com.ecwid.consul.v1.kv.KeyValueClient; 6 | import com.ecwid.consul.v1.kv.model.GetValue; 7 | import com.google.common.annotations.VisibleForTesting; 8 | import com.google.common.base.Predicate; 9 | import com.google.common.collect.ImmutableMap; 10 | import com.google.common.collect.Maps; 11 | import com.google.common.collect.Sets; 12 | import com.google.common.util.concurrent.AbstractExecutionThreadService; 13 | import com.netflix.config.WatchedConfigurationSource; 14 | import com.netflix.config.WatchedUpdateListener; 15 | import com.netflix.config.WatchedUpdateResult; 16 | import org.slf4j.Logger; 17 | import org.slf4j.LoggerFactory; 18 | 19 | import java.util.List; 20 | import java.util.Map; 21 | import java.util.Set; 22 | import java.util.concurrent.CopyOnWriteArrayList; 23 | import java.util.concurrent.TimeUnit; 24 | import java.util.concurrent.atomic.AtomicLong; 25 | import java.util.concurrent.atomic.AtomicReference; 26 | 27 | import static com.google.common.base.Preconditions.checkNotNull; 28 | import static com.google.common.io.BaseEncoding.base64; 29 | 30 | /** 31 | * Implements WatchedConfigurationSource over a consul key-value store 32 | */ 33 | public class ConsulWatchedConfigurationSource extends AbstractExecutionThreadService implements WatchedConfigurationSource { 34 | 35 | private final Logger LOGGER = LoggerFactory.getLogger(ConsulWatchedConfigurationSource.class); 36 | private final String rootPath; 37 | private final KeyValueClient client; 38 | private final long watchIntervalSeconds; 39 | 40 | private final AtomicReference> lastState = new AtomicReference<>(null); 41 | private final AtomicLong latestIndex = new AtomicLong(0); 42 | 43 | private List listeners = new CopyOnWriteArrayList<>(); 44 | 45 | 46 | private Response> getRaw(QueryParams params) { 47 | return client.getKVValues(rootPath, params); 48 | } 49 | 50 | 51 | private Response> updateIndex(Response> response) { 52 | if (response != null) { 53 | this.latestIndex.set(response.getConsulIndex()); 54 | } 55 | return response; 56 | } 57 | 58 | public ConsulWatchedConfigurationSource(String rootPath, KeyValueClient client) { 59 | this(rootPath, client, 10, TimeUnit.SECONDS); 60 | } 61 | 62 | public ConsulWatchedConfigurationSource(String rootPath, KeyValueClient client, long watchInterval, TimeUnit watchIntervalUnit) { 63 | this.rootPath = checkNotNull(rootPath); 64 | this.client = checkNotNull(client); 65 | this.watchIntervalSeconds = watchIntervalUnit.toSeconds(watchInterval); 66 | } 67 | 68 | private WatchedUpdateResult incrementalResult( 69 | final ImmutableMap newState, 70 | final ImmutableMap previousState) { 71 | 72 | final Map added = Maps.newHashMap(); 73 | final Map removed = Maps.newHashMap(); 74 | final Map changed = Maps.newHashMap(); 75 | 76 | // added 77 | addAllKeys( 78 | Sets.difference(newState.keySet(), previousState.keySet()), 79 | newState, added 80 | 81 | ); 82 | 83 | // removed 84 | addAllKeys( 85 | Sets.difference(previousState.keySet(), newState.keySet()), 86 | previousState, removed 87 | 88 | ); 89 | 90 | // changed 91 | addFilteredKeys( 92 | Sets.intersection(previousState.keySet(), newState.keySet()), 93 | newState, changed, 94 | new Predicate() { 95 | @Override 96 | public boolean apply(String key) { 97 | return !previousState.get(key).equals(newState.get(key)); 98 | } 99 | } 100 | ); 101 | return WatchedUpdateResult.createIncremental(added, changed, removed); 102 | } 103 | 104 | private void addAllKeys(Set keys, ImmutableMap source, Map dest) { 105 | addFilteredKeys(keys, source, dest, new Predicate() { 106 | @Override 107 | public boolean apply(String input) { 108 | return true; 109 | } 110 | }); 111 | } 112 | 113 | private void addFilteredKeys(Set keys, ImmutableMap source, Map dest, Predicate filter) { 114 | 115 | for (String key: keys) { 116 | if (filter.apply(key)) { 117 | dest.put(key, source.get(key)); 118 | } 119 | } 120 | 121 | } 122 | 123 | protected void fireEvent(WatchedUpdateResult result) { 124 | for (WatchedUpdateListener l : listeners) { 125 | try { 126 | l.updateConfiguration(result); 127 | } catch (Throwable ex) { 128 | LOGGER.error("Error invoking WatchedUpdateListener", ex); 129 | } 130 | } 131 | } 132 | 133 | @Override 134 | public void addUpdateListener(WatchedUpdateListener l) { 135 | if (l != null) { 136 | listeners.add(l); 137 | } 138 | } 139 | 140 | @Override 141 | public void removeUpdateListener(WatchedUpdateListener l) { 142 | if (l != null) { 143 | listeners.remove(l); 144 | } 145 | } 146 | 147 | @Override 148 | public Map getCurrentData() throws Exception { 149 | return lastState.get(); 150 | } 151 | 152 | 153 | @VisibleForTesting 154 | protected long getLatestIndex() { 155 | return latestIndex.get(); 156 | } 157 | 158 | private ImmutableMap convertToMap(Response> kv) { 159 | if (kv == null || kv.getValue() == null) { 160 | return ImmutableMap.of(); 161 | } 162 | ImmutableMap.Builder builder = ImmutableMap.builder(); 163 | for(GetValue gv : kv.getValue()) { 164 | builder.put(keyFunc(gv), valFunc(gv)); 165 | } 166 | return builder.build(); 167 | } 168 | 169 | private Object valFunc(GetValue getValue) { 170 | return new String(base64().decode(getValue.getValue())).trim(); 171 | } 172 | 173 | private String keyFunc(GetValue getValue) { 174 | return getValue.getKey().substring(rootPath.length() + 1); 175 | } 176 | 177 | @Override 178 | protected void run() throws Exception { 179 | while (isRunning()) { 180 | runOnce(); 181 | } 182 | 183 | } 184 | 185 | @VisibleForTesting 186 | protected void runOnce() { 187 | try { 188 | Response> kvals = updateIndex(getRaw(watchParams())); 189 | ImmutableMap full = convertToMap(kvals); 190 | final WatchedUpdateResult result; 191 | if (lastState.get() == null) { 192 | result = WatchedUpdateResult.createFull(full); 193 | } else { 194 | result = incrementalResult(full, lastState.get()); 195 | } 196 | lastState.set(full); 197 | fireEvent(result); 198 | } catch (Exception e) { 199 | LOGGER.error("Error watching path", e); 200 | } 201 | } 202 | 203 | private QueryParams watchParams() { 204 | return new QueryParams(watchIntervalSeconds, latestIndex.get()); 205 | } 206 | 207 | } 208 | -------------------------------------------------------------------------------- /src/test/java/com/boundary/config/ConsulWatchedConfigurationSourceTest.java: -------------------------------------------------------------------------------- 1 | package com.boundary.config; 2 | 3 | import com.carrotsearch.randomizedtesting.RandomizedTest; 4 | import com.carrotsearch.randomizedtesting.annotations.Repeat; 5 | import com.ecwid.consul.v1.QueryParams; 6 | import com.ecwid.consul.v1.Response; 7 | import com.ecwid.consul.v1.kv.KeyValueClient; 8 | import com.ecwid.consul.v1.kv.model.GetValue; 9 | import com.google.common.collect.Lists; 10 | import com.netflix.config.WatchedUpdateListener; 11 | import com.netflix.config.WatchedUpdateResult; 12 | import org.junit.Before; 13 | import org.junit.Test; 14 | 15 | import java.util.ArrayList; 16 | import java.util.List; 17 | import java.util.Map; 18 | import java.util.concurrent.CopyOnWriteArrayList; 19 | import java.util.concurrent.TimeUnit; 20 | import java.util.concurrent.atomic.AtomicInteger; 21 | 22 | import static com.google.common.io.BaseEncoding.base64; 23 | import static org.hamcrest.CoreMatchers.endsWith; 24 | import static org.hamcrest.CoreMatchers.hasItem; 25 | import static org.hamcrest.CoreMatchers.is; 26 | import static org.hamcrest.CoreMatchers.not; 27 | import static org.hamcrest.CoreMatchers.nullValue; 28 | import static org.mockito.Matchers.any; 29 | import static org.mockito.Matchers.eq; 30 | import static org.mockito.Mockito.mock; 31 | import static org.mockito.Mockito.when; 32 | 33 | public class ConsulWatchedConfigurationSourceTest extends RandomizedTest { 34 | 35 | 36 | private KeyValueClient client = mock(KeyValueClient.class); 37 | private String rootPath = "my-app/config"; 38 | private int watchInterval = 10; 39 | private ConsulWatchedConfigurationSource configSource; 40 | 41 | @Before 42 | public void setUp() { 43 | configSource = new ConsulWatchedConfigurationSource(rootPath, client, watchInterval, TimeUnit.SECONDS); 44 | 45 | } 46 | 47 | @Test 48 | @Repeat(iterations = 5) 49 | public void testInitialRun() throws Exception { 50 | 51 | 52 | final Response> expected = randomListGetValueResponse(); 53 | 54 | when(client.getKVValues(eq(rootPath), any(QueryParams.class))).thenReturn(expected); 55 | 56 | assertThat(configSource.getCurrentData(), nullValue()); 57 | 58 | UpdateListener listener = new UpdateListener(); 59 | configSource.addUpdateListener(listener); 60 | 61 | 62 | configSource.runOnce(); 63 | 64 | Map currentData = configSource.getCurrentData(); 65 | 66 | for(GetValue gv: expected.getValue()) { 67 | assertThat(decodeVal(gv.getValue()), endsWith((String) currentData.get(decodeKey(gv.getKey())))); 68 | } 69 | 70 | assertThat(configSource.getLatestIndex(), is(expected.getConsulIndex())); 71 | 72 | assertThat(listener.events.get(), is(1)); 73 | assertThat(listener.results.get(0).getComplete(), is(currentData)); 74 | assertThat(listener.results.get(0).isIncremental(), is(false)); 75 | 76 | } 77 | 78 | @Test 79 | @Repeat(iterations = 5) 80 | public void testAdded() throws Exception { 81 | 82 | final Response> initialResponse = randomListGetValueResponse(); 83 | final GetValue added = randomGetVal(); 84 | final List updatedList = Lists.newArrayList(initialResponse.getValue()); 85 | updatedList.add(added); 86 | final Response> initialResponsePlus = randomResponse(updatedList); 87 | //noinspection unchecked 88 | when(client.getKVValues(eq(rootPath), any(QueryParams.class))).thenReturn(initialResponse, initialResponsePlus); 89 | 90 | UpdateListener listener = new UpdateListener(); 91 | configSource.addUpdateListener(listener); 92 | 93 | configSource.runOnce(); 94 | 95 | assertThat(configSource.getLatestIndex(), is(initialResponse.getConsulIndex())); 96 | 97 | configSource.runOnce(); 98 | 99 | assertThat(configSource.getLatestIndex(), is(initialResponsePlus.getConsulIndex())); 100 | assertThat(listener.events.get(), is(2)); 101 | assertThat(configSource.getCurrentData().values(), hasItem(decodeVal(added.getValue()))); 102 | 103 | WatchedUpdateResult result = listener.results.get(1); 104 | assertThat(result.getAdded().values(), hasItem(decodeVal(added.getValue()))); 105 | assertThat(result.getDeleted().isEmpty(), is(true)); 106 | assertThat(result.getChanged().isEmpty(), is(true)); 107 | assertThat(result.isIncremental(), is(true)); 108 | 109 | 110 | } 111 | 112 | 113 | @Test 114 | @Repeat(iterations = 5) 115 | public void testRemoved() throws Exception { 116 | 117 | final Response> initialResponse = randomListGetValueResponse(); 118 | final GetValue removed = initialResponse.getValue().get(randomInt(initialResponse.getValue().size() -1)); 119 | final List updatedList = Lists.newArrayList(initialResponse.getValue()); 120 | updatedList.remove(removed); 121 | final Response> initialResponseMinus = randomResponse(updatedList); 122 | //noinspection unchecked 123 | when(client.getKVValues(eq(rootPath), any(QueryParams.class))).thenReturn(initialResponse, initialResponseMinus); 124 | 125 | UpdateListener listener = new UpdateListener(); 126 | configSource.addUpdateListener(listener); 127 | 128 | 129 | configSource.runOnce(); 130 | 131 | assertThat(configSource.getLatestIndex(), is(initialResponse.getConsulIndex())); 132 | 133 | configSource.runOnce(); 134 | 135 | assertThat(configSource.getLatestIndex(), is(initialResponseMinus.getConsulIndex())); 136 | assertThat(listener.events.get(), is(2)); 137 | assertThat(configSource.getCurrentData().values(), not(hasItem(decodeVal(removed.getValue())))); 138 | 139 | WatchedUpdateResult result = listener.results.get(1); 140 | assertThat(result.getDeleted().values(), hasItem(decodeVal(removed.getValue()))); 141 | assertThat(result.getAdded().isEmpty(), is(true)); 142 | assertThat(result.getChanged().isEmpty(), is(true)); 143 | assertThat(result.isIncremental(), is(true)); 144 | 145 | 146 | } 147 | 148 | 149 | @Test 150 | @Repeat(iterations = 5) 151 | public void testChanged() throws Exception { 152 | 153 | final Response> initialResponse = randomListGetValueResponse(); 154 | 155 | final List updatedList = new ArrayList<>(initialResponse.getValue()); 156 | final GetValue toChange = updatedList.remove(randomInt(updatedList.size() - 1)); 157 | 158 | final GetValue changed = randomGetVal(); 159 | changed.setKey(toChange.getKey()); 160 | 161 | updatedList.add(changed); 162 | 163 | final Response> initialResponseChanged = randomResponse(updatedList); 164 | //noinspection unchecked 165 | when(client.getKVValues(eq(rootPath), any(QueryParams.class))).thenReturn(initialResponse, initialResponseChanged); 166 | 167 | UpdateListener listener = new UpdateListener(); 168 | configSource.addUpdateListener(listener); 169 | 170 | 171 | configSource.runOnce(); 172 | 173 | assertThat(configSource.getLatestIndex(), is(initialResponse.getConsulIndex())); 174 | 175 | configSource.runOnce(); 176 | 177 | assertThat(configSource.getLatestIndex(), is(initialResponseChanged.getConsulIndex())); 178 | assertThat(listener.events.get(), is(2)); 179 | assertThat(configSource.getCurrentData().values(), hasItem(decodeVal(changed.getValue()))); 180 | WatchedUpdateResult result = listener.results.get(1); 181 | 182 | assertThat(result.getChanged().values(), hasItem(decodeVal(changed.getValue()))); 183 | assertThat(result.getAdded().isEmpty(), is(true)); 184 | assertThat(result.getDeleted().isEmpty(), is(true)); 185 | assertThat(result.isIncremental(), is(true)); 186 | 187 | } 188 | private String decodeKey(String key) { 189 | return key.substring(rootPath.length() + 1); 190 | } 191 | 192 | private String decodeVal(String value) { 193 | return new String(base64().decode(value)).trim(); 194 | } 195 | 196 | 197 | private Response> randomListGetValueResponse() { 198 | return randomResponse(randomListGetValue()); 199 | } 200 | 201 | private Response randomResponse(T val) { 202 | return new Response<>(val, randomLong(), true, System.currentTimeMillis()); 203 | } 204 | 205 | private List randomListGetValue() { 206 | List list = new ArrayList<>(); 207 | for (int i = 0; i < randomIntBetween(1, 5); i++) { 208 | list.add(randomGetVal()); 209 | } 210 | return list; 211 | } 212 | 213 | private GetValue randomGetVal() { 214 | final GetValue gv = new GetValue(); 215 | gv.setCreateIndex(randomInt(100)); 216 | gv.setKey( rootPath + "/" + randomAsciiOfLength(10)); 217 | gv.setValue( randomAsciiOfLength(10)); 218 | gv.setModifyIndex(randomInt(100)); 219 | return gv; 220 | } 221 | 222 | private static class UpdateListener implements WatchedUpdateListener { 223 | 224 | CopyOnWriteArrayList results = new CopyOnWriteArrayList<>(); 225 | AtomicInteger events = new AtomicInteger(0); 226 | 227 | @Override 228 | public void updateConfiguration(WatchedUpdateResult result) { 229 | results.add(result); 230 | events.incrementAndGet(); 231 | } 232 | } 233 | 234 | } -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------