Package ai.mindconnect.workflow.jackson

Class JacksonWorkflowSerializer

java.lang.Object

ai.mindconnect.workflow.jackson.JacksonWorkflowSerializer

public class JacksonWorkflowSerializer
extends Object

High-level serializer / deserializer for WorkflowData definitions.

This is the primary API for persisting and loading workflow definitions when using the Jackson integration module.

Example:

 JacksonWorkflowSerializer serializer = new JacksonWorkflowSerializer(
         WorkflowObjectMapperFactory.create());

 // Deserialize
 WorkflowData wd = serializer.read(path);

 // Serialize
 String json = serializer.write(wd);
 

Constructor Summary

Constructors

Constructor	Description
JacksonWorkflowSerializer()

Method Summary

Modifier and Type	Method	Description
WorkflowData	read(InputStream is)	Deserializes a WorkflowData from an InputStream.
WorkflowData	read(String json)	Deserializes a WorkflowData from a JSON string.
WorkflowData	read(Path path)	Deserializes a WorkflowData from a file path.
WorkflowData	readFromClasspath(String resourcePath)	Reads a WorkflowData from a classpath resource.
String	write(WorkflowData workflowData)	Serializes a WorkflowData to a pretty-printed JSON string.
void	write(WorkflowData workflowData, Path path)	Serializes a WorkflowData to a file, creating parent dirs as needed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JacksonWorkflowSerializer

public JacksonWorkflowSerializer()

Method Details

read

public WorkflowData read(String json)

Deserializes a WorkflowData from a JSON string.

read

public WorkflowData read(Path path)

Deserializes a WorkflowData from a file path.

read

public WorkflowData read(InputStream is)

Deserializes a WorkflowData from an InputStream.

readFromClasspath

public WorkflowData readFromClasspath(String resourcePath)

Reads a WorkflowData from a classpath resource.

Parameters:

resourcePath - classpath-relative path, e.g. /workflows/my_flow.json

write

public String write(WorkflowData workflowData)

Serializes a WorkflowData to a pretty-printed JSON string.

write

public void write(WorkflowData workflowData,
 Path path)

Serializes a WorkflowData to a file, creating parent dirs as needed.