xref: /external/mockwebserver/src/main/java/com/google/mockwebserver/Dispatcher.java

/*
 * Copyright (C) 2012 Google Inc.
 *
 * 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.google.mockwebserver;

/**
 * Handler for mock server requests.
 */
public abstract class Dispatcher {
    /**
     * Returns a response to satisfy {@code request}. This method may block (for
     * instance, to wait on a CountdownLatch).
     */
    public abstract MockResponse dispatch(RecordedRequest request) throws InterruptedException;

    /**
     * Returns an early guess of the next response, used for policy on how an
     * incoming request should be received. The default implementation returns an
     * empty response. Mischievous implementations can return other values to test
     * HTTP edge cases, such as unhappy socket policies or throttled request
     * bodies.
     */
    public MockResponse peek() {
        return new MockResponse().setSocketPolicy(SocketPolicy.KEEP_OPEN);
    }
}