Skip to content

Commit 9736e21

Browse files
committed
COH-31223: Update CE 14.1.2.0 docs
[git-p4: depot-paths = "//dev/coherence-ce/release/coherence-ce-v14.1.2.0/": change = 113038]
1 parent 34bd031 commit 9736e21

File tree

4 files changed

+49
-15
lines changed

4 files changed

+49
-15
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ Coherence Maps provide a number of features:
101101

102102
* Fundamental **key-based access**: get/put getAll/putAll.
103103
* Client-side and storage-side events:
104-
* **MapListeners** to asynchronously notify clients of changes to data.
105-
* **EventInterceptors** (either sync or async) to be notified storage level events, including
104+
* **MapListeners** to asynchronously notify clients of changes to data.
105+
* **EventInterceptors** (either sync or async) to be notified storage level events, including
106106
mutations, partition transfer, failover, and so on.
107107
* **NearCaches** - Locally cached data based on previous requests with local content
108108
invalidated upon changes in the storage tier.
@@ -119,7 +119,7 @@ to execute processing logic for the appropriate entries with exclusive access.
119119
associating data (thus being on the same partition) and manipulating other entries
120120
on the same partition, potentially across different maps.
121121
* **Non-blocking / async NamedMap API**
122-
* **Polyglot clients** - Access the same NamedMap API from C++, Go, Java, JavaScript, .NET, or Python.
122+
* **Polyglot clients** - Access the same NamedMap API from [C++](https://github.com/oracle/coherence-cpp-extend-client), [Go](https://github.com/oracle/coherence-go-client), Java, [JavaScript](https://github.com/oracle/coherence-js-client), [.NET](https://github.com/oracle/coherence-dotnet-extend-client), or [Python](https://github.com/oracle/coherence-py-client)
123123
* **Portable Object Format** - Optimized serialization format, with the ability to
124124
navigate the serialized form for optimized queries, aggregations, or data processing.
125125
* **Integration with Databases** - Database and third party data integration with
@@ -130,10 +130,13 @@ the storage capacity, the cluster, and parallelizable subscribers.
130130
* **Repository API** - a framework implementing the Repository pattern from Domain-Driven Design,
131131
abstracting persistent storage implementation from application code, with advanced features like
132132
support for pagination, projections, streaming, and updating in-place
133-
* **Microservices integration** - broad and close integration with Helidon, Micronaut, and Spring for
134-
developing microservices applications using Coherence as a data source or cache
135-
* **coherence-concurrent** - Coherence-backed implementations of types from the `java.util.concurrent`
136-
package enabling distributed process coordination through the grid
133+
* **coherence-concurrent** - Coherence-backed implementations of types from the `java.util.concurrent` package enabling distributed process coordination through the grid
134+
* **Atomics** - for implementing e.g. atomic counters shared between cluster, with an optional asynchronous API
135+
* **Executors** - for submitting tasks to be executed in the cluster
136+
* **Locks** - for implementing lock-based concurrency control across multiple cluster members
137+
* **Queues** - for implementing blocking queue / dequeue behavior across multiple cluster members
138+
* **Semaphores** - for implementing synchronization of execution across multiple cluster members
139+
* **Microservices integration** - broad and close integration with [Helidon](https://docs.oracle.com/en/middleware/standalone/coherence/14.1.2/integrate/index.html), [Micronaut](https://micronaut-projects.github.io/micronaut-coherence/latest/guide/), and [Spring](https://spring.coherence.community/4.3.0/#/about/01_overview) for developing microservices applications using Coherence as a data source or cache
137140

138141
Coherence also provides a number of non-functional features:
139142

@@ -158,8 +161,7 @@ JMX server that provides a view of all members of the cluster.
158161
* **Management over REST** - All JMX data and operations can be performed over REST,
159162
including cluster wide thread dumps and heapdumps.
160163
* **Non-cluster Access** - Provides access to the cluster from the outside via proxies,
161-
for distant (high latency) clients and for non-Java languages such as C++, Go, JavaScript,
162-
.NET, and Python.
164+
for distant (high latency) clients and for non-Java languages such as [C++](https://github.com/oracle/coherence-cpp-extend-client), [Go](https://github.com/oracle/coherence-go-client), [JavaScript](https://github.com/oracle/coherence-js-client), [.NET](https://github.com/oracle/coherence-dotnet-extend-client), and [Python](https://github.com/oracle/coherence-py-client).
163165
* **Kubernetes friendly** - Enables seamless and safe deployment of applications to k8s with
164166
our own [operator](https://github.com/oracle/coherence-operator).
165167

prj/docs/about/01_overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Oracle Coherence commercial edition product documentation.
7373
7474
[CARD]
7575
.API Docs
76-
[icon=library_books,link=../api/java/index.html,link-type=url]
76+
[icon=library_books,link=docs/about/04_api.adoc]
7777
--
7878
Browse the Coherence CE API Docs.
7979
--

prj/docs/about/02_introduction.adoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
///////////////////////////////////////////////////////////////////////////////
2-
Copyright (c) 2000, 2021, Oracle and/or its affiliates.
2+
Copyright (c) 2000, 2024, Oracle and/or its affiliates.
33

44
Licensed under the Universal Permissive License v 1.0 as shown at
5-
http://oss.oracle.com/licenses/upl.
5+
https://oss.oracle.com/licenses/upl.
66
///////////////////////////////////////////////////////////////////////////////
77
= Introduction
88
@@ -29,6 +29,7 @@ a cache will be represented by an implementation of `NamedCache<K,V>`.
2929
Cache is an unfortunate name, as many customers use Coherence as a system-of-record rather than a lossy store of data.
3030
A cache is hosted by a service, generally the PartitionedService, and is the entry point to storing, retrieving,
3131
aggregating, querying, and streaming data.
32+
3233
There are a number of features that caches provide:
3334
3435
* Fundamental *key-based access*: get/put getAll/putAll
@@ -42,14 +43,19 @@ There are a number of features that caches provide:
4243
* *Data local processing* - an ability to send a function to the relevant storage node to execute processing logic for the appropriate entries with exclusive access
4344
* *Partition local transactions* - an ability to perform scalable transactions by associating data (thus being on the same partition) and manipulating other entries on the same partition potentially across caches
4445
* *Non-blocking / async NamedCache API*
45-
* *Polyglot clients* - access the same NamedCache API from C{pp}, Go, Java, JavaScript, .NET, or Python
46+
* *Polyglot clients* - access the same NamedCache API from https://github.com/oracle/coherence-cpp-extend-client[C++], https://github.com/oracle/coherence-go-client[Go], Java, https://github.com/oracle/coherence-js-client[JavaScript], https://github.com/oracle/coherence-dotnet-extend-client[.NET], or https://github.com/oracle/coherence-py-client[Python]
4647
* *Portable Object Format* - optimized serialization format, with the ability to navigate the serialized form for optimized queries, aggregations, or data processing
4748
* *Integration with Databases* - Database & third party data integration with CacheStores including both synchronous or asynchronous writes
4849
* *CohQL* - ansi-style query language with a console for adhoc queries
4950
* *Topics* - distributed topics implementation offering pub/sub messaging with the storage capacity the cluster and parallelizable subscribers
5051
* *Repository API* - a framework implementing the Repository pattern from Domain-Driven Design, abstracting persistent storage implementation from application code, with advanced features like support for pagination, projections, streaming, and updating in-place
51-
* *Microservices integration* - broad and close integration with Helidon, Micronaut, and Spring for developing microservices applications using Coherence as a data source or cache
5252
* *coherence-concurrent* - Coherence-backed implementations of types from the `java.util.concurrent` package enabling distributed process coordination through the grid
53+
** *Atomics* - for implementing e.g. atomic counters shared between cluster, with an optional asynchronous API
54+
** *Executors* - for submitting tasks to be executed in the cluster
55+
** *Locks* - for implementing lock-based concurrency control across multiple cluster members
56+
** *Queues* - for implementing blocking queue / dequeue behavior across multiple cluster members
57+
** *Semaphores* - for implementing synchronization of execution across multiple cluster members
58+
* *Microservices integration* - broad and close integration with https://docs.oracle.com/en/middleware/standalone/coherence/14.1.2/integrate/index.html[Helidon], https://micronaut-projects.github.io/micronaut-coherence/latest/guide/[Micronaut], and https://spring.coherence.community/4.3.0/#/about/01_overview[Spring] for developing microservices applications using Coherence as a data source or cache
5359
5460
There are also a number of non-functional features that Coherence provides:
5561
@@ -62,7 +68,7 @@ There are also a number of non-functional features that Coherence provides:
6268
* *Lossy redundancy* - ability to reduce the redundancy guarantee by making backups and/or persistence asynchronous from a client perspective
6369
* *Single Mangement View* - provides insight into the cluster with a single JMX server that provides a view of all members of the cluster
6470
* *Management over REST* - all JMX data and operations can be performed over REST, including cluster wide thread dumps and heapdumps
65-
* *Non-cluster Access* - access to the cluster from the outside via proxies, for distant (high latency) clients and for non-Java languages such as C{pp}, Go, JavaScript, .NET, and Python
71+
* *Non-cluster Access* - access to the cluster from the outside via proxies, for distant (high latency) clients and for non-Java languages such as https://github.com/oracle/coherence-cpp-extend-client[C++], https://github.com/oracle/coherence-go-client[Go], https://github.com/oracle/coherence-js-client[JavaScript], https://github.com/oracle/coherence-dotnet-extend-client[.NET], or https://github.com/oracle/coherence-py-client[Python]
6672
* *Kubernetes friendly* - seamlessly and safely deploy applications to k8s with our own https://github.com/oracle/coherence-operator[operator]
6773
6874

prj/docs/about/04_api.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
///////////////////////////////////////////////////////////////////////////////
2+
Copyright (c) 2000, 2024, Oracle and/or its affiliates.
3+
4+
Licensed under the Universal Permissive License v 1.0 as shown at
5+
https://oss.oracle.com/licenses/upl.
6+
///////////////////////////////////////////////////////////////////////////////
7+
= API Docs
8+
:description: Oracle Coherence CE Documentation
9+
:keywords: coherence, API, Java, .NET, C++, Python, Go, JavaScript documentation
10+
11+
// DO NOT remove this header - it might look like a duplicate of the header above, but
12+
// both they serve a purpose, and the docs will look wrong if it is removed.
13+
== API Docs
14+
15+
16+
- https://oracle.github.io/coherence/{version-coherence-maven}/api/java/index.html[Coherence CE Java API]
17+
18+
- https://docs.oracle.com/en/middleware/fusion-middleware/coherence/14.1.2.0/net-reference/html[Coherence .NET Client API]
19+
20+
- https://docs.oracle.com/en/middleware/fusion-middleware/coherence/14.1.2.0/cplus-reference/index.html[Coherence C++ Client API]
21+
22+
- https://oracle.github.io/coherence-py-client/api_reference.html[Coherence Python Client API]
23+
24+
- https://pkg.go.dev/github.com/oracle/coherence-go-client/v2/coherence#pkg-index[Coherence Go Client API]
25+
26+
- https://oracle.github.io/coherence-js-client/[Coherence JavaScript Client API]

0 commit comments

Comments
 (0)