com.aerospike.connect.outbound.routing.Router 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.routing;

import com.aerospike.connect.outbound.ChangeNotificationRecord;
import com.aerospike.connect.outbound.pubsub.PubSubOutboundRoute;
import lombok.NonNull;

/**
 * Route records to the outbound destination.
 *
 * @param  the type of the outbound route. Should be a String type for ESP
 *            (Event Stream Processing), JMS, Kafka, Pulsar routes; and a {@link
 *            PubSubOutboundRoute PubSubOutboundRoute} type for Google Pub/Sub.
 */
public interface Router {
    /**
     * Get the route for the record.
     *
     * 
     * If the returned route has route type {@link OutboundRouteType#SKIP SKIP}
     * then the change notification record is skipped, and not dispatched to the
     * outbound destination.
     *
     * 
     * 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.
     *
     * @param record the change notification record.
     * @return the route for the record.
     * @throws Exception if failed to route the record. The record is
     *                   acknowledged with temporary error to Aerospike XDR
     *                   change notification.
     */
    OutboundRoute getRoute(@NonNull ChangeNotificationRecord record)
            throws Exception;
}