From 8f67dcc34852a0e6a5c1dc9dcf3d58bfe829a893 Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Tue, 12 Jan 2016 08:34:38 -0500 Subject: [PATCH] Add Javadocs for exceptions that are handled by ShardStateAction --- .../cluster/action/shard/ShardStateAction.java | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/core/src/main/java/org/elasticsearch/cluster/action/shard/ShardStateAction.java b/core/src/main/java/org/elasticsearch/cluster/action/shard/ShardStateAction.java index 9a0d7e55ac3..b2b264c81f9 100644 --- a/core/src/main/java/org/elasticsearch/cluster/action/shard/ShardStateAction.java +++ b/core/src/main/java/org/elasticsearch/cluster/action/shard/ShardStateAction.java @@ -377,6 +377,21 @@ public class ShardStateAction extends AbstractComponent { default void onSuccess() { } + /** + * Notification for non-channel exceptions that are not handled + * by {@link ShardStateAction}. + * + * The exceptions that are handled by {@link ShardStateAction} + * are: + * - {@link NotMasterException} + * - {@link NodeDisconnectedException} + * - {@link Discovery.FailedToCommitClusterStateException} + * + * Any other exception is communicated to the requester via + * this notification. + * + * @param e the unexpected cause of the failure on the master + */ default void onShardFailedFailure(final Exception e) { } }