tech.sirwellington.alchemy.http.Step3Impl.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemy-http Show documentation

Part of the Alchemy Collection. REST without the MESS. Makes it dead-easy to call RESTful Web Services in Java. It is designed for interactions with APIs written in REST and JSON.

There is a newer version: 3.4.1

Show newest version

/*
 * Copyright © 2019. Sir Wellington.
 * 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
 *     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 tech.sirwellington.alchemy.http

import tech.sirwellington.alchemy.annotations.access.Internal
import tech.sirwellington.alchemy.annotations.designs.StepMachineDesign
import tech.sirwellington.alchemy.annotations.designs.StepMachineDesign.Role.STEP
import tech.sirwellington.alchemy.arguments.Arguments.checkThat
import tech.sirwellington.alchemy.arguments.assertions.greaterThanOrEqualTo
import tech.sirwellington.alchemy.arguments.assertions.nonEmptyString
import tech.sirwellington.alchemy.http.HttpAssertions.validResponseClass
import tech.sirwellington.alchemy.http.exceptions.AlchemyHttpException
import java.net.URL

/**
 *
 * @author SirWellington
 */
@Internal
@StepMachineDesign(role = STEP)
internal class Step3Impl(private val stateMachine: AlchemyHttpStateMachine,
                         private var request: HttpRequest) : AlchemyRequestSteps.Step3
{

    @Throws(IllegalArgumentException::class)
    override fun usingHeader(key: String, value: String): AlchemyRequestSteps.Step3
    {
        checkThat(key)
                .usingMessage("missing key")
                .isA(nonEmptyString())

        val newHeader = Pair(key, value)

        val newRequestHeaders = request.requestHeaders?.plus(newHeader) ?: mapOf(newHeader)

        this.request = HttpRequest.Builder
                                  .from(request)
                                  .usingRequestHeaders(newRequestHeaders)
                                  .build()

        return this
    }

    @Throws(IllegalArgumentException::class)
    override fun usingQueryParam(name: String, value: String): AlchemyRequestSteps.Step3
    {
        checkThat(name, value)
                .usingMessage("missing name or value")
                .are(nonEmptyString())

        val newParam = Pair(name, value)
        val queryParams = request.queryParams?.plus(newParam) ?: mapOf(newParam)

        request = HttpRequest.Builder
                             .from(request)
                             .usingQueryParams(queryParams)
                             .build()

        return this
    }

    @Throws(IllegalArgumentException::class)
    override fun followRedirects(maxNumberOfTimes: Int): AlchemyRequestSteps.Step3
    {
        checkThat(maxNumberOfTimes).isA(greaterThanOrEqualTo(1))

        //TODO: Implement this
        //Not doing anything with this yet.

        return this
    }

    @Throws(AlchemyHttpException::class)
    override fun at(url: URL): HttpResponse
    {
        //Ready to do a sync request
        val requestCopy = HttpRequest.Builder
                                     .from(request)
                                     .usingUrl(url)
                                     .build()

        //Tell the Step Machine to perform a Sync Request
        return stateMachine.executeSync(requestCopy)
    }

    override fun onSuccess(onSuccessCallback: AlchemyRequestSteps.OnSuccess): AlchemyRequestSteps.Step5
    {
        return stateMachine.jumpToStep5(request, HttpResponse::class.java, onSuccessCallback)
    }

    @Throws(IllegalArgumentException::class)
    override fun  expecting(classOfResponseType: Class): AlchemyRequestSteps.Step4
    {
        checkThat(classOfResponseType).isA(validResponseClass())

        return stateMachine.jumpToStep4(request, classOfResponseType)
    }

    override fun toString(): String
    {
        return "Step3Impl{request=$request, stateMachine=$stateMachine}"
    }

}