com.aerospike.connect.outbound.ChangeNotificationRecord Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aerospike-connect-outbound-sdk Show documentation
Outbound connector SDK for change notification transformers.
The newest version!
/*
 *
 *  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;

import com.aerospike.connect.outbound.format.Formatter;
import com.aerospike.connect.outbound.routing.Router;
import com.aerospike.connect.outbound.transformer.Transformer;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;

import java.util.Collections;
import java.util.Map;

/**
 * A notification record shipped by Aerospike change notification when records
 * are inserted, modified or deleted in an Aerospike database.
 */
@EqualsAndHashCode
@Getter
@ToString
public class ChangeNotificationRecord {
    /**
     * @return Metadata of the changed record.
     */
    @NonNull
    private final ChangeNotificationMetadata metadata;

    /**
     * An unmodifiable map of bin name to bin value of the record. Will be empty
     * in case of a delete operation.
     *
     * 
     * When passed as input to the {@link Formatter}, {@link Router}, or {@link
     * Transformer} the blob and GeoJSON values in top level bins, in maps and
     * lists are formatted as mentioned below
     * 

     *     Java blob, C# blob, Python blob, Ruby blob, PHP blob, Erlang
     *     blob and HLL types; are formatted as
     *     {@link com.aerospike.client.Value.BytesValue BytesValue}. The
     *     BytesValue stores the underlying byte array and the
     *     {@link ParticleType}. The
     *     consuming code can choose to interpret the byte array based on the
     *     type of the value: for example the consuming code can choose to
     *     deserialize the Java blob.
     *     
     *     the GeoJSON types are formatted as
     *     {@link com.aerospike.client.Value.GeoJSONValue GeoJSONValue.}
     *     
     *     plain Byte arrays (byte[]) are formatted as
     *     {@link com.aerospike.client.Value.BytesValue BytesValue} with
     *     type as {@link ParticleType#BLOB Blob}.
     * 
     *
     * 
     * For details on the bin values to be returned by transformers see
     * {@link Transformer#transform}.
     *
     * @return An unmodifiable map of bin name to bin value of the record. Will
     * be empty in case of a delete operation.
     */
    @NonNull
    private final Map bins;

    public ChangeNotificationRecord(
            @NonNull ChangeNotificationMetadata metadata,
            @NonNull Map bins) {
        this.metadata = metadata;
        this.bins = Collections.unmodifiableMap(bins);
    }
}