-
Notifications
You must be signed in to change notification settings - Fork 43
DOCSP-31694: SOCKS5 proxy support #439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCSP-31694: SOCKS5 proxy support #439
Conversation
.. TODO | ||
- provide the link for the proxysettings builder once the API docs are generated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will be replaced by the ProxySettings Builder API docs link once v4.11 is published.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks mostly good, just a couple small suggestions!
.. code-block:: java | ||
:emphasize-lines: 4-11 | ||
|
||
MongoClient mongoClient = MongoClients.create( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like this code snippet starts off indented more than it needs to be. Since the third line is pretty long can the extra indentation be removed to show as much as possible without scrolling?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
|
||
* - **proxyUsername** | ||
- String | ||
- Specifies the username for authentication to the SOCKS5 proxy server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be beneficial to mention that proxyUsername
and proxyPassword
should always be specified together, as the driver requires both or none.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently, the Socks5 proxy feature specifically functions with the SocketStreamFactory,
which acts as the default in the absence of a configured SocketStreamFactoryFactory.
Including this detail in the documentation could be beneficial. Everything else, LGTM!
I wasn't able to find "SocketStreamFactoryFactory", so I assumed that you meant "StreamFactoryFactory" when adding the callout here. Let me know if this works! |
Yes, |
* DOCSP-32942: Deprecated Methods * review feedback * DOCSP-33241: fix extended JSON example id field (#447) * DOCSP-33241: fix extended JSON example id field * DOCSP-31694: SOCKS5 proxy support (#439) * DOCSP-31694: SOCKS5 proxy support * DOCSP-33300: Fix aggregation operator links to the manual (#448) * DOCSP-32300 Adds compatibility info to landing page (#449) * DOCSP-31907 Split Event (#457) * tech review feedback * format * CC feedback * CC feedback pt 2 * DOCSP-31907 - Add paragraph from server docs (#460) * DOCSP-32942: Deprecated Methods * review feedback * tech review feedback * format * CC feedback * CC feedback pt 2 * build
Pull Request Info
Note: This PR will require one edit to add the API docs link for the builder prior to merging for the upcoming v4.11 driver.
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-31694
Staging - https://preview-mongodbcchomongodb.gatsbyjs.io/java/DOCSP-31694-socks5-proxy/fundamentals/connection/socks/
Self-Review Checklist