com.expediagroup.graphql.client.serializer.GraphQLClientSerializer.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 Expedia, Inc
 *
 * Licensed 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
 *
 *     https://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 com.expediagroup.graphql.client.serializer

import com.expediagroup.graphql.client.types.GraphQLClientRequest
import com.expediagroup.graphql.client.types.GraphQLClientResponse
import java.util.ServiceLoader
import kotlin.reflect.KClass

/**
 * Load first available GraphQL serializer from a classpath using service loader.
 */
fun defaultGraphQLSerializer(): GraphQLClientSerializer = ServiceLoader.load(GraphQLClientSerializer::class.java)
    .firstOrNull() ?: throw MissingDefaultGraphQLClientSerializerException

/**
 * GraphQL request/response serializer.
 */
interface GraphQLClientSerializer {

    /**
     * Serialize GraphQLClientRequest (or batch request) to a raw String representation.
     */
    fun serialize(request: GraphQLClientRequest<*>): String

    /**
     * Serialize GraphQLClientRequest (or batch request) to a raw String representation.
     */
    fun serialize(requests: List>): String

    /**
     * Deserialize raw response String to a target GraphQLClientResponse.
     */
    fun  deserialize(rawResponse: String, responseType: KClass): GraphQLClientResponse

    /**
     * Deserialize raw response String to a list of GraphQLClientResponses.
     */
    fun deserialize(rawResponses: String, responseTypes: List>): List>
}