944-update_with_upstream

github: bitfireAT

custom: https://www.davx5.com/donate

# For most projects, this workflow file will not need changing; you simply need

# to commit it to your repository.

#

# You may wish to alter this file to override the set of languages analyzed,

# or to provide custom queries or build logic.

#

# ******** NOTE ********

# We have attempted to detect the languages in your repository. Please check

# the `language` matrix defined below to confirm you have the correct set of

# supported CodeQL languages.

#

name: "CodeQL"

on:

  push:

    branches: [ "main" ]

  pull_request:

    # The branches below must be a subset of the branches above

    branches: [ "main" ]

  schedule:

    - cron: '23 22 * * 3'

jobs:

  analyze:

    name: Analyze

    runs-on: ubuntu-latest

    permissions:

      actions: read

      contents: read

      security-events: write

    strategy:

      fail-fast: false

      matrix:

        language: [ 'java' ]

        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]

        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

    steps:

    - name: Checkout repository

      uses: actions/checkout@v3

    # Initializes the CodeQL tools for scanning.

    - name: Initialize CodeQL

      uses: github/codeql-action/init@v2

      with:

        languages: ${{ matrix.language }}

        # If you wish to specify custom queries, you can do so here or in a config file.

        # By default, queries listed here will override any specified in a config file.

        # Prefix the list here with "+" to use these queries and those in the config file.

        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs

        # queries: security-extended,security-and-quality

    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).

    # If this step fails, then you should remove it and run the build manually (see below)

    - name: Autobuild

      uses: github/codeql-action/autobuild@v2

    # ℹ️ Command-line programs to run using the OS shell.

    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

    #   If the Autobuild fails above, remove it and uncomment the following three lines.

    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

    # - run: |

    #   echo "Run, Build Application using script"

    #   ./location_of_script_within_repo/buildscript.sh

    - name: Perform CodeQL Analysis

      uses: github/codeql-action/analyze@v2

      with:

        category: "/language:${{matrix.language}}"

[![Tests](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml/badge.svg)](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml)

[![License](https://img.shields.io/github/license/bitfireAT/dav4jvm)](https://github.com/bitfireAT/dav4jvm/blob/main/LICENSE)

[![Tests](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml/badge.svg)](https://github.com/bitfireAT/dav4jvm/actions/workflows/test.yml)

[![JitPack](https://img.shields.io/jitpack/v/github/bitfireAT/dav4jvm)](https://jitpack.io/#bitfireAT/dav4jvm)

[![KDoc](https://img.shields.io/badge/documentation-KDoc-informational)](https://bitfireat.github.io/dav4jvm/)

# dav4jvm

been developed for [DAVx⁵](https://www.davx5.com) initially.

Repository: https://github.com/bitfireAT/dav4jvm/

(~~was: https://gitlab.com/bitfireAT/dav4jvm/~~)

Generated KDoc: https://bitfireat.github.io/dav4jvm/

object Libs {

    // okhttp HTTP library

    const val okhttpVersion = "4.9.3"

    const val okhttpVersion = "4.10.0"

    // XmlPullParser library

    const val xpp3Version = "1.1.6"

}

group="com.github.bitfireAT"

version="2.1.3"

version="2.2"

plugins {

    kotlin("jvm")

    `maven-publish`

    id("org.jetbrains.dokka") version "1.5.0"

    id("org.jetbrains.dokka") version "1.7.20"

}

publishing {

            moduleName.set("dav4jvm")

            sourceLink {

                localDirectory.set(file("src/main/kotlin"))

                remoteUrl.set(URL("https://gitlab.com/bitfireAT/dav4jvm/tree/master/src/main/kotlin"))

                remoteUrl.set(URL("https://github.com/bitfireAT/dav4jvm/tree/main/src/main/kotlin/"))

                remoteLineSuffix.set("#L")

            }

        }

/*

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 */

package at.bitfire.dav4jvm

/**

 * Callback for the OPTIONS request.

 */

fun interface CapabilitiesCallback {

    fun onCapabilities(davCapabilities: Set<String>, response: okhttp3.Response)

}

/**

 * Callback for 207 Multi-Status responses.

 */

fun interface MultiResponseCallback {

    /**

     * Called for every `<response>` element in the `<multistatus>` body. For instance,

     * in response to a `PROPFIND` request, this callback will be called once for every found

     * member resource.

     *

     * @param response   the parsed response (including URL)

     * @param relation   relation of the response to the called resource

     */

    fun onResponse(response: Response, relation: Response.HrefRelation)

}

/**

 * Callback for HTTP responses.

 */

fun interface ResponseCallback {

    /**

     * Called for a HTTP response. Typically this is only called for successful/redirect

     * responses because HTTP errors throw an exception before this callback is called.

     */

    fun onResponse(response: okhttp3.Response)

}