WireMock.Net-wiremock/src/WireMock.Net/RequestBuilders/IHeadersRequestBuilder.cs

using JetBrains.Annotations;
using System;
using System.Collections.Generic;
using WireMock.Matchers;

namespace WireMock.RequestBuilders
{
    /// <summary>
    /// The HeadersRequestBuilder interface.
    /// </summary>
    public interface IHeadersRequestBuilder : ICookiesRequestBuilder
    {
        /// <summary>
        /// WithHeader: matching based on name, pattern and matchBehaviour.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="pattern">The pattern.</param>
        /// <param name="matchBehaviour">The match behaviour.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, string pattern, MatchBehaviour matchBehaviour);

        /// <summary>
        /// WithHeader: matching based on name, pattern, ignoreCase and matchBehaviour.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="pattern">The pattern.</param>
        /// <param name="ignoreCase">Ignore the case from the pattern.</param>
        /// <param name="matchBehaviour">The match behaviour.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, string pattern, bool ignoreCase = true, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);

        /// <summary>
        /// WithHeader: matching based on name, patterns and matchBehaviour.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="patterns">The patterns.</param>
        /// <param name="matchBehaviour">The match behaviour.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, string[] patterns, MatchBehaviour matchBehaviour);

        /// <summary>
        /// WithHeader: matching based on name, patterns, ignoreCase and matchBehaviour.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="patterns">The patterns.</param>
        /// <param name="ignoreCase">Ignore the case from the pattern.</param>
        /// <param name="matchBehaviour">The match behaviour.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, string[] patterns, bool ignoreCase = true, MatchBehaviour matchBehaviour = MatchBehaviour.AcceptOnMatch);

        /// <summary>
        /// WithHeader: matching based on name and IStringMatcher[].
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="matchers">The matchers.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, [NotNull] params IStringMatcher[] matchers);

        /// <summary>
        /// WithHeader: matching based on name, ignoreCase and IStringMatcher[].
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="ignoreCase">Ignore the case from the header-keys.</param>
        /// <param name="matchers">The matchers.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, bool ignoreCase, [NotNull] params IStringMatcher[] matchers);

        /// <summary>
        /// WithHeader: matching based on name, ignoreCase, matchBehaviour and IStringMatcher[].
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="ignoreCase">Ignore the case from the header-keys.</param>
        /// <param name="matchBehaviour">The match behaviour.</param>
        /// <param name="matchers">The matchers.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] string name, bool ignoreCase, MatchBehaviour matchBehaviour, [NotNull] params IStringMatcher[] matchers);

        /// <summary>
        /// WithHeader: matching based on functions.
        /// </summary>
        /// <param name="funcs">The headers funcs.</param>
        /// <returns>The <see cref="IRequestBuilder"/>.</returns>
        IRequestBuilder WithHeader([NotNull] params Func<IDictionary<string, string[]>, bool>[] funcs);
    }
}