com.smartsheet.api.internal.http.HttpClient Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation

Library for connecting to Smartsheet Services

There is a newer version: 3.2.0

package com.smartsheet.api.internal.http;

/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 Smartsheet
 * %%
 * 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.
 * %[license]
 */


import com.smartsheet.api.Trace;

import java.io.Closeable;

/**
 * This interface defines methods to make an HTTP request.
 * 
 * Thread Safety: Implementation of this interface must be thread safe.
 */
public interface HttpClient extends Closeable {
	/**
	 * Make an HTTP request and return the response.
	 * 
	 * Parameters: - request : the HTTP request
	 * 
	 * Returns: the HTTP response
	 * 
	 * Exceptions: - IllegalArgumentException : if any argument is null - HttpClientException : if there is any other
	 * error occurred during the operation
	 *
	 * @param request the request
	 * @return the http response
	 * @throws HttpClientException the http client exception
	 */
	public HttpResponse request(HttpRequest request) throws HttpClientException;
	
	/**
	 * Release connection.
	 */
	public void releaseConnection();

	/**
	 * set the traces for this client
	 * @param traces the fields to include in trace-logging
	 */
	public void setTraces(Trace... traces);

	/**
	 * set whether to use nicely-formatted JSON or more compact format JSON in trace logging
	 * @param pretty whether to print JSON in a "pretty" format or compact
	 */
	public void setTracePrettyPrint(boolean pretty);
}