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