NiFiDataPacket.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.flink.streaming.connectors.nifi;

import java.util.Map;

/**
 * <p>
 * The NiFiDataPacket provides a packaging around a NiFi FlowFile. It wraps both
 * a FlowFile's content and its attributes so that they can be processed by Flink.
 * </p>
 */
public interface NiFiDataPacket {

	/**
	 * @return the contents of a NiFi FlowFile
	 */
	byte[] getContent();

	/**
	 * @return a Map of attributes that are associated with the NiFi FlowFile
	 */
	Map<String, String> getAttributes();

}