View Javadoc
1   package ca.uhn.fhir.rest.client.api;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  import java.io.IOException;
24  
25  /**
26   * This interface represents an interceptor which can be used to access (and optionally change or take actions upon)
27   * requests that are being sent by the HTTP client, and responses received by it.
28   * <p>
29   * See the <a href="http://jamesagnew.github.io/hapi-fhir/doc_rest_client_interceptor.html">HAPI Documentation Client Interceptor</a>
30   * page for more information on how to use this feature.
31   * </p> 
32   */
33  public interface IClientInterceptor {
34  
35  	/**
36  	 * Fired by the client just before invoking the HTTP client request
37  	 */
38  	void interceptRequest(IHttpRequest theRequest);
39  	
40  	/**
41  	 * Fired by the client upon receiving an HTTP response, prior to processing that response
42  	 */
43  	void interceptResponse(IHttpResponse theResponse) throws IOException;
44  
45  }