Skip to content

Commit 11b84be

Browse files
authored
Merge pull request #3 from svanoort/remote-docs
Amend Javadocs
2 parents ea15b85 + 5b88a0d commit 11b84be

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -291,13 +291,15 @@ public boolean shouldClearAll(@Nonnull Run<?,?> build) {
291291

292292
/**
293293
* Mixin interface for an {@link ArtifactManager} which supports specialized stash behavior as well.
294-
* <p>The recommended standard implementation is {@code JCloudsArtifactManager}
295-
* in the plugin currently named {@code artifact-manager-s3}.
296-
* This in turn supports extensibility to various cloud providers,
297-
* and handles all aspects of making cloud artifact storage work smoothly in Jenkins
298-
* including the {@link VirtualFile} implementation, robust network error handling,
299-
* overall configuration UI, and more.
300-
* Implement this interface directly at your own risk.
294+
*
295+
* <p> When implementing off-Jenkins artifact storage, you should NOT extend this directly but instead use the
296+
* {@code JCloudsArtifactManager} in the plugin currently named {@code artifact-manager-s3}.
297+
*
298+
* This is dangerous to directly extend if using remote storage unless you write a very robust handling of network failures including at least a base timeout and retries.
299+
* The {@code JCloudsArtifactManager} implementation supports extensibility to various cloud providers and custom stores via the {@code BlobStoreProvider} ExtensionPoint.
300+
* It handles all aspects of making cloud artifact storage work smoothly in Jenkins
301+
* including the {@link VirtualFile} implementation, robust network error handling, overall configuration UI, and more.
302+
* <strong>Implement this interface directly at your own risk.</strong>
301303
* @see <a href="https://github.com/jenkinsci/jep/blob/master/jep/202/README.adoc">JEP-202</a>
302304
*/
303305
@Restricted(Beta.class)

0 commit comments

Comments
 (0)