software.amazon.awssdk.eventstreamrpc.OperationModelContext 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.23.0
/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

package software.amazon.awssdk.eventstreamrpc;

import software.amazon.awssdk.eventstreamrpc.model.EventStreamJsonMessage;

import java.util.Optional;

/**
 * Interface used for both client and server to dictate how to handle operations modeled by implementing this
 * interface.
 *
 * Smithy code generation should produce one of these per model, but we aren't going to take steps to prevent
 * hand construction.
 *
 * @param  The initial-request
 * @param  The initial-response
 * @param  The streaming initial-request
 * @param  The streaming initial-response
 */
public interface OperationModelContext
         {

    /**
     * Returns the service model which can look up all/any Java error class types if an
     * operation throws it so the handling has a chance
     *
     * @return the service model which can look up all/any Java error class types if an
     * operation throws it so the handling has a chance
     */
    EventStreamRPCServiceModel getServiceModel();

    /**
     * Returns the canonical operation name associated with this context across any client language.
     * Namespace included
     *
     * Example: aws.greengrass#SubscribeToTopic
     * @return the canonical operation name associated with this context across any client language.
     */
    String getOperationName();

    /**
     * Returns the initial-request java class type
     * @return the initial-request java class type
     */
    Class getRequestTypeClass();

    /**
     * Returns the application model type string for the initial-request object
     * @return the application model type string for the initial-request object
     */
    String getRequestApplicationModelType();

    /**
     * Returns the initial-response java class type
     * @return the initial-response java class type
     */
    Class getResponseTypeClass();

    /**
     * Returns the application model type string for the initial response object
     * @return the application model type string for the initial response object
     */
    String getResponseApplicationModelType();

    /**
     * Returns the streaming-request java class type
     * @return the streaming-request java class type
     */
    Optional> getStreamingRequestTypeClass();

    /**
     * Returns the application model type of
     * @return the application model type of
     */
    Optional getStreamingRequestApplicationModelType();

    /**
     * Returns the streaming-response java class type
     *
     * @return the streaming-response java class type
     */
    Optional> getStreamingResponseTypeClass();

    /**
     * Returns the streaming response application model string
     *
     * @return the streaming response application model string
     */
    Optional getStreamingResponseApplicationModelType();

    /**
     * Returns true if there is a streaming request or response associated with the operation
     * or both
     * @return true if there is a streaming request or response associated with the operation
     * or both
     */
    default boolean isStreamingOperation() {
        return getStreamingRequestTypeClass().isPresent() || getStreamingResponseTypeClass().isPresent();
    }

}