com.aerospike.connect.outbound.transformer.Transformer Maven / Gradle / Ivy
Show all versions of aerospike-connect-outbound-sdk Show documentation
/*
*
* Copyright 2012-2022 Aerospike, Inc.
*
* Portions may be licensed to Aerospike, Inc. under one or more contributor
* license agreements WHICH ARE COMPATIBLE WITH THE APACHE LICENSE, VERSION 2.0.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.aerospike.connect.outbound.transformer;
import com.aerospike.connect.outbound.ChangeNotificationRecord;
import com.aerospike.connect.outbound.format.Formatter;
import lombok.NonNull;
/**
* Transform the Aerospike record like add bin, delete bin, modify bin value,
* modify key, modify metadata (generation, last update time, expiry).
*
*
* The transformed record is either passed as input to a {@link Formatter} or is
* processed into one of the built-in outbound formats - Avro, MessagePack,
* etc.
*/
public interface Transformer {
/**
* Transform the Aerospike record like add bin, delete bin, modify bin
* value, modify key, modify metadata (generation, last update time,
* expiry).
*
*
* To skip dispatching the change notification record to the outbound
* destination return instances of {@link SkipChangeNotificationRecord}.
*
*
* When an exception is thrown by this method, the record is acknowledged
* with temporary error to Aerospike XDR change notification. Aerospike XDR
* change notification will resend the change notification record on a
* temporary error.
*
*
* The returned {@link ChangeNotificationRecord} bins can contain plain Java
* objects or/and Aerospike client {@link com.aerospike.client.Value
* Values}. When the transformed record is used as input to the FlatJSON,
* JSON, MessagePack built-in outbound formats there are differences in
* their formatting as mentioned below
*
* Type handling summary
*
* Value
* Java Type
* Aerospike client {@link com.aerospike.client.Value Value} type
*
*
*
* Geo JSON String
* If represented as a Java String it is stored as plain string in
* Json, FlatJSON and MessagePack outbound format.
* If represented as
* {@link com.aerospike.client.Value.GeoJSONValue GeoJSONValue} it is
* stored
*
* - as a JSON object in Json and FlatJSON outbound format
* - as a bin with GeoJSON type in top level bin and as a
* MessagePack ext format type (with ext type equal to GeoJSON) in maps
* and lists, in MessagePack outbound format.
*
*
*
*
*
* Java blob, C# blob, Python blob, Ruby blob, PHP blob, Erlang
* blob and HLL types
* If represented by Java byte array (byte[]) it is
* stored
*
* - as Base64 encoded string in Json and FlatJSON outbound
* format
* - as a Blob type in top level bin and as a binary value in
* maps and lists, in MessagePack outbound format.
*
*
* If represented as a
* {@link com.aerospike.client.Value.BytesValue BytesValue} it is
* stored
*
* - as a Base64 encode string in Json and FlatJSON outbound
* format
*
* - as a bin with the exact type in top level bin and as a
* MessagePack ext format type (with ext type equal to the type)
* in maps and lists, in MessagePack outbound format.
*
*
*
*
* @param record the change notification record.
* @return the transformed change notification record.
* @throws Exception if failed to transform the record. The record is
* acknowledged with temporary error to Aerospike XDR
* change notification.
*/
ChangeNotificationRecord transform(@NonNull ChangeNotificationRecord record)
throws Exception;
}