Skip to content

Commit

Permalink
Formatting fixes (#1131)
Browse files Browse the repository at this point in the history
* Formatting fixes

Fixing some ugly formatting that was not working

* Missed one!

Need to escape a pipe in the code
  • Loading branch information
rebekah-lawrence authored Jun 7, 2024
1 parent 098628c commit 96b0f49
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ Hazelcast configuration also by using its default lookup mechanism.
|link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/Config.html#loadFromStream-java.io.InputStream-java.util.Properties-[`Config.loadFromStream()`]
|Creates `Config` from the provided XML or YAML stream content.

|link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/XmlConfigBuilder.html[]
|link:https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/config/XmlConfigBuilder.html#<init>0[`XMLConfigBuilder()`]
|Builds a `Config` that does not apply overrides in environment variables or system properties.

|===

Expand Down
17 changes: 17 additions & 0 deletions docs/modules/data-connections/pages/mongo-dc-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ name (which can be contained in `connectionString`).
| `host`
| Host to which Hazelcast will connect. Exclusive with `connectionString`.
| If you want to use `username` and `password` options, the `host` option is the way to configure host name.
|

| `connectionPoolMinSize`
| 10
Expand All @@ -179,27 +180,43 @@ name (which can be contained in `connectionString`).
| If you want to control connection pool size

| `enableSsl`
|
| Enables SSL support for Mongo client. Default value is `false`.
|

| `invalidHostNameAllowed`
|
| Allowes invalid hostnames in SSL. Default value is `false`. See https://www.mongodb.com/docs/mongodb-shell/reference/options/#std-option-mongosh.--tlsAllowInvalidHostnames[Mongo docs] for more info.
|

| `keyStore`
|
| Location of the key store, file must be present on all members.
|

| `keyStoreType`
|
| Type of the used key store. Defaults to system default.
|

| `keyStorePassword`
|
| Password to the key store.
|

| `trustStore`
|
| Location of the trust store, file must be present on all members.
|

| `trustStoreType`
|
| Type of the used trust store. Defaults to system default.
|

| `trustStorePassword`
|
| Password to the trust store.
|

|===
3 changes: 2 additions & 1 deletion docs/modules/kubernetes/pages/kubernetes-auto-discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ To make it easier to set up clusters in Kubernetes (K8s), Hazelcast allows membe

| *Cons* | Requires setting up **RoleBinding** (to allow access to Kubernetes API) | Limited to **headless Cluster IP** service

Limited to **Hazelcast cluster per service** |
Limited to **Hazelcast cluster per service**

|===

=== Using Kubernetes in API Mode
Expand Down
41 changes: 33 additions & 8 deletions docs/modules/migrate/pages/upgrading-from-imdg-3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ IMap map;

map.addIndex(new IndexConfig(IndexType.HASH, "name", "age"));
----
|===
== Changes in Custom Attributes
Expand Down Expand Up @@ -414,6 +415,7 @@ mapConfig.addAttributeConfig(attributeConfig);
...
</hazelcast>
----
|===
Expand Down Expand Up @@ -458,6 +460,7 @@ public static class PortableNameExtractor implements ValueExtractor<ValueReader,
}
}
----
|===
== Removal of MapReduce
Expand Down Expand Up @@ -513,6 +516,7 @@ hazelcastInstance.getJet().newJob(p).join();

printResults(hz.getMap(COUNTS));
----
|===
See the xref:architecture:distributed-computing.adoc#the-word-count-task[Word Count Task] for a full insight.
Expand Down Expand Up @@ -607,6 +611,7 @@ public class ClusterMigrationListener implements MigrationListener {
}
}
----
|===
See the https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/partition/MigrationListener.html[MigrationListener^] Javadoc
Expand Down Expand Up @@ -681,6 +686,7 @@ configProd.setClusterName( "production" );
Config configDev = new Config();
configDev.setClusterName( "development" );
----
|===
=== Member Authentication and Identity Configuration
Expand Down Expand Up @@ -755,6 +761,7 @@ See the following table for the before/after sample configurations.
<client-authentication realm="realm1"/>
</security>
----
|===
=== Client Identity Configuration
Expand Down Expand Up @@ -790,6 +797,7 @@ See the following table for the before/after sample configurations.
<username-password username="johndoe" password="s3crEt"/>
</security>
----
|===
== JAAS Authentication Cleanups
Expand Down Expand Up @@ -850,6 +858,7 @@ public PermissionCollection getPermissions(Subject subject, Class<? extends Perm
return collection;
}
----
|===
=== Changes in ClusterLoginModule
Expand Down Expand Up @@ -895,7 +904,7 @@ See the following table for the before/after sample implementations.
[source,java,options="nowrap"]
----
// Adds a single "foo" ClusterPrincipal to the JAAS Subject if credentials match.
// Adds a single "foo" ClusterPrincipal to the JAAS Subject if credentials match.
public class TestLoginModule extends ClusterLoginModule {

@Override
Expand Down Expand Up @@ -930,8 +939,8 @@ public class TestLoginModule extends ClusterLoginModule {
[source,java,options="nowrap"]
----
// Adds 3 principals to the JAAS Subject if credentials match:
// ClusterIdentityPrincipal "foo", ClusterRolePrincipal "admin" and a ClusterEndpointPrincipal
// Adds 3 principals to the JAAS Subject if credentials match:
// ClusterIdentityPrincipal "foo", ClusterRolePrincipal "admin" and a ClusterEndpointPrincipal
public class TestLoginModule extends ClusterLoginModule {

private String name;
Expand Down Expand Up @@ -960,6 +969,7 @@ public class TestLoginModule extends ClusterLoginModule {
}
}
----
|===
=== Changes in Credentials for Client Protocol
Expand Down Expand Up @@ -1001,7 +1011,7 @@ See the following table for the before/after sample implementations.
[source,java,options="nowrap"]
----
// login module already gets a deserialized credentials object
// login module already gets a deserialized credentials object
public boolean onLogin() throws LoginException {
if (credentials == null \|\| !(credentials instanceof CustomCredentials)) {
throw new FailedLoginException("No valid CustomCredentials found");
Expand All @@ -1018,13 +1028,13 @@ public boolean onLogin() throws LoginException {
[source,java,options="nowrap"]
----
// login module can ask for credentials, but it gets just a byte array "token"
// wrapped in the SimpleTokenCredentials instance
// login module can ask for credentials, but it gets just a byte array "token"
// wrapped in the SimpleTokenCredentials instance
public boolean onLogin() throws LoginException {
CredentialsCallback cc = new CredentialsCallback();
try {
callbackHandler.handle(new Callback[] { cc });
} catch (IOException | UnsupportedCallbackException e) {
} catch (IOException \| UnsupportedCallbackException e) {
throw new FailedLoginException("Unable to retrieve credentials. " + e.getMessage());
}
Credentials creds = cc.getCredentials();
Expand All @@ -1038,6 +1048,7 @@ public boolean onLogin() throws LoginException {
return true;
}
----
|===
Expand Down Expand Up @@ -1138,6 +1149,7 @@ See the following table for a before/after sample.
...
</hazelcast>
----
|===
See the xref:network-partitioning:split-brain-protection.adoc[Split-Brain Protection section] for more information on network partitioning.
Expand Down Expand Up @@ -1184,6 +1196,7 @@ public interface IdentifiedDataSerializable extends DataSerializable {
}

----
|===
See xref:serialization:implementing-dataserializable.adoc#identifieddataserializable[here] for more information
Expand Down Expand Up @@ -1239,6 +1252,7 @@ map.executeOnKey(key,
return null;
});
----
|===
This should cover most cases. If you need to define a custom
Expand Down Expand Up @@ -1298,6 +1312,7 @@ Collection<String> keys = map.project(new Projection<Entry<String, Double>, Stri
----
Collection<String> keys = map.project(Entry::getKey);
----
|===
== Expanding Nullable/Nonnull Annotations
Expand Down Expand Up @@ -1413,6 +1428,7 @@ public class Main {
}
}
----
|===
== WAN Replication Configuration Changes
Expand Down Expand Up @@ -1543,6 +1559,7 @@ WanBatchPublisherConfig publisherConfig = new WanBatchPublisherConfig()
.setSnapshotEnabled(false);
publisherConfig.getWanSyncConfig().setConsistencyCheckStrategy(ConsistencyCheckStrategy.NONE);
----
|===
See the following table for the before/after custom WAN publisher examples:
Expand Down Expand Up @@ -1607,6 +1624,7 @@ Map<String, Comparable> properties = publisherConfig.getProperties();
properties.put("some.property", "some-value");
properties.put("some.other.property", "some-other-value");
----
|===
See xref:wan:wan.adoc[WAN Replication] for more information.
Expand Down Expand Up @@ -1717,6 +1735,7 @@ See the following table for the before/after sample implementations.
});
hazelcastInstance.getClientService().removeClientListener(registrationId);
----
|===
== Removal of Deprecated Concurrency API Implementations
Expand Down Expand Up @@ -1811,6 +1830,7 @@ public class Main {
}
}
----
|===
== Removal of Legacy Merge Policies
Expand Down Expand Up @@ -1888,6 +1908,7 @@ config.setProperty("tag-value", "my-tag-value");
...
config.setEnabled(true);
----
|===
== Removal of Deprecated System Properties
Expand Down Expand Up @@ -2022,6 +2043,7 @@ See the following table for the before/after samples.
...
</hazelcast>
----
|===
== Changes in `IMap` Custom Eviction Policy Configuration
Expand Down Expand Up @@ -2063,6 +2085,7 @@ See the following table for the before/after samples.
...
</hazelcast>
----
|===
== Changes in `EntryListenerConfig`
Expand Down Expand Up @@ -2092,6 +2115,7 @@ EntryListener listenerImpl = config.getImplementation();
EntryListenerConfig config = new EntryListenerConfig();
MapListener listenerImpl = config.getImplementation();
----
|===
== Changes in REST Endpoints
Expand Down Expand Up @@ -2219,6 +2243,7 @@ See the following table for the before/after snippets.
...
</hazelcast>
----
|===
== Deprecation of User Code Deployment
Expand All @@ -2229,4 +2254,4 @@ The {ucn} feature, which extends {ucd} to allow you to redeploy your classes, is
Hazelcast recommends that Enterprise users migrate their user code to use {ucn}. For further information on migrating from {ucd} to {ucn}, see the xref:clusters:ucn-migrate-ucd.adoc[] topic.
Open Source users can either upgrade to Enterprise Edition, or add their resources to the Hazelcast member class paths.
Open Source users can either upgrade to Enterprise Edition, or add their resources to the Hazelcast member class paths.

0 comments on commit 96b0f49

Please sign in to comment.