001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2019-2021 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.sync.types; 028 029/** 030 * This interface represents a single kafka message. 031 */ 032public interface KafkaMessage { 033 034 /** 035 * Return the Kafka partition key. 036 * 037 * @return The Kafka partition key. 038 */ 039 String getKey(); 040 041 /** 042 * Set the Kafka partition key. 043 * 044 * @param key The new Kafka partition key. 045 */ 046 void setKey(final String key); 047 048 /** 049 * Return the value in the Kafka message. Unless changed by 050 * another plugin, this value will be a valid JSON object 051 * formatted as a string. 052 * 053 * @return The value in the Kafka message. 054 */ 055 String getValue(); 056 057 /** 058 * Set the value in the Kafka message. The value provided 059 * need not be JSON. 060 * 061 * @param value The new value in the Kafka message. 062 */ 063 void setValue(final String value); 064}