Skip to content

Commit cbd50c6

Browse files
Compliance changes for generated source and binary distributable tarballs
* New submodule to generate distribution source tarball * Binary/source tarball artifacts should be prefixed with apache-cassandra * Change groupId to org.apache.cassandra * Create binary versions for LICENSE and NOTICE, with licenses and entries for asm, HdrHistogram, jnr-posix, jnr-x86asm, slf4j-api * Add checksums to distribution tarballs, and clean toplevel readme a little patch by Mick Semb Wever; reviewed by Bret McGuire for CASSANDRA-18969
1 parent 2c753aa commit cbd50c6

File tree

43 files changed

+1715
-250
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1715
-250
lines changed

LICENSE_binary

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
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+
204+
Apache Cassandra Java Driver bundles code and files from the following projects:
205+
206+
Protocol Buffers
207+
Copyright 2008 Google Inc.
208+
This product includes software developed as part of the Protocol Buffers project ( https://developers.google.com/protocol-buffers/ ).
209+
see driver-core/src/main/java/com/datastax/driver/core/VIntCoding.java
210+
211+
This product bundles Java Native Runtime - POSIX 3.1.15,
212+
which is available under the Eclipse Public License version 2.0.
213+
see licenses/jnr-posix.txt
214+
215+
This product bundles jnr-x86asm 1.0.2,
216+
which is available under the MIT License.
217+
see licenses/jnr-x86asm.txt
218+
219+
This product bundles ASM 9.2: a very small and fast Java bytecode manipulation framework,
220+
which is available under the 3-Clause BSD License.
221+
see licenses/asm.txt
222+
223+
This product bundles HdrHistogram 2.1.12: A High Dynamic Range (HDR) Histogram,
224+
which is available under the 2-Clause BSD License.
225+
see licenses/HdrHistogram.txt
226+
227+
This product bundles The Simple Logging Facade for Java (SLF4J) API 1.7.26,
228+
which is available under the MIT License.
229+
see licenses/slf4j-api.txt

README.md

Lines changed: 15 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Java Driver for Apache Cassandra®
22

3+
:warning: The java-driver has recently been donated by Datastax to The Apache Software Foundation and the Apache Cassandra project. Bear with us as we move assets and coordinates.
4+
35
*If you're reading this on github.com, please note that this is the readme
46
for the development version and that some features described here might
57
not yet have been released. You can find the documentation for the latest
68
version through the [Java Driver
79
docs](http://docs.datastax.com/en/developer/java-driver/3.11/index.html) or via the release tags,
8-
[e.g. 3.11.5](https://github.com/datastax/java-driver/tree/3.11.5).*
10+
[e.g. 3.11.5](https://github.com/apache/cassandra-java-driver/tree/3.11.5).*
911

1012
A modern, [feature-rich](manual/) and highly tunable Java client
1113
library for Apache Cassandra (2.1+) and using exclusively Cassandra's binary protocol
@@ -42,17 +44,12 @@ The driver contains the following modules:
4244

4345
**Useful links:**
4446

45-
- JIRA (bug tracking): https://datastax-oss.atlassian.net/browse/JAVA
46-
- MAILING LIST: https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user
47-
- DATASTAX ACADEMY SLACK: #datastax-drivers on https://academy.datastax.com/slack
48-
- TWITTER: [@dsJavaDriver](https://twitter.com/dsJavaDriver) tweets Java
49-
driver releases and important announcements (low frequency).
50-
[@DataStaxEng](https://twitter.com/datastaxeng) has more news including
51-
other drivers, Cassandra, and DSE.
47+
- JIRA (bug tracking): https://issues.apache.org/jira/projects/CASSJAVA
48+
- MAILING LIST: https://cassandra.apache.org/_/community.html#discussions
5249
- DOCS: the [manual](http://docs.datastax.com/en/developer/java-driver/3.11/manual/) has quick
5350
start material and technical details about the driver and its features.
5451
- API: https://docs.datastax.com/en/drivers/java/3.11
55-
- GITHUB REPOSITORY: https://github.com/datastax/java-driver
52+
- GITHUB REPOSITORY: https://github.com/apache/cassandra-java-driver
5653
- [changelog](changelog/)
5754

5855
## Getting the driver
@@ -63,7 +60,7 @@ using DataStax Enterprise, install the [DataStax Enterprise Java Driver][dse-dri
6360

6461
```xml
6562
<dependency>
66-
<groupId>com.datastax.cassandra</groupId>
63+
<groupId>org.apache.cassandra</groupId>
6764
<artifactId>cassandra-driver-core</artifactId>
6865
<version>3.11.5</version>
6966
</dependency>
@@ -73,7 +70,7 @@ Note that the object mapper is published as a separate artifact:
7370

7471
```xml
7572
<dependency>
76-
<groupId>com.datastax.cassandra</groupId>
73+
<groupId>org.apache.cassandra</groupId>
7774
<artifactId>cassandra-driver-mapping</artifactId>
7875
<version>3.11.5</version>
7976
</dependency>
@@ -83,7 +80,7 @@ The 'extras' module is also published as a separate artifact:
8380

8481
```xml
8582
<dependency>
86-
<groupId>com.datastax.cassandra</groupId>
83+
<groupId>org.apache.cassandra</groupId>
8784
<artifactId>cassandra-driver-extras</artifactId>
8885
<version>3.11.5/version>
8986
</dependency>
@@ -94,60 +91,37 @@ We also provide a [shaded JAR](manual/shaded_jar/)
9491
to avoid the explicit dependency to Netty.
9592

9693
If you can't use a dependency management tool, a
97-
[binary tarball](https://github.com/datastax/java-driver/releases/3.11.5)
94+
[binary tarball](https://cassandra.apache.org/_/download.html)
9895
is available for download.
9996

10097
## Compatibility
10198

102-
The Java client driver 3.11.5 ([branch 3.x](https://github.com/datastax/java-driver/tree/3.x)) is compatible with Apache
99+
The Java client driver 3.11.5 ([branch 3.x](https://github.com/apache/cassandra-java-driver/tree/3.x)) is compatible with Apache
103100
Cassandra 2.1, 2.2 and 3.0+ (see [this page](http://docs.datastax.com/en/developer/java-driver/3.11/manual/native_protocol/) for
104101
the most up-to-date compatibility information).
105102

106103
UDT and tuple support is available only when using Apache Cassandra 2.1 or higher (see [CQL improvements in Cassandra 2.1](http://www.datastax.com/dev/blog/cql-in-2-1)).
107104

108105
Other features are available only when using Apache Cassandra 2.0 or higher (e.g. result set paging,
109-
[BatchStatement](https://github.com/datastax/java-driver/blob/3.x/driver-core/src/main/java/com/datastax/driver/core/BatchStatement.java),
106+
[BatchStatement](https://github.com/apache/cassandra-java-driver/blob/3.x/driver-core/src/main/java/com/datastax/driver/core/BatchStatement.java),
110107
[lightweight transactions](http://www.datastax.com/documentation/cql/3.1/cql/cql_using/use_ltweight_transaction_t.html)
111108
-- see [What's new in Cassandra 2.0](http://www.datastax.com/documentation/cassandra/2.0/cassandra/features/features_key_c.html)).
112109
Trying to use these with a cluster running Cassandra 1.2 will result in
113-
an [UnsupportedFeatureException](https://github.com/datastax/java-driver/blob/3.x/driver-core/src/main/java/com/datastax/driver/core/exceptions/UnsupportedFeatureException.java) being thrown.
110+
an [UnsupportedFeatureException](https://github.com/apache/cassandra-java-driver/blob/3.x/driver-core/src/main/java/com/datastax/driver/core/exceptions/UnsupportedFeatureException.java) being thrown.
114111

115112
The java driver supports Java JDK versions 6 and above.
116113

117-
If using _DataStax Enterprise_, the [DataStax Enterprise Java Driver][dse-driver] provides
118-
more features and better compatibility.
119-
120-
__Disclaimer__: Some _DataStax/DataStax Enterprise_ products might partially work on
121-
big-endian systems, but _DataStax_ does not officially support these systems.
122-
123114
## Upgrading from previous versions
124115

125116
If you are upgrading from a previous version of the driver, be sure to have a look at
126117
the [upgrade guide](/upgrade_guide/).
127118

128-
If you are upgrading to _DataStax Enterprise_, use the [DataStax Enterprise Java Driver][dse-driver] for more
129-
features and better compatibility.
130-
131-
## License
132-
133-
&copy; The Apache Software Foundation
134-
135-
Licensed under the Apache License, Version 2.0 (the "License");
136-
you may not use this file except in compliance with the License.
137-
You may obtain a copy of the License at
138-
139-
http://www.apache.org/licenses/LICENSE-2.0
140-
141-
Unless required by applicable law or agreed to in writing, software
142-
distributed under the License is distributed on an "AS IS" BASIS,
143-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
144-
See the License for the specific language governing permissions and
145-
limitations under the License.
146119

147120
----
148121

149122
Apache Cassandra, Apache, Tomcat, Lucene, Solr, Hadoop, Spark, TinkerPop, and Cassandra are
150123
trademarks of the [Apache Software Foundation](http://www.apache.org/) or its subsidiaries in
151124
Canada, the United States and/or other countries.
152125

153-
[dse-driver]: http://docs.datastax.com/en/developer/java-driver-dse/latest/
126+
127+
Binary artifacts of this product bundle Java Native Runtime libraries, which is available under the Eclipse Public License version 2.0.

docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ sections:
5050
files: 'faq/**/*.md'
5151
links:
5252
- title: Code
53-
href: https://github.com/datastax/java-driver/
53+
href: https://github.com/apache/cassandra-java-driver/
5454
- title: Docs
5555
href: http://docs.datastax.com/en/developer/java-driver/
5656
- title: Issues

driver-core/pom.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<modelVersion>4.0.0</modelVersion>
2323

2424
<parent>
25-
<groupId>com.datastax.cassandra</groupId>
25+
<groupId>org.apache.cassandra</groupId>
2626
<artifactId>cassandra-driver-parent</artifactId>
2727
<version>3.11.6-SNAPSHOT</version>
2828
</parent>
@@ -179,8 +179,10 @@
179179
<resource>
180180
<directory>${project.basedir}/..</directory>
181181
<includes>
182+
<include>LICENSE_binary</include>
182183
<include>LICENSE</include>
183184
<include>NOTICE_binary.txt</include>
185+
<include>NOTICE.txt</include>
184186
</includes>
185187
<targetPath>META-INF</targetPath>
186188
</resource>

0 commit comments

Comments
 (0)