001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.client.api;
021
022import ca.uhn.fhir.interceptor.api.Hook;
023import ca.uhn.fhir.interceptor.api.Pointcut;
024
025import java.io.IOException;
026
027/**
028 * This interface represents an interceptor which can be used to access (and optionally change or take actions upon)
029 * requests that are being sent by the HTTP client, and responses received by it.
030 * <p>
031 * See the <a href="https://hapifhir.io/hapi-fhir/docs/interceptors/client_interceptors.html">HAPI Documentation Client Interceptor</a>
032 * page for more information on how to use this feature.
033 * </p>
034 */
035public interface IClientInterceptor {
036
037        /**
038         * Fired by the client just before invoking the HTTP client request
039         */
040        @Hook(Pointcut.CLIENT_REQUEST)
041        void interceptRequest(IHttpRequest theRequest);
042
043        /**
044         * Fired by the client upon receiving an HTTP response, prior to processing that response
045         */
046        @Hook(Pointcut.CLIENT_RESPONSE)
047        void interceptResponse(IHttpResponse theResponse) throws IOException;
048}