com.cisco.oss.foundation.http.HttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client-api Show documentation

This project is the api library for http client in the cisco vss foundation runtime

There is a newer version: 1.3.0-1

/*
 * Copyright 2015 Cisco Systems, Inc.
 *
 *  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.cisco.oss.foundation.http;

/**
 * The basic interface to foundation http clients.
 * This interface allows you to choose between the following options:
 * 
1. execute a request directly using executeDirect - assumes a fully constructed url
 * 
2. execute a request with LoadBalancer using executeWithLoadBalancer - assumes a partially constructed uri
 * 
3. execute a request directly or with load balancing using execute - decision is based on the 'enableLoadBalancing' flag in the Httpclient factories.
 *
 * This class uses Generics to bind to specific HttpRequest and HttpResponse types. The actual binding is done via the Client factory implementations.
 * Refer to wiki to see possible configurations for clients.
 * Created by Yair Ogen on 1/6/14.
 */
public interface HttpClient {

    /**
     * execute a request either directly or by load balancing.
     * @param request - the http request
     * @return the http response
     */
    R execute(S request);

    /**
     * execute a request directly - assumes a fully constructed url
     * @param request - the http request
     * @return the http response
     */
    R executeDirect(S request);

    /**
     * execute with load balancing. by default RoundRobin will be used. this api assumes partial uri in the request
     * @param request - the http request
     * @return the http response
     */
    R executeWithLoadBalancer(S request);

    /**
     * execute with load balancing asynchronously. by default RoundRobin will be used. this api assumes partial uri in the request
     * @param request - the http request
     * @param responseCallback - teh call back that will get the response asynchronously.
     */
    void executeWithLoadBalancer(S request, ResponseCallback responseCallback);

    /**
     * get the api name used to built this client instance.
     * @return
     */
    String getApiName();

    /**
     * close the client and cleanup resources
     */
    void close();


}