com.github.tomakehurst.wiremock.client.MappingBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation
A web service test double for all occasions - standalone edition
There is a newer version: 3.9.1
/*
 * Copyright (C) 2011-2023 Thomas Akehurst
 *
 * 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 com.github.tomakehurst.wiremock.client;

import com.github.tomakehurst.wiremock.common.Metadata;
import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.ServeEventListener;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.matching.ContentPattern;
import com.github.tomakehurst.wiremock.matching.MultiValuePattern;
import com.github.tomakehurst.wiremock.matching.MultipartValuePatternBuilder;
import com.github.tomakehurst.wiremock.matching.StringValuePattern;
import com.github.tomakehurst.wiremock.matching.ValueMatcher;
import com.github.tomakehurst.wiremock.stubbing.StubMapping;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

public interface MappingBuilder {

  MappingBuilder withScheme(String scheme);

  MappingBuilder withHost(StringValuePattern hostPattern);

  MappingBuilder withPort(int port);

  MappingBuilder atPriority(Integer priority);

  MappingBuilder withHeader(String key, StringValuePattern headerPattern);

  MappingBuilder withHeader(String key, MultiValuePattern headerPattern);

  MappingBuilder withPathParam(String name, StringValuePattern pattern);

  MappingBuilder withQueryParam(String key, StringValuePattern queryParamPattern);

  MappingBuilder withQueryParam(String key, MultiValuePattern multiValueQueryParamPattern);

  MappingBuilder withFormParam(String key, StringValuePattern formParamPattern);

  MappingBuilder withFormParam(String key, MultiValuePattern multiValueFormParamPattern);

  MappingBuilder withQueryParams(Map queryParams);

  MappingBuilder withRequestBody(ContentPattern bodyPattern);

  MappingBuilder withMultipartRequestBody(MultipartValuePatternBuilder multipartPatternBuilder);

  ScenarioMappingBuilder inScenario(String scenarioName);

  MappingBuilder withId(UUID id);

  MappingBuilder withName(String name);

  MappingBuilder persistent();

  MappingBuilder persistent(boolean persistent);

  MappingBuilder withBasicAuth(String username, String password);

  MappingBuilder withCookie(String name, StringValuePattern cookieValuePattern);

   MappingBuilder withPostServeAction(String extensionName, P parameters);

  default 
 MappingBuilder withServeEventListener(
      ServeEventListener.RequestPhase requestPhase, String extensionName, P parameters) {
    return withServeEventListener(Set.of(requestPhase), extensionName, parameters);
  }

  
 MappingBuilder withServeEventListener(
      Set requestPhases, String extensionName, P parameters);

   MappingBuilder withServeEventListener(String extensionName, P parameters);

  MappingBuilder withMetadata(Map metadata);

  MappingBuilder withMetadata(Metadata metadata);

  MappingBuilder withMetadata(Metadata.Builder metadata);

  MappingBuilder andMatching(ValueMatcher requestMatcher);

  MappingBuilder andMatching(String customRequestMatcherName);

  MappingBuilder andMatching(String customRequestMatcherName, Parameters parameters);

  MappingBuilder willReturn(ResponseDefinitionBuilder responseDefBuilder);

  StubMapping build();
}