software.amazon.awssdk.eventstreamrpc.MessageAmendInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-iot-device-sdk Show documentation

Java bindings for the AWS IoT Core Service

There is a newer version: 1.21.0

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

/* This file is part of greengrass-ipc project. */

package software.amazon.awssdk.eventstreamrpc;

import software.amazon.awssdk.crt.eventstream.Header;

import java.util.List;

/**
 * Small data class used to hold information that may be used differently depending on the context
 *
 * For sending messages, the headers stored in the object may be used to append to existing headers,
 * where it won't overwrite an existing one that may be outgoing.
 *
 * The payload may or may not be used. Refer to the method that accepts or expects this structure to
 * understand what parts are used and which are not. For example, for EventStreamRPCConnection's
 * connect() method, the headers are used verbatim into the activate request and the payload too.
 *
 * For a sendStreamEvent(obj, amendInfo) hypothetical overload, only the headers that don't overwrite
 * :content-type, service-model-type would be used, and the payload would be completely ignored from
 * this structure.
 */
public class MessageAmendInfo {
    private final List headers;
    private final byte[] payload;

    /**
     * Constructs a new MessageAmendInfo
     * @param headers The headers to store
     * @param payload The payload to store
     */
    public MessageAmendInfo(List headers, byte[] payload) {
        this.headers = headers;
        this.payload = payload;
    }

    /**
     * Returns the headers stored in the object. For sent messages,
     * the headers stored in the object may be used to append to existing headers,
     * where it won't overwrite an existing one that may be outgoing.
     *
     * @return The headers stored
     */
    public List getHeaders() {
        return headers;
    }

    /**
     * Returns the payload stored in the object. A payload may, or may not, be used
     * in a given MessageAmendInfo. Refer to the method that accepts or expects this
     * structure to understand what parts are used and which are not.
     * @return The payload stored
     */
    public byte[] getPayload() {
        return payload;
    }
}