Camel Components

Fory

Since Camel 4.9

Fory is a Data Format that uses the Fory Library

Apache Fory is not supporting architecture using Big Endian (s390x, for instance).

Fory Options

The Fory dataformat supports the following options which are listed below.

Name Default Java Type Description

Name	Default	Java Type	Description
unmarshalType (common)		`String`	Class of the java type to use when unmarshalling.
requireClassRegistration (security)	`true`	`Boolean`	Whether to require register classes.
threadSafe (advanced)	`true`	`Boolean`	Whether to use the threadsafe Fory.
allowAutoWiredFory (advanced)	`true`	`Boolean`	Whether to auto-discover Fory from the registry.

unmarshalType (common)

String

Class of the java type to use when unmarshalling.

requireClassRegistration (security)

true

Boolean

Whether to require register classes.

threadSafe (advanced)

true

Boolean

Whether to use the threadsafe Fory.

allowAutoWiredFory (advanced)

true

Boolean

Whether to auto-discover Fory from the registry.

Message Body

The message body at each side of the Fory data format: Marshal input and Unmarshal input are the bodies marshal and unmarshal can take, and Marshal output and Unmarshal output the body after them.

Side Body Description

Side	Body	Description
Marshal input	`map`, `list` or `pojo`	An object of the unmarshalType class, or a List, a Map or another type Fory registers itself; another class only with requireClassRegistration false. A String or bytes are serialized as objects, not written as they are.
Marshal output	`stream`, as binary	The Fory binary data in the stream cache, or a byte array when stream caching is off.
Unmarshal input	`bytes`, `stream` or `file`, as binary	Fory binary data, as marshal writes it.
Unmarshal output	`unknown`	The object marshal wrote, of the class in the data: unmarshalType only registers a class and does not convert the result.

Marshal input

map, list or pojo

An object of the unmarshalType class, or a List, a Map or another type Fory registers itself; another class only with requireClassRegistration false. A String or bytes are serialized as objects, not written as they are.

Marshal output

stream, as binary

The Fory binary data in the stream cache, or a byte array when stream caching is off.

Unmarshal input

bytes, stream or file, as binary

Fory binary data, as marshal writes it.

Unmarshal output

unknown

The object marshal wrote, of the class in the data: unmarshalType only registers a class and does not convert the result.

The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers are described in the Camel Catalog.

Usage

Fory only serializes registered classes by default (requireClassRegistration). The data format registers the unmarshalType class, so set it on marshal as well as on unmarshal:

- route:
    from:
      uri: direct:marshal
      steps:
        - marshal:
            fory:
              unmarshalType: com.example.Order
        - to:
            uri: mock:marshal
- route:
    from:
      uri: direct:unmarshal
      steps:
        - unmarshal:
            fory:
              unmarshalType: com.example.Order
        - to:
            uri: mock:unmarshal

Dependencies

To use Fory in your camel routes, you need to add the dependency on camel-fory which implements this data format.

If you use maven, you could add the following to your pom.xml, substituting the version number for the latest and greatest release.

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-fory</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>