This is an automated email from the ASF dual-hosted git repository.
lgoldstein pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
The following commit(s) were added to refs/heads/master by this push:
new a114cc0 Fixed case of 'setUpDefaultClient/Server' in documentation
a114cc0 is described below
commit a114cc0d5945ffb934ca160e301ca7d8b8e950b9
Author: Lyor Goldstein <lgoldst...@apache.org>
AuthorDate: Thu Nov 26 11:29:18 2020 +0200
Fixed case of 'setUpDefaultClient/Server' in documentation
---
docs/changes/2.3.0.md | 2 +-
docs/client-setup.md | 6 +++---
docs/commands.md | 4 ++--
docs/event-listeners.md | 4 ++--
docs/internals.md | 2 +-
5 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/changes/2.3.0.md b/docs/changes/2.3.0.md
index 4c3fa4b..2dfe0d9 100644
--- a/docs/changes/2.3.0.md
+++ b/docs/changes/2.3.0.md
@@ -95,7 +95,7 @@ Therefore we do not include by default the "rsa-sha-*"
signature factories in th
be easily added by using the relevant `BuiltinSignatures`:
```java
-SshClient client = SshClient.setupDefaultClient();
+SshClient client = SshClient.setUpDefaultClient();
client.setSignatureFactories(
Arrays.asList(
/* This is the full list in the recommended preference order,
diff --git a/docs/client-setup.md b/docs/client-setup.md
index 3a95bec..0837186 100644
--- a/docs/client-setup.md
+++ b/docs/client-setup.md
@@ -10,13 +10,13 @@ This is simply done by calling
```java
-SshClient client = SshClient.setupDefaultClient();
+SshClient client = SshClient.setUpDefaultClient();
```
The call will create an instance with a default configuration suitable for
most use cases - including ciphers,
compression, MACs, key exchanges, signatures, etc... If your code requires
some special configuration, one can
-look at the code for `setupDefaultClient` and `checkConfig` as a reference for
available options and configure
+look at the code for `setUpDefaultClient` and `checkConfig` as a reference for
available options and configure
the SSH client the way you need.
## Set up client side security
@@ -119,7 +119,7 @@ Furthermore, one can change almost any configured
`SshClient` parameter - althou
sessions depends on the actual changed configuration. Here is how a typical
usage would look like
```java
-SshClient client = SshClient.setupDefaultClient();
+SshClient client = SshClient.setUpDefaultClient();
// override any default configuration...
client.setSomeConfiguration(...);
client.setOtherConfiguration(...);
diff --git a/docs/commands.md b/docs/commands.md
index 15f7e19..7f9c3af 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -10,7 +10,7 @@ deciding what is the logged-in user's file system view and
then use a `RootedFil
file system where the logged-in user can access only the files under the
specified root and no others.
```java
-SshServer sshd = SshServer.setupDefaultServer();
+SshServer sshd = SshServer.setUpDefaultServer();
sshd.setFileSystemFactory(new VirtualFileSystemFactory() {
@Override
public Path getUserHomeDir(SessionContext session) throws IOException {
@@ -50,7 +50,7 @@ remain active afterwards...).
SftpSubsystemFactory factory = new SftpSubsystemFactory.Builder()
.withExecutorServiceProvider(() -> new
NoCloseExecutor(mySuperDuperExecutorService))
.build();
-SshServer sshd = SshServer.setupDefaultServer();
+SshServer sshd = SshServer.setUpDefaultServer();
sshd.setSubsystemFactories(Collections.<NamedFactory<Command>>singletonList(factory));
```
diff --git a/docs/event-listeners.md b/docs/event-listeners.md
index d360140..fb31d55 100644
--- a/docs/event-listeners.md
+++ b/docs/event-listeners.md
@@ -129,7 +129,7 @@ class MyClientSideReservedSessionMessagesHandler implements
ReservedSessionMessa
}
// client side
-SshClient client = SshClient.setupDefaultClient();
+SshClient client = SshClient.setUpDefaultClient();
// This is the default for ALL sessions unless specifically overridden
client.setReservedSessionMessagesHandler(new
MyClientSideReservedSessionMessagesHandler());
// Adding it via a session listener
@@ -154,7 +154,7 @@ try (ClientSession session = client.connect(user, host,
port).verify(...timeout.
// server side
-SshServer server = SshServer.setupDefaultServer();
+SshServer server = SshServer.setUpDefaultServer();
// This is the default for ALL sessions unless specifically overridden
server.setReservedSessionMessagesHandler(new
MyServerSideReservedSessionMessagesHandler());
// Adding it via a session listener
diff --git a/docs/internals.md b/docs/internals.md
index 2826f34..1e116d1 100644
--- a/docs/internals.md
+++ b/docs/internals.md
@@ -152,7 +152,7 @@ client instance follows the [SSH config
file](https://www.digitalocean.com/commu
standards, but the interface can be replaced so as to implement whatever
proprietary logic is required.
```java
- SshClient client = SshClient.setupDefaultClient();
+ SshClient client = SshClient.setUpDefaultClient();
client.setHostConfigEntryResolver(new MyHostConfigEntryResolver());
client.start();
