From 5b88a0d3b313d9c89f831a9e45290fadd46c3413 Mon Sep 17 00:00:00 2001 From: Sam Van Oort Date: Fri, 15 Jun 2018 12:15:40 -0400 Subject: [PATCH] Javadocs clarification --- .../plugins/workflow/flow/StashManager.java | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java b/src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java index 81814784..54fe445d 100644 --- a/src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java +++ b/src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java @@ -291,13 +291,15 @@ public boolean shouldClearAll(@Nonnull Run build) { /** * Mixin interface for an {@link ArtifactManager} which supports specialized stash behavior as well. - *

The recommended standard implementation is {@code JCloudsArtifactManager} - * in the plugin currently named {@code artifact-manager-s3}. - * This in turn supports extensibility to various cloud providers, - * and handles all aspects of making cloud artifact storage work smoothly in Jenkins - * including the {@link VirtualFile} implementation, robust network error handling, - * overall configuration UI, and more. - * Implement this interface directly at your own risk. + * + *

When implementing off-Jenkins artifact storage, you should NOT extend this directly but instead use the + * {@code JCloudsArtifactManager} in the plugin currently named {@code artifact-manager-s3}. + * + * 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. + * The {@code JCloudsArtifactManager} implementation supports extensibility to various cloud providers and custom stores via the {@code BlobStoreProvider} ExtensionPoint. + * It handles all aspects of making cloud artifact storage work smoothly in Jenkins + * including the {@link VirtualFile} implementation, robust network error handling, overall configuration UI, and more. + * Implement this interface directly at your own risk. * @see JEP-202 */ @Restricted(Beta.class)