Skip to content

Improve context propagator javadocs #1092

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 23, 2022
Merged

Improve context propagator javadocs #1092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion temporal-sdk/src/main/java/io/temporal/activity/ActivityOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
package io.temporal.activity;

import com.google.common.base.Objects;
import io.temporal.client.WorkflowClientOptions;
import io.temporal.common.MethodRetry;
import io.temporal.common.RetryOptions;
import io.temporal.common.context.ContextPropagator;
Expand Down Expand Up @@ -154,7 +155,8 @@ public Builder setRetryOptions(RetryOptions retryOptions) {

/**
* Note: <br>
* This method has an extremely limited usage.
* This method has extremely limited usage. The majority of users should just set {@link
* WorkflowClientOptions#getContextPropagators()}
*
* <p>Both "client" (workflow worker) and "server" (activity worker) sides of context
* propagation from a workflow to an activity exist in a worker process (potentially the same
Expand Down
10 changes: 7 additions & 3 deletions temporal-sdk/src/main/java/io/temporal/client/WorkflowOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,13 @@ public Builder setSearchAttributes(Map<String, Object> searchAttributes) {
}

/**
* @param contextPropagators specifies the list of context propagators to use during this
* workflow. This list overrides the list specified on {@link
* WorkflowClientOptions#getContextPropagators()}, {@code null} means no overriding
* This list of context propagators overrides the list specified on {@link
* WorkflowClientOptions#getContextPropagators()}. <br>
* This method is uncommon, the majority of users should just set {@link
* WorkflowClientOptions#getContextPropagators()}
*
* @param contextPropagators specifies the list of overriding context propagators, {@code null}
* means no overriding.
*/
public Builder setContextPropagators(@Nullable List<ContextPropagator> contextPropagators) {
this.contextPropagators = contextPropagators;
Expand Down
7 changes: 5 additions & 2 deletions temporal-sdk/src/main/java/io/temporal/common/context/ContextPropagator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@
import java.util.Map;

/**
* Context Propagators are used to propagate information from workflow to activity, workflow to
* child workflow, and workflow to child thread (using {@link io.temporal.workflow.Async}).
* Context Propagators are used to propagate information from the workflow client to workflow
* execution, workflow to activity, workflow to child workflow, and workflow to child thread created
* using {@link io.temporal.workflow.Async}. <br>
* The propagation works from top to bottom, lower level contexts are not propagated back to the
* top.
*
* <p>A sample <code>ContextPropagator</code> that copies all {@link org.slf4j.MDC} entries starting
* with a given prefix along the code path looks like this:
Expand Down