AVSDirective.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDIRECTIVE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDIRECTIVE_H_

#include <iostream>
#include <memory>
#include <string>
#include <utility>

#include "Attachment/AttachmentManagerInterface.h"
#include "AVSMessage.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace avs {

class AVSDirective : public AVSMessage {
public:
    enum class ParseStatus {
        SUCCESS,

        ERROR_INVALID_JSON,

        ERROR_MISSING_DIRECTIVE_KEY,

        ERROR_MISSING_HEADER_KEY,

        ERROR_MISSING_NAMESPACE_KEY,

        ERROR_MISSING_NAME_KEY,

        ERROR_MISSING_MESSAGE_ID_KEY,

        ERROR_MISSING_PAYLOAD_KEY
    };

    static std::pair<std::unique_ptr<AVSDirective>, ParseStatus> create(
        const std::string& unparsedDirective,
        std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> attachmentManager,
        const std::string& attachmentContextId);

    static std::unique_ptr<AVSDirective> create(
        const std::string& unparsedDirective,
        std::shared_ptr<AVSMessageHeader> avsMessageHeader,
        const std::string& payload,
        std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> attachmentManager,
        const std::string& attachmentContextId,
        const utils::Optional<AVSMessageEndpoint>& endpoint = utils::Optional<AVSMessageEndpoint>());

    std::unique_ptr<avsCommon::avs::attachment::AttachmentReader> getAttachmentReader(
        const std::string& contentId,
        utils::sds::ReaderPolicy readerPolicy) const;

    std::string getUnparsedDirective() const;

    std::string getAttachmentContextId() const;

private:
    AVSDirective(
        const std::string& unparsedDirective,
        std::shared_ptr<AVSMessageHeader> avsMessageHeader,
        const std::string& payload,
        std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> attachmentManager,
        const std::string& attachmentContextId,
        const utils::Optional<AVSMessageEndpoint>& endpoint);

    const std::string m_unparsedDirective;
    std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface> m_attachmentManager;
    std::string m_attachmentContextId;
};

inline std::string avsDirectiveParseStatusToString(AVSDirective::ParseStatus status) {
    switch (status) {
        case AVSDirective::ParseStatus::SUCCESS:
            return "SUCCESS";
        case AVSDirective::ParseStatus::ERROR_INVALID_JSON:
            return "ERROR_INVALID_JSON";
        case AVSDirective::ParseStatus::ERROR_MISSING_DIRECTIVE_KEY:
            return "ERROR_MISSING_DIRECTIVE_KEY";
        case AVSDirective::ParseStatus::ERROR_MISSING_HEADER_KEY:
            return "ERROR_MISSING_HEADER_KEY";
        case AVSDirective::ParseStatus::ERROR_MISSING_NAMESPACE_KEY:
            return "ERROR_MISSING_NAMESPACE_KEY";
        case AVSDirective::ParseStatus::ERROR_MISSING_NAME_KEY:
            return "ERROR_MISSING_NAME_KEY";
        case AVSDirective::ParseStatus::ERROR_MISSING_MESSAGE_ID_KEY:
            return "ERROR_MISSING_MESSAGE_ID_KEY";
        case AVSDirective::ParseStatus::ERROR_MISSING_PAYLOAD_KEY:
            return "ERROR_MISSING_PAYLOAD_KEY";
    }
    return "UNKNOWN_STATUS";
}

inline std::ostream& operator<<(std::ostream& stream, const AVSDirective::ParseStatus& status) {
    return stream << avsDirectiveParseStatusToString(status);
}

}  // namespace avs
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_AVS_INCLUDE_AVSCOMMON_AVS_AVSDIRECTIVE_H_