fix #546 - release notes

(cherry picked from commit 7c4086c)

Author: sammefford

README.md

@@ -3,17 +3,54 @@
 The API makes it easy to write, read, delete, and find documents
 in a [MarkLogic](http://developer.marklogic.com/) database.
 
+For example:
+
+    // write a text, binary, XML, or JSON document from any source with ACID guarantees
+    documentManager.write(uri, new FileHandle()
+      .with(new File("file1234.json"))
+      .withFormat(JSON));
+
+    // read and directly parse to your preferred type, even your own POJOs!
+    JsonNode jsonDocContents = documentManager.readAs(uri, JsonNode.class);
+
+    // get matches super-fast using full-featured search
+    JsonNode results = queryManager.search(
+      new StructuredQueryBuilder().term("quick", "brown", "fox"),
+      new JacksonHandle()).get();
+
 The Java API supports the following core features of the MarkLogic database:
 
 *  Write and read binary, JSON, text, and XML documents.
 *  Query data structure trees, marked-up text, and all the hybrids in between those extremes.
-*  Project values and tuples from hierarchical documents and aggregate over them.
+*  Project values, tuples, and triples from hierarchical documents and aggregate over them.
 *  Patch documents with partial updates.
-*  Match documents against alerting rules expressed as queries. 
+*  Match documents against alerting rules expressed as queries.
 *  Use Optimistic Locking to detect contention without creating locks on the server.
 *  Execute ACID modifications so the change either succeeds or throws an exception.
 *  Execute multi-statement transactions so changes to multiple documents succeed or fail together.
 
+### What's New in Java Client API 4.0.0
+
+* Optic API - blends relational with NoSQL by providing joins and aggregates over documents
+  * is powered by the new row index and query optimizer
+  * uses row, triple, and/or lexicon lenses
+  * matches the functionality of the Optic API for XQuery and Javascript, but idiomatic for Java
+    developers
+* Data Movement SDK - move large amounts of data into, out of, or within a MarkLogic cluster
+  * WriteBatcher distributes writes across many threads and across the entire MarkLogic cluster
+  * QueryBatcher enables bulk processing or export of matches to a query by distributing the query
+    across many threads and batch processing to listeners
+  * Comes with ApplyTransformListener, DeleteListener, ExportListener, ExportToWriterListener, and
+    UrisToWriterListener
+  * With custom listeners you can easily and efficiently apply your business logic to batches of query
+    matches
+* Kerberos and Client Certificate Authentication
+* Geospatial double precision and queries on region indexes
+* Temporal document enhancements
+  * protect and wipe
+  * more control over version uris
+* Support for document metadata values
+
 ### What's New in Java Client API 3.0.1
 
 * Pojo Façade - persist POJOs as JSON objects and use a simple API to query them with all the power

release_notes/release_4.0.0.md

@@ -0,0 +1,56 @@
+NOTES FOR RELEASE 4.0.0
+
+Adds Optic API, Data Movement SDK, Kerberos, Client Certificate Authentication, Geospatial enhancements,
+Temporal documen enhancements, support for metadata values.
+
+New Functionality
+392 - add shortcut addAs methods to DocumentWriteSet
+400 - Optic API
+402 - geo double precision and geo polygon search
+404 - add Kerberos support
+413 - add support for document metadata values
+406 - certificate-based authentication
+414 - Bitemporal ML9 features - version URI, Wipe, Protect, document patch
+465 - Data Movement SDK
+466 - add StructuredQueryBuilder.coordSystem to set Geo coordinate system
+473 - send header "ML-Agent-ID: java" with every HTTP request so REST layer can track which calls come
+from Java Client API
+550 - add Capability NODE_UPDATE
+
+Improvements and Bug Fixes
+- many javadoc improvements
+210 - fail fast when library module path doesn't begin with /ext
+234 - offer a way to close the input source for XMLStreamReaderHandle
+241 - fix misleading WARN warning message from values call
+249 - fixes DocumentPatchBuilder.replaceValue with numbers or booleans
+256 - be explicit about desired format of QBE response
+262 - update SearchHandle to support search:extracted elements
+288 - support changes made in server-generated metadata for binary docs
+292 - support changes made in search:search response with extracted results
+294 - DocumentPage.size was including metadata in counts but should not have
+365 - reduce duplicate code in JerseyServices
+371 - JAXBContext should be cached for improved performance
+380 - setOptimzeLevel should have been setOptimizeLevel
+385 - improve javadocs for RuleManager.readAs
+421 - Some of the read handlers do not populate properly formats and mime-types when used with
+ResourceServices
+423 - add support for extract-resolution time
+424 - remove logback dependency so slf4j works as it should
+434 - imporove error response processing
+436 - rename java-client-api-M.m.p.jar JAR to marklogic-client-api-M.m.p.jar
+437 - fix support for date range queries
+448 - Efficiencies: avoid Object construction, auto-boxing, etc.
+Commit ca96e23- expose PojoRepository.getId
+467 - connections are left in CLOSE_WAIT after DatabaseClient.release is called
+472 - remove unnecessary INFO logging from RuleDefinition
+486 - PojoRepository.count(query) does not scope count with the query
+524 - add support for markdown javadocs
+560 - support new 428 status code for missing content version
+582 - NullPointerException thrown while doing eval() with client object created with incorrect credentials
+587 - rename GeoSpatialOperator to GeospatialOperator
+Commit 484d15 - avoid errors by only parsing non-blank entityResolutionTime
+592, 594, 598 - chunked HTTP broke certain XML parsers unless we set XMLInputFactory.isCoalescing to true
+610 - remove support for deprecated keyvalue endpoint
+621 - remove deprecated APIs
+651 - don't set the handle format from the descriptor if it's null
+687 - clean up indenting across the project