001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.test.web.client;
018
019import java.io.IOException;
020
021import org.springframework.http.client.ClientHttpRequest;
022
023/**
024 * A contract for matching requests to expectations.
025 *
026 * <p>See {@link org.springframework.test.web.client.match.MockRestRequestMatchers
027 * MockRestRequestMatchers} for static factory methods.
028 *
029 * @author Craig Walls
030 * @since 3.2
031 */
032@FunctionalInterface
033public interface RequestMatcher {
034
035        /**
036         * Match the given request against specific expectations.
037         * @param request the request to make assertions on
038         * @throws IOException in case of I/O errors
039         * @throws AssertionError if expectations are not met
040         */
041        void match(ClientHttpRequest request) throws IOException, AssertionError;
042
043}