com.hubrick.vertx.rest.rx.RxRestClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-rest-client Show documentation
Vert.x REST client
The newest version!
/**
 * 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.rx;

import com.hubrick.vertx.rest.RestClient;
import com.hubrick.vertx.rest.RestClientOptions;
import com.hubrick.vertx.rest.RestClientRequest;
import com.hubrick.vertx.rest.RestClientResponse;
import com.hubrick.vertx.rest.converter.HttpMessageConverter;
import com.hubrick.vertx.rest.rx.impl.DefaultRxRestClient;
import io.vertx.core.Vertx;
import io.vertx.core.http.HttpMethod;
import rx.Single;
import rx.functions.Action1;

import java.util.List;

/**
 * An RX wrapper around {@link com.hubrick.vertx.rest.RestClient}
 *
 * @author Emir Dizdarevic
 * @since 1.1.0
 */
public interface RxRestClient {

    /**
     *  Creates an instance of {@link DefaultRxRestClient}
     *
     * @param vertx The vertx instance
     * @param clientOptions Rest client options
     * @param httpMessageConverters defined http message converters
     * @return A instance of RxRestClient
     */
    static RxRestClient create(Vertx vertx, RestClientOptions clientOptions, List httpMessageConverters) {
        return new DefaultRxRestClient(RestClient.create(vertx, clientOptions, httpMessageConverters));
    }

    /**
     *  Creates an instance of {@link DefaultRxRestClient} with default RestClientOptions
     *
     * @param vertx The vertx instance
     * @param httpMessageConverters defined http message converters
     * @return A instance of RxRestClient
     */
    static RxRestClient create(Vertx vertx, List httpMessageConverters) {
        return new DefaultRxRestClient(RestClient.create(vertx, new RestClientOptions(), httpMessageConverters));
    }

    /**
     * Makes a GET call with no response value.
     *
     * @param uri The uri which should be called.
     * @param requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
    Single> get(String uri, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
     Single> get(String uri, Class responseClass, Action1> requestBuilder);

    /**
     * Makes a POST call with no response value.
     *
     * @param uri The uri which should be called.
     * @param requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
    Single> post(String uri, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
     Single> post(String uri, Class responseClass, Action1> requestBuilder);

    /**
     * Makes a PUT call with no response value.
     *
     * @param uri The uri which should be called.
     * @param requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
    Single> put(String uri, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
     Single> put(String uri, Class responseClass, Action1> requestBuilder);

    /**
     * Makes a DELETE call with no response value.
     *
     * @param uri The uri which should be called.
     * @param requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
    Single> delete(String uri, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
     Single> delete(String uri, Class responseClass, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
    Single> request(HttpMethod method, String uri, Action1> requestBuilder);

    /**
     * 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 requestBuilder The handler to build the request
     * @return A reference to the {@link RestClientRequest}
     */
     Single> request(HttpMethod method, String uri, Class responseClass, Action1> requestBuilder);
}