Skip to content

Improve PayloadConverter javadoc regarding providing of EncodingKeys#METADATA_ENCODING_KEY #702

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
Spikhalskiy merged 2 commits into from
Sep 9, 2021
Merged

Improve PayloadConverter javadoc regarding providing of EncodingKeys#METADATA_ENCODING_KEY #702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b990a81
Improve PayloadConverter javadoc regarding providing of EncodingKeys#…
Spikhalskiy Sep 8, 2021
a242557
Update temporal-sdk/src/main/java/io/temporal/common/converter/Payloa…
Spikhalskiy Sep 8, 2021
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: 2 additions & 2 deletions temporal-sdk/src/main/java/io/temporal/common/converter/EncodingKeys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
import com.google.protobuf.ByteString;
import java.nio.charset.StandardCharsets;

class EncodingKeys {
static final String METADATA_ENCODING_KEY = "encoding";
public class EncodingKeys {
public static final String METADATA_ENCODING_KEY = "encoding";

static final String METADATA_ENCODING_NULL_NAME = "binary/null";
static final ByteString METADATA_ENCODING_NULL =
Expand Down
11 changes: 11 additions & 0 deletions temporal-sdk/src/main/java/io/temporal/common/converter/PayloadConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

package io.temporal.common.converter;

import com.google.protobuf.ByteString;
import io.temporal.api.common.v1.Payload;
import java.lang.reflect.Type;
import java.util.Optional;
Expand All @@ -31,6 +32,15 @@
*/
public interface PayloadConverter {

/**
* Each {@link PayloadConverter} has an Encoding Type that it handles. Each {@link
* PayloadConverter} should add the information about its Encoding Type into the {@link Payload} it
* produces inside {@link #toData(Object)} by associating it with the {@link
* EncodingKeys#METADATA_ENCODING_KEY} key attached to the {@code Payload}'s Metadata using {@link
* Payload.Builder#putMetadata(String, ByteString)}.
*
* @return encoding type that this converter handles.
*/
String getEncodingType();

/**
Expand All @@ -40,6 +50,7 @@ public interface PayloadConverter {
* @return converted value
* @throws DataConverterException if conversion of the value passed as parameter failed for any
* reason.
* @see #getEncodingType() getEncodingType javadoc for an important implementation detail
*/
Optional<Payload> toData(Object value) throws DataConverterException;

Expand Down
2 changes: 1 addition & 1 deletion temporal-sdk/src/main/java/io/temporal/internal/common/HeaderUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public static Header toHeaderGrpc(
}

/**
* Converts a Map<String, Object> into a Map<String, Payload> by applying specified converter on
* Converts a {@code Map<String, Object>} into a {@code Map<String, Payload>} by applying specified converter on
* each value. This util should be used for things like search attributes and memo that need to be
* converted back from bytes on the server.
*/
Expand Down
2 changes: 1 addition & 1 deletion temporal-sdk/src/main/java/io/temporal/workflow/Workflow.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ public static <T> Object getMemo(String key, Class<T> valueClass) {
/**
* Extract Memo associated with the given key and deserialized into an object of generic type as
* is done here: {@link DataConverter#fromPayloads(int, java.util.Optional, java.lang.Class,
* java.lang.reflect.Type)} Ex: To deserialize into HashMap<String, Integer> <code>
* java.lang.reflect.Type)} Ex: To deserialize into {@code HashMap<String, Integer>} <code>
* Workflow.getMemo(key, Map.class, new TypeToken<HashMap<String, Integer>>() {}.getType());
* </code>
*
Expand Down