Skip to content

Commit ab14f08

Browse files
author
Greg Curtis
committed
Update docs around saving/restoring proxy settings
Configured proxies aren't saved or restored with BoxAPIConnection#save() or BoxAPIConnection#restore(String). This is intentional because: 1. We don't have a clean way of serializing the Proxy object to JSON. 2. If the proxy has a password, it would be unsafe to persist it to the saved state string. This change updates the javadocs so it's clear that proxy settings must be manually reconfigured after restoring an API connection. Fixes #143.
1 parent 9bb1fba commit ab14f08

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/main/java/com/box/sdk/BoxAPIConnection.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -543,6 +543,10 @@ public void setRequestInterceptor(RequestInterceptor interceptor) {
543543
/**
544544
* Saves the state of this connection to a string so that it can be persisted and restored at a later time.
545545
*
546+
* <p>Note that proxy settings aren't automatically saved or restored. This is mainly due to security concerns
547+
* around persisting proxy authentication details to the state string. If your connection uses a proxy, you will
548+
* have to manually configure it again after restoring the connection.</p>
549+
*
546550
* @see #restore
547551
* @return the state of this connection.
548552
*/

0 commit comments

Comments
 (0)