├── commons-dbcp-1.4-monitored.jar ├── screenshots ├── combined-graph.png └── threads-using-connections.png ├── patch-for-commons-dbcp-1.4-src ├── lib │ ├── junit-3.8.1.jar │ ├── junit-3.8.2.jar │ ├── commons-pool-1.3.jar │ ├── jdbc2_0-stdext.jar │ ├── xercesImpl-2.4.0.jar │ ├── commons-dbcp-1.2.2.jar │ ├── commons-pool-1.5.4.jar │ ├── naming-java-5.0.28.jar │ ├── commons-logging-1.0.4.jar │ ├── commons-logging-1.1.1.jar │ ├── naming-common-5.0.28.jar │ ├── geronimo-ejb_2.1_spec-1.1.jar │ ├── geronimo-jta_1.1_spec-1.1.jar │ ├── backport-util-concurrent-2.2.jar │ └── geronimo-transaction-1.2-beta.jar ├── build.properties └── src │ └── java │ └── org │ └── apache │ └── commons │ └── dbcp │ └── AbandonedObjectPool.java ├── README.md ├── generate-dbcp-graph.sh └── LICENSE.txt /commons-dbcp-1.4-monitored.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/commons-dbcp-1.4-monitored.jar -------------------------------------------------------------------------------- /screenshots/combined-graph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/screenshots/combined-graph.png -------------------------------------------------------------------------------- /screenshots/threads-using-connections.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/screenshots/threads-using-connections.png -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/junit-3.8.1.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/junit-3.8.1.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/junit-3.8.2.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/junit-3.8.2.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/commons-pool-1.3.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/commons-pool-1.3.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/jdbc2_0-stdext.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/jdbc2_0-stdext.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/xercesImpl-2.4.0.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/xercesImpl-2.4.0.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/commons-dbcp-1.2.2.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/commons-dbcp-1.2.2.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/commons-pool-1.5.4.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/commons-pool-1.5.4.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/naming-java-5.0.28.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/naming-java-5.0.28.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/commons-logging-1.0.4.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/commons-logging-1.0.4.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/commons-logging-1.1.1.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/commons-logging-1.1.1.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/naming-common-5.0.28.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/naming-common-5.0.28.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/geronimo-ejb_2.1_spec-1.1.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/geronimo-ejb_2.1_spec-1.1.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/geronimo-jta_1.1_spec-1.1.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/geronimo-jta_1.1_spec-1.1.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/backport-util-concurrent-2.2.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/backport-util-concurrent-2.2.jar -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/lib/geronimo-transaction-1.2-beta.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicolas-raoul/Commons-DBCP-monitoring/HEAD/patch-for-commons-dbcp-1.4-src/lib/geronimo-transaction-1.2-beta.jar -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Commons-DBCP-monitoring 2 | ======================= 3 | 4 | Monitor what threads are using connections from the DBCP pool, and waiting for connection. Generate a nice table to understand what is happening. 5 | 6 | Usage: 7 | 8 | 1. Replace your application's `commons-dbcp-1.4.jar` with [commons-dbcp-1.4-monitored.jar](https://github.com/nicolas-raoul/Commons-DBCP-monitoring/raw/master/commons-dbcp-1.4-monitored.jar) (rename it to pretend it is really the same JAR file) 9 | 2. Run your application, making sure the output is directed to a log file 10 | 3. When you want, generate a graph: 11 | 1. Run: `./generate-dbcp-graph.sh ` 12 | 2. Wait while `dbcp-connected-by-thread.csv` and `dbcp-waiting-by-thread.csv` are generated. 13 | 3. Open the CSV files with any spreadsheet program (like LibreOffice) and use conditional formatting to end up with the table below. To create the graph below, create a `SUM` column for each CSV and use your spreadsheet program's graphing feature. 14 | 15 | ![Threads using connections](https://raw.github.com/nicolas-raoul/Commons-DBCP-monitoring/master/screenshots/threads-using-connections.png) 16 | ![Combined using/waiting graph](https://raw.github.com/nicolas-raoul/Commons-DBCP-monitoring/master/screenshots/combined-graph.png) 17 | 18 | --- 19 | 20 | Compilation: 21 | 22 | 1. Download the [Commons DBCP 1.4 source code](http://ftp.jaist.ac.jp/pub/apache//commons/dbcp/source/commons-dbcp-1.4-src.tar.gz) 23 | 2. Uncompress it. 24 | 3. Copy all files from the `patch-for-commons-dbcp-1.4-src` directory to into the uncompressed directory 25 | 4. Run Ant 26 | 27 | This product includes software developed by 28 | The Apache Software Foundation (http://www.apache.org/). 29 | -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/build.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one or more 2 | # contributor license agreements. See the NOTICE file distributed with 3 | # this work for additional information regarding copyright ownership. 4 | # The ASF licenses this file to You under the Apache License, Version 2.0 5 | # (the "License"); you may not use this file except in compliance with 6 | # the License. You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | ########################################################################## 16 | # Sample Ant build.properties file 17 | # 18 | # This setup assumes dependent jars are in a local maven 2 repository. 19 | # However the jars are located, the properties ending in ".jar" need to 20 | # expand to full paths to the jars. 21 | ########################################################################## 22 | 23 | # Repository base path 24 | repository=${user.home}/.m2/repository 25 | 26 | # commons-pool.jar - path to commons-pool-1.5.4.jar 27 | commons-pool.home=${repository}/commons-pool/commons-pool/1.5.4 28 | commons-pool.jar=lib/commons-pool-1.5.4.jar 29 | 30 | # JUnit 31 | junit.home=${repository}/junit/junit/3.8.2 32 | junit.jar=lib/junit-3.8.2.jar 33 | 34 | # XML parser 35 | xerces.home=${repository}/xerces/xercesImpl/2.4.0 36 | xerces.jar=lib/xercesImpl-2.4.0.jar 37 | 38 | # Tomcat naming jars - needed only for JNDI tests 39 | naming.common.home=${repository}/tomcat/naming-common/5.0.28 40 | naming-common.jar=lib/naming-common-5.0.28.jar 41 | naming.java.home=${repository}/tomcat/naming-java/5.0.28 42 | naming-java.jar=lib/naming-java-5.0.28.jar 43 | 44 | # Commons logging - dependency of naming jars 45 | commons-logging.home=${repository}/commons-logging/commons-logging/1.1.1 46 | commons-logging.jar=lib/commons-logging-1.1.1.jar 47 | 48 | # JTA - needed for managed connections 49 | jta-spec.jar=lib/geronimo-jta_1.1_spec-1.1.jar 50 | jta-impl.jar=lib/geronimo-transaction-1.2-beta.jar 51 | 52 | # JTA dependencies - required so the test cases run 53 | backport-util-concurrent.jar=lib/backport-util-concurrent-2.2.jar 54 | ejb-spec.jar=lib/geronimo-ejb_2.1_spec-1.1.jar 55 | -------------------------------------------------------------------------------- /generate-dbcp-graph.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Write the history of DBCP connections, how many connections each thread holds at each point in time. 4 | # To be used with the output of a Java app that uses commons-dbcp-1.4-monitored 5 | # 6 | # Author: Nicolas Raoul 7 | # License: GNU-GPLv3 8 | # 9 | # Usage: ./generate-dbcp-graph.sh 10 | 11 | INPUT=${1:-catalina.out} 12 | OUTPUT_CONNECTED=dbcp-connected-by-thread.csv 13 | OUTPUT_WAITING=dbcp-waiting-by-thread.csv 14 | ACCESSES=/tmp/accesses 15 | 16 | # First-pass: Get the list of thread names 17 | echo "First pass" 18 | grep "^DBCPMONITOR" $INPUT \ 19 | | egrep "AbandonnedObjectPool.borrowObject|AbandonnedObjectPool.returnObject" \ 20 | > $ACCESSES 21 | THREADS=`sed -e "s/;[^;]*$//g" -e "s/.*;//g" $ACCESSES | sort -Vu` 22 | echo "Threads:" 23 | echo $THREADS 24 | echo "" 25 | 26 | # Initialize array of thread states, and write CSV column headers 27 | THREADSTATES_CONNECTED=() 28 | THREADSTATES_WAITING=() 29 | echo -n "Timestamp;" > $OUTPUT_CONNECTED 30 | for THREAD in $THREADS; do 31 | THREADSTATES_CONNECTED+=("$THREAD:0") 32 | THREADSTATES_WAITING+=("$THREAD:0") 33 | echo -n "$THREAD;" >> $OUTPUT_CONNECTED 34 | done 35 | echo "" >> $OUTPUT_CONNECTED 36 | cp $OUTPUT_CONNECTED $OUTPUT_WAITING 37 | 38 | 39 | # Second-pass: Line of status for each time 40 | echo "Second pass" 41 | cat $ACCESSES | while read LINE; do 42 | TIME=`echo $LINE | sed -e "s/DBCPMONITOR;[^;]*;[^;]*;[^;]*;//g" -e "s/;.*//g"` 43 | THREAD=`echo $LINE | sed -e "s/;[^;]*$//g" -e "s/.*;//g"` 44 | ACTION_CONNECTED=`echo $LINE | sed -e "s/DBCPMONITOR;//g" -e "s/;.*//g"` 45 | ACTION_WAITING=`echo $LINE | sed -e "s/DBCPMONITOR;[^;]*;//g" -e "s/;.*//g"` 46 | echo "Modifying state of thread $THREAD with actions connected:$ACTION_CONNECTED waiting:$ACTION_WAITING" 47 | # Look for index of this thread 48 | for ((i=0; i<${#THREADSTATES_CONNECTED[*]}; i++)); do 49 | [[ ${THREADSTATES_CONNECTED[i]} = $THREAD:* ]] && break 50 | done 51 | PREVIOUS_STATE=${THREADSTATES_CONNECTED[i]##*:} 52 | NEW_STATE=$(($PREVIOUS_STATE+$ACTION_CONNECTED)) 53 | #echo "PREVIOUS_STATE=$PREVIOUS_STATE, NEW_STATE=$NEW_STATE" 54 | THREADSTATES_CONNECTED[i]=$THREAD:$NEW_STATE 55 | PREVIOUS_STATE=${THREADSTATES_WAITING[i]##*:} 56 | NEW_STATE=$(($PREVIOUS_STATE+$ACTION_WAITING)) 57 | #echo "PREVIOUS_STATE=$PREVIOUS_STATE, NEW_STATE=$NEW_STATE" 58 | THREADSTATES_WAITING[i]=$THREAD:$NEW_STATE 59 | 60 | # Write to output 61 | echo -n "$TIME;" >> $OUTPUT_CONNECTED 62 | echo -n "$TIME;" >> $OUTPUT_WAITING 63 | for THREADSTATE in ${THREADSTATES_CONNECTED[@]} ; do 64 | THREAD=${THREADSTATE%%:*} 65 | STATE=${THREADSTATE##*:} 66 | echo -n "$STATE;" >> $OUTPUT_CONNECTED 67 | #printf "Thread %s is in state %s.\n" $THREAD $STATE 68 | done 69 | for THREADSTATE in ${THREADSTATES_WAITING[@]} ; do 70 | THREAD=${THREADSTATE%%:*} 71 | STATE=${THREADSTATE##*:} 72 | echo -n "$STATE;" >> $OUTPUT_WAITING 73 | #printf "Thread %s is in state %s.\n" $THREAD $STATE 74 | done 75 | echo "" >> $OUTPUT_CONNECTED 76 | echo "" >> $OUTPUT_WAITING 77 | done 78 | -------------------------------------------------------------------------------- /patch-for-commons-dbcp-1.4-src/src/java/org/apache/commons/dbcp/AbandonedObjectPool.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.dbcp; 19 | 20 | import java.util.ArrayList; 21 | import java.util.Arrays; 22 | import java.util.Date; 23 | import java.util.Iterator; 24 | import java.util.List; 25 | 26 | import org.apache.commons.pool.PoolableObjectFactory; 27 | import org.apache.commons.pool.impl.GenericObjectPool; 28 | 29 | /** 30 | *

An implementation of a Jakarta-Commons ObjectPool which 31 | * tracks JDBC connections and can recover abandoned db connections. 32 | * If logAbandoned=true, a stack trace will be printed for any 33 | * abandoned db connections recovered. 34 | * 35 | * @author Glenn L. Nielsen 36 | * @version $Revision: 899987 $ $Date: 2010-01-16 11:51:16 -0500 (Sat, 16 Jan 2010) $ 37 | */ 38 | public class AbandonedObjectPool extends GenericObjectPool { 39 | 40 | /** 41 | * DBCP AbandonedConfig 42 | */ 43 | private final AbandonedConfig config; 44 | 45 | /** 46 | * A list of connections in use 47 | */ 48 | private final List trace = new ArrayList(); 49 | 50 | /** 51 | * Create an ObjectPool which tracks db connections. 52 | * 53 | * @param factory PoolableObjectFactory used to create this 54 | * @param config configuration for abandoned db connections 55 | */ 56 | public AbandonedObjectPool(PoolableObjectFactory factory, 57 | AbandonedConfig config) { 58 | super(factory); 59 | this.config = config; 60 | } 61 | 62 | /** 63 | * Get a db connection from the pool. 64 | * 65 | * If removeAbandoned=true, recovers db connections which 66 | * have been idle > removeAbandonedTimeout and 67 | * getNumActive() > getMaxActive() - 3 and 68 | * getNumIdle() < 2 69 | * 70 | * @return Object jdbc Connection 71 | * @throws Exception if an exception occurs retrieving a 72 | * connection from the pool 73 | */ 74 | public Object borrowObject() throws Exception { 75 | 76 | // DBCP monitoring 77 | String time = new Date().toString(); 78 | String id = Thread.currentThread().getName(); 79 | String stack = Arrays.toString(new Exception().getStackTrace()); 80 | System.out.println("DBCPMONITOR;+0;+1;AbandonnedObjectPool.borrowObject#first;" + time + ";" + id + ";" + stack); 81 | 82 | if (config != null 83 | && config.getRemoveAbandoned() 84 | && (getNumIdle() < 2) 85 | && (getNumActive() > getMaxActive() - 3) ) { 86 | removeAbandoned(); 87 | } 88 | Object obj = super.borrowObject(); 89 | if (obj instanceof AbandonedTrace) { 90 | ((AbandonedTrace) obj).setStackTrace(); 91 | } 92 | if (obj != null && config != null && config.getRemoveAbandoned()) { 93 | synchronized (trace) { 94 | trace.add(obj); 95 | } 96 | } 97 | 98 | // DBCP monitoring 99 | time = new Date().toString(); 100 | id = Thread.currentThread().getName(); 101 | stack = Arrays.toString(new Exception().getStackTrace()); 102 | System.out.println("DBCPMONITOR;+1;-1;AbandonnedObjectPool.borrowObject#last;" + time + ";" + id + ";" + stack); 103 | 104 | return obj; 105 | } 106 | 107 | /** 108 | * Return a db connection to the pool. 109 | * 110 | * @param obj db Connection to return 111 | * @throws Exception if an exception occurs returning the connection 112 | * to the pool 113 | */ 114 | public void returnObject(Object obj) throws Exception { 115 | 116 | // DBCP monitoring 117 | String time = new Date().toString(); 118 | String id = Thread.currentThread().getName(); 119 | String stack = Arrays.toString(new Exception().getStackTrace()); 120 | System.out.println("DBCPMONITOR;-1;+0;AbandonnedObjectPool.returnObject;" + time + ";" + id + ";" + stack); 121 | 122 | if (config != null && config.getRemoveAbandoned()) { 123 | synchronized (trace) { 124 | boolean foundObject = trace.remove(obj); 125 | if (!foundObject) { 126 | return; // This connection has already been invalidated. Stop now. 127 | } 128 | } 129 | } 130 | super.returnObject(obj); 131 | } 132 | 133 | /** 134 | * Invalidates an object from the pool. 135 | * 136 | * @param obj object to be returned 137 | * @throws Exception if an exception occurs invalidating the object 138 | */ 139 | public void invalidateObject(Object obj) throws Exception { 140 | 141 | // DBCP monitoring 142 | String time = new Date().toString(); 143 | String id = Thread.currentThread().getName(); 144 | String stack = Arrays.toString(new Exception().getStackTrace()); 145 | System.out.println("DBCPMONITOR;-1;+0;AbandonnedObjectPool.invalidateObject;" + time + ";" + id + ";" + stack); 146 | 147 | if (config != null && config.getRemoveAbandoned()) { 148 | synchronized (trace) { 149 | boolean foundObject = trace.remove(obj); 150 | if (!foundObject) { 151 | return; // This connection has already been invalidated. Stop now. 152 | } 153 | } 154 | } 155 | super.invalidateObject(obj); 156 | } 157 | 158 | /** 159 | * Recover abandoned db connections which have been idle 160 | * greater than the removeAbandonedTimeout. 161 | */ 162 | private void removeAbandoned() { 163 | // Generate a list of abandoned connections to remove 164 | long now = System.currentTimeMillis(); 165 | long timeout = now - (config.getRemoveAbandonedTimeout() * 1000); 166 | ArrayList remove = new ArrayList(); 167 | synchronized (trace) { 168 | Iterator it = trace.iterator(); 169 | while (it.hasNext()) { 170 | AbandonedTrace pc = (AbandonedTrace) it.next(); 171 | if (pc.getLastUsed() > timeout) { 172 | continue; 173 | } 174 | if (pc.getLastUsed() > 0) { 175 | remove.add(pc); 176 | } 177 | } 178 | } 179 | 180 | // Now remove the abandoned connections 181 | Iterator it = remove.iterator(); 182 | while (it.hasNext()) { 183 | AbandonedTrace pc = (AbandonedTrace) it.next(); 184 | if (config.getLogAbandoned()) { 185 | pc.printStackTrace(); 186 | } 187 | try { 188 | invalidateObject(pc); 189 | } catch (Exception e) { 190 | e.printStackTrace(); 191 | } 192 | 193 | } 194 | } 195 | } 196 | 197 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------