├── .gitignore ├── docs └── logo.png ├── elwha-api ├── src │ └── main │ │ └── pegasus │ │ └── gov │ │ └── nasa │ │ └── jpl │ │ └── memex │ │ └── elwha │ │ └── Elwha.pdsc ├── build.gradle └── Tweet.pdsc ├── gradle.properties ├── settings.gradle ├── elwha-server ├── gradle.properties ├── build.gradle └── src │ └── main │ ├── webapp │ └── WEB-INF │ │ └── web.xml │ ├── resources │ └── twitter4j.properties │ └── java │ └── gov │ └── nasa │ └── jpl │ └── memex │ └── elwha │ └── impl │ └── ElwhaResource.java ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle/ 2 | build/ 3 | mainGeneratedDataTemplate/ 4 | -------------------------------------------------------------------------------- /docs/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nasa-jpl-memex/elwha/HEAD/docs/logo.png -------------------------------------------------------------------------------- /elwha-api/src/main/pegasus/gov/nasa/jpl/memex/elwha/Elwha.pdsc: -------------------------------------------------------------------------------- 1 | { 2 | "type": "record", 3 | "name": "Elwha", 4 | "namespace": "gov.nasa.jpl.memex.elwha", 5 | "doc": "Elwha data schema", 6 | "fields": [ 7 | { 8 | "name": "userIds", 9 | "type": "string", 10 | "doc": "A string of comma separated user ids. track(comma separated filter terms)" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /gradle.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 | pegasusVersion=1.15.4 17 | -------------------------------------------------------------------------------- /elwha-api/build.gradle: -------------------------------------------------------------------------------- 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 | apply plugin: 'pegasus' 17 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 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 | include 'elwha-api' 17 | include 'elwha-server' 18 | -------------------------------------------------------------------------------- /elwha-server/gradle.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 | # Normally, the pegasus gradle plugins check to make sure there have 17 | # been no incompatible changes to restspec files before publishing them 18 | # to the api directory. Shut this behavior off for this example to 19 | # avoid confusion and extra steps. 20 | 21 | rest.model.compatibility=ignore -------------------------------------------------------------------------------- /elwha-server/build.gradle: -------------------------------------------------------------------------------- 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 | apply plugin: 'war' 17 | apply plugin: 'pegasus' 18 | apply plugin: 'java' 19 | 20 | ext.apiProject = project(':elwha-api') 21 | dependencies { 22 | compile project(path: ':elwha-api', configuration: 'dataTemplate') 23 | compile spec.product.pegasus.restliServer 24 | } 25 | 26 | // Below is only used for running jetty from within gradle for demo purposes 27 | // e.g. 'gradle JettyRunWar'. 28 | 29 | configurations { 30 | jetty8 31 | compile 32 | } 33 | 34 | dependencies { 35 | jetty8 "org.mortbay.jetty:jetty-runner:8.1.15.v20140411" 36 | compile "org.twitter4j:twitter4j-core:4.0.4" 37 | compile "org.twitter4j:twitter4j-stream:4.0.4" 38 | compile "org.twitter4j:twitter4j-async:4.0.4" 39 | } 40 | 41 | task JettyRunWar(type: JavaExec) { 42 | main = "org.mortbay.jetty.runner.Runner" 43 | args = [war.archivePath] 44 | classpath configurations.jetty8 45 | } 46 | -------------------------------------------------------------------------------- /elwha-server/src/main/webapp/WEB-INF/web.xml: -------------------------------------------------------------------------------- 1 | 2 | 18 | 19 | 22 | Elwha Web Application 23 | 24 | 25 | 26 | 27 | ElwhaServlet 28 | com.linkedin.restli.server.RestliServlet 29 | true 30 | 31 | resourcePackages 32 | gov.nasa.jpl.memex.elwha.impl 33 | 34 | 35 | parseqThreadPoolSize 36 | 10 37 | 38 | 1 39 | 40 | 41 | 42 | 43 | ElwhaServlet 44 | /elwha-server/* 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Elwha 2 | ====== 3 | 4 | 5 | 6 | # Introduction 7 | Elwha is a Java application for monitoring topics, sentiment and events on Twitter streams 8 | with the ability to generate notification messages before passing the presence of such 9 | events on to some additional workflow. An example of an additional workflow could be 10 | an [Apache Nutch](http://nutch.apache.org) crawl, or something similar. 11 | 12 | The name Elwha itself relates to the [River Elwha](https://en.wikipedia.org/wiki/Elwha_River), a 13 | 45-mile (72 km) river on the Olympic Peninsula in the U.S. state of Washington. From its source 14 | at Elwha snowfinger in the Olympic Range of Olympic National Park, it flows generally north to 15 | the Strait of Juan de Fuca. Most of the river is in Olympic National Park. 16 | 17 | # Twitter OAuth Credentials 18 | 19 | You will need to setup application credentials so you can use this applications. You can read more about token generation in [Twitter's Documentation](https://dev.twitter.com/oauth/overview/application-owner-access-tokens). After you have followed the instructions and generated your consumer and access keys be sure to update the [twitter4j.properties](https://github.com/MJJoyce/elwha/blob/master/elwha-server/src/main/resources/twitter4j.properties) file with this information. You may need to rebuild after making these changes before they take effect. 20 | 21 | # Build, Installation and Usage 22 | 23 | This is a rest.li application using gradle as the build system. 24 | 25 | To build for the first time, use gradle 1.8 or greater and run: 26 | 27 | ``` 28 | gradle build 29 | ``` 30 | 31 | You can then run the server with: 32 | 33 | `gradle JettyRunWar` 34 | 35 | Once running, you can send a GET request to the server with: 36 | 37 | `curl http://localhost:8080/elwha-server/elwha/1` 38 | 39 | # Features 40 | 41 | # License 42 | Elwha is licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). 43 | A copy of that license is included with this source code. 44 | -------------------------------------------------------------------------------- /elwha-server/src/main/resources/twitter4j.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 | # For more information on configuration properties see 17 | # http://twitter4j.org/en/configuration.html 18 | 19 | #Misc. 20 | debug=true 21 | debug=false 22 | includeRTs=true 23 | includeEntities=true 24 | includeMyRetweet=true 25 | jsonStoreEnabled=false 26 | mbeanEnabled=false 27 | loggerFactory=twitter4j.SLF4JLoggerFactory 28 | #contributingTo= 29 | 30 | #OAuth 31 | oauth.consumerKey=********************* 32 | oauth.consumerSecret=****************************************** 33 | oauth.accessToken=************************************************** 34 | oauth.accessTokenSecret=****************************************** 35 | 36 | #Basic / xAuth authentication 37 | #user= 38 | #password= 39 | 40 | #Streaming 41 | stream.user.repliesAll=false 42 | stream.enableStallWarnings=true 43 | 44 | #HTTP Connection 45 | http.connectionTimeout=20000 46 | http.readTimeout=120000 47 | http.streamingReadTimeout=300000 48 | http.retryCount=0 49 | http.retryIntervalSecs=5 50 | http.prettyDebug=false 51 | 52 | #HTTP Proxy Server 53 | #http.proxyHost= 54 | #http.proxyPort= 55 | #http.proxyUser= 56 | #http.proxyPassword= 57 | 58 | #Media Support 59 | media.provider=twitter 60 | #media.providerAPIKey= 61 | 62 | #Base URLs 63 | restBaseURL=https://api.twitter.com/1.1/ 64 | streamBaseURL=https://stream.twitter.com/1.1/ 65 | siteStreamBaseURL=https://sitestream.twitter.com/1.1/ 66 | userStreamBaseURL=https://userstream.twitter.com/1.1/ 67 | oauth.requestTokenURL=https://api.twitter.com/oauth/request_token 68 | oauth.accessTokenURL=https://api.twitter.com/oauth/access_token 69 | oauth.authorizationURL=https://api.twitter.com/oauth/authorize 70 | oauth.authenticationURL=https://api.twitter.com/oauth/authenticate 71 | 72 | #Asynchronous 73 | async.numThreads=1 74 | async.dispatcherImpl=twitter4j.DispatcherImpl 75 | async.daemonEnabled=true -------------------------------------------------------------------------------- /elwha-server/src/main/java/gov/nasa/jpl/memex/elwha/impl/ElwhaResource.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 | package gov.nasa.jpl.memex.elwha.impl; 18 | 19 | import java.util.ArrayList; 20 | import java.util.Arrays; 21 | 22 | import twitter4j.FilterQuery; 23 | import twitter4j.StallWarning; 24 | import twitter4j.Status; 25 | import twitter4j.StatusDeletionNotice; 26 | import twitter4j.StatusListener; 27 | import twitter4j.TwitterException; 28 | import twitter4j.TwitterStream; 29 | import twitter4j.TwitterStreamFactory; 30 | 31 | import com.linkedin.restli.server.annotations.RestLiCollection; 32 | import com.linkedin.restli.server.resources.CollectionResourceTemplate; 33 | 34 | import gov.nasa.jpl.memex.elwha.Elwha; 35 | 36 | @RestLiCollection(name = "elwha", namespace = "gov.nasa.jpl.memex.elwha") 37 | public class ElwhaResource extends CollectionResourceTemplate { 38 | 39 | /** 40 | * Main entry of this application. 41 | * 42 | * @param userIds follow(comma separated user ids) track(comma separated filter terms) 43 | * @throws TwitterException when Twitter service or network is unavailable 44 | * @return 45 | */ 46 | @Override 47 | public Elwha get(String userIds) { 48 | //return new Elwha().setMessage("Hello, Rest.li!"); 49 | // } 50 | 51 | //if (userIds.length < 1) { 52 | // System.out.println("Usage: java twitter4j.examples.PrintFilterStream [follow(comma separated numerical user ids)] [track(comma separated filter terms)]"); 53 | // System.exit(-1); 54 | //} 55 | 56 | StatusListener listener = new StatusListener() { 57 | @Override 58 | public void onStatus(Status status) { 59 | System.out.println("@" + status.getUser().getScreenName() + " - " + status.getText()); 60 | } 61 | 62 | @Override 63 | public void onDeletionNotice(StatusDeletionNotice statusDeletionNotice) { 64 | System.out.println("Got a status deletion notice id:" + statusDeletionNotice.getStatusId()); 65 | } 66 | 67 | @Override 68 | public void onTrackLimitationNotice(int numberOfLimitedStatuses) { 69 | System.out.println("Got track limitation notice:" + numberOfLimitedStatuses); 70 | } 71 | 72 | @Override 73 | public void onScrubGeo(long userId, long upToStatusId) { 74 | System.out.println("Got scrub_geo event userId:" + userId + " upToStatusId:" + upToStatusId); 75 | } 76 | 77 | @Override 78 | public void onStallWarning(StallWarning warning) { 79 | System.out.println("Got stall warning:" + warning); 80 | } 81 | 82 | @Override 83 | public void onException(Exception ex) { 84 | ex.printStackTrace(); 85 | } 86 | }; 87 | 88 | TwitterStream twitterStream = new TwitterStreamFactory().getInstance(); 89 | twitterStream.addListener(listener); 90 | ArrayList follow = new ArrayList(); 91 | ArrayList track = new ArrayList(); 92 | if (isNumericalArgument(userIds)) { 93 | for (String id : userIds.split(",")) { 94 | follow.add(Long.parseLong(id)); 95 | } 96 | } else { 97 | track.addAll(Arrays.asList(userIds.split(","))); 98 | } 99 | long[] followArray = new long[follow.size()]; 100 | for (int i = 0; i < follow.size(); i++) { 101 | followArray[i] = follow.get(i); 102 | } 103 | String[] trackArray = track.toArray(new String[track.size()]); 104 | 105 | // filter() method internally creates a thread which manipulates TwitterStream and calls these adequate listener methods continuously. 106 | twitterStream.filter(new FilterQuery(0, followArray, trackArray)); 107 | 108 | return new Elwha().setUserIds("Mock stub!"); 109 | } 110 | 111 | private static boolean isNumericalArgument(String argument) { 112 | String args[] = argument.split(","); 113 | boolean isNumericalArgument = true; 114 | for (String arg : args) { 115 | try { 116 | Integer.parseInt(arg); 117 | } catch (NumberFormatException nfe) { 118 | isNumericalArgument = false; 119 | break; 120 | } 121 | } 122 | return isNumericalArgument; 123 | } 124 | } 125 | -------------------------------------------------------------------------------- /elwha-api/Tweet.pdsc: -------------------------------------------------------------------------------- 1 | { 2 | "type": "record", 3 | "name": "Tweet", 4 | "namespace": "gov.nasa.jpl.memex.elwha.api", 5 | "doc": "A representation of a Tweet.", 6 | "fields": [ 7 | { 8 | "name": "contributors", 9 | "type": { 10 | "type": "array", 11 | "items": "long" 12 | }, 13 | "doc": "Returns an array of contributors, or null if no contributor is associated with this status." 14 | }, 15 | { 16 | "name": "createdAt", 17 | "type": "string", 18 | "doc": "Return the created_at date." 19 | }, 20 | { 21 | "name": "currentUserRetweetId", 22 | "type": "long", 23 | "doc": "Returns the authenticating user's retweet's id of this tweet, or -1L when the tweet was created before this feature was enabled." 24 | }, 25 | { 26 | "name": "favoriteCount", 27 | "type": "int", 28 | "doc": "Indicates approximately how many times this Tweet has been 'favorited' by Twitter users." 29 | }, 30 | { 31 | "name": "geoLocation", 32 | "type": "GeoLocation", 33 | "doc": "Returns The location that this tweet refers to if available." 34 | }, 35 | { 36 | "name": "iD", 37 | "type": "long", 38 | "doc": "Returns the id of the status." 39 | }, 40 | { 41 | "name": "inReplyToScreenName", 42 | "type": "string", 43 | "doc": "Returns the in_reply_to_screen_name" 44 | }, 45 | { 46 | "name": "inReplyToStatusId()", 47 | "type": "long", 48 | "doc": "Returns the in_reply_tostatus_id" 49 | }, 50 | { 51 | "name": "inReplyToUserId()", 52 | "type": "long", 53 | "doc": "Returns the in_reply_user_id" 54 | }, 55 | { 56 | "name": "lang", 57 | "type": "string", 58 | "doc": "Returns the lang of the status text if available." 59 | }, 60 | { 61 | "name": "place", 62 | "type": "Place", 63 | "doc": "Returns the place attached to this status" 64 | }, 65 | { 66 | "name": "quotedStatus", 67 | "type": "Status", 68 | "doc": "Returns the Tweet object of the original Tweet that was quoted." 69 | }, 70 | { 71 | "name": "quotedStatusId", 72 | "type": "long", 73 | "doc": "Returns the Tweet ID of the quoted Tweet" 74 | }, 75 | { 76 | "name": "retweetCount", 77 | "type": "int", 78 | "doc": "Returns the number of times this tweet has been retweeted, or -1 when the tweet was created before this feature was enabled." 79 | }, 80 | { 81 | "name": "retweetedStatus", 82 | "type": "Status", 83 | "doc": "" 84 | }, 85 | { 86 | "name": "scopes", 87 | "type": "string", 88 | "doc": "Returns the targeting scopes applied to a status." 89 | }, 90 | { 91 | "name": "source", 92 | "type": "string", 93 | "doc": "Returns the source" 94 | }, 95 | { 96 | "name": "text", 97 | "type": "string", 98 | "doc": "Returns the text of the status." 99 | }, 100 | { 101 | "name": "user", 102 | "type": "User", 103 | "doc": "Return the user associated with the status. This can be null if the instance is from User.getStatus()" 104 | }, 105 | { 106 | "name": "withheldInCountries", 107 | "type": "string", 108 | "doc": "Returns the list of country codes where the tweet is withheld" 109 | }, 110 | { 111 | "name": "favorited", 112 | "type": "boolean", 113 | "doc": "Test if the status is favorited" 114 | }, 115 | { 116 | "name": "possiblySensitive", 117 | "type": "boolean", 118 | "doc": "Returns true if the status contains a link that is identified as sensitive." 119 | }, 120 | { 121 | "name": "retweet", 122 | "type": "boolean", 123 | "doc": "Whether it is a retweet or not." 124 | }, 125 | { 126 | "name": "retweeted", 127 | "type": "boolean", 128 | "doc": "Test if the status is retweeted." 129 | }, 130 | { 131 | "name": "retweetedByMe", 132 | "type": "boolean", 133 | "doc": "Returns true if the authenticating user has retweeted this tweet, or false when the tweet was created before this feature was enabled." 134 | }, 135 | { 136 | "name": "truncated", 137 | "type": "boolean", 138 | "doc": "Test if the status is truncated" 139 | } 140 | ] 141 | } 142 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------