fr.speekha.httpmocker.policies.FilingPolicy.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mocker Show documentation

A simple mocking lib for OkHttp

The newest version!

/*
 * Copyright 2019 David Blanc
 *
 * 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 fr.speekha.httpmocker.policies

import okhttp3.Request

/**
 * Allows to specify path and naming conventions for configuration files.
 */
interface FilingPolicy {

    /**
     * Computes the path where the appropriate configuration file should be for this request.
     * @param request the intercepted OkHttpRequest
     * @return the path where the JSON configuration can be loaded
     */
    fun getPath(request: Request): String
}