com.hubrick.vertx.rest.RestClient Maven / Gradle / Ivy
/**
* Copyright (C) 2015 Etaia AS ([email protected])
*
* 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.hubrick.vertx.rest;
import com.hubrick.vertx.rest.converter.HttpMessageConverter;
import com.hubrick.vertx.rest.impl.DefaultRestClient;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.http.HttpMethod;
import java.util.List;
/**
* An REST client that maintains a pool of connections to a specific host, at a specific port. The client supports
* pipelining of requests.
* If an instance is instantiated from an event loop then the handlers
* of the instance will always be called on that same event loop.
* If an instance is instantiated from some other arbitrary Java thread (i.e. when running embedded) then
* and event loop will be assigned to the instance and used when any of its handlers
* are called.
* Instances of RestClient are thread-safe.
*
* @author Emir Dizdarevic
* @since 1.0.0
*/
public interface RestClient {
/**
* Creates an instance of {@link DefaultRestClient}
*
* @param vertx The vertx instance
* @param clientOptions Rest client options
* @param httpMessageConverters defined http message converters
* @return A instance of RxRestClient
*/
static RestClient create(Vertx vertx, RestClientOptions clientOptions, List httpMessageConverters) {
return new DefaultRestClient(vertx, clientOptions, httpMessageConverters);
}
/**
* Creates an instance of {@link DefaultRestClient} with default RestClientOptions
*
* @param vertx The vertx instance
* @param httpMessageConverters defined http message converters
* @return A instance of RxRestClient
*/
static RestClient create(Vertx vertx, List httpMessageConverters) {
return new DefaultRestClient(vertx, new RestClientOptions(), httpMessageConverters);
}
/**
* Set an exception handler. This exception handler will be inherited by the
* {@link com.hubrick.vertx.rest.RestClientRequest} and {@link com.hubrick.vertx.rest.RestClientResponse}.
* On each level he can we overridden.
*
* @param handler The exception handler
* @return A reference to this, so multiple invocations can be chained together.
*/
RestClient exceptionHandler(Handler handler);
/**
* Close the HTTP client. This will cause any pooled HTTP connections to be closed.
*/
void close();
/**
* Makes a GET call with no response value.
*
* @param uri The uri which should be called.
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest get(String uri, Handler> responseHandler);
/**
* Makes a GET call with a expected response value.
*
* @param uri The uri which should be called.
* @param responseClass The class which represents the response
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest get(String uri, Class responseClass, Handler> responseHandler);
/**
* Makes a POST call with no response value.
*
* @param uri The uri which should be called.
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest post(String uri, Handler> responseHandler);
/**
* Makes a POST call with a expected response value.
*
* @param uri The uri which should be called.
* @param responseClass The class which represents the response
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest post(String uri, Class responseClass, Handler> responseHandler);
/**
* Makes a PUT call with no response value.
*
* @param uri The uri which should be called.
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest put(String uri, Handler> responseHandler);
/**
* Makes a PUT call with a expected response value.
*
* @param uri The uri which should be called.
* @param responseClass The class which represents the response
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest put(String uri, Class responseClass, Handler> responseHandler);
/**
* Makes a DELETE call with no response value.
*
* @param uri The uri which should be called.
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest delete(String uri, Handler> responseHandler);
/**
* Makes a DELETE call with a expected response value.
*
* @param uri The uri which should be called.
* @param responseClass The class which represents the response
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest delete(String uri, Class responseClass, Handler> responseHandler);
/**
* Makes a GET, POST, PUT or DELETE call with no response value. It's a generic method for REST calls.
*
* @param method The http method to be used for this call
* @param uri The uri which should be called.
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest request(HttpMethod method, String uri, Handler> responseHandler);
/**
* Makes a GET, POST, PUT or DELETE call with a expected response value. It's a generic method for REST calls.
*
* @param method The http method to be used for this call
* @param uri The uri which should be called.
* @param responseClass The class which represents the response
* @param responseHandler The handler for the response callback
* @return A reference to the {@link com.hubrick.vertx.rest.RestClientRequest}
*/
RestClientRequest request(HttpMethod method, String uri, Class responseClass, Handler> responseHandler);
}