net.nemerosa.ontrack.kdsl.connector.Connector.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-kdsl Show documentation

Ontrack module: ontrack-kdsl

There is a newer version: 4.4.5

package net.nemerosa.ontrack.kdsl.connector

/**
 * Raw HTTP connection.
 */
interface Connector {

    /**
     * Associated URL
     */
    val url: String

    /**
     * Associated token, if any
     */
    val token: String?

    /**
     * Gets some content from a relative URL.
     */
    fun get(
        path: String,
        headers: Map = emptyMap(),
    ): ConnectorResponse

    /**
     * Post a payload to a relative URL.
     */
    fun post(
        path: String,
        headers: Map = emptyMap(),
        body: Any? = null,
    ): ConnectorResponse

    /**
     * Puts a payload to a relative URL.
     */
    fun put(
        path: String,
        headers: Map = emptyMap(),
        body: Any? = null,
    )

}