netbout-spi-1.5.6.src.main.java.com.netbout.spi.client.RestClient Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2012, Netbout.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the NetBout.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.netbout.spi.client;
import java.net.URI;
/**
* Client that loads XML through HTTP.
*
* @author Yegor Bugayenko ([email protected])
* @version $Id: RestClient.java 3470 2012-10-16 18:46:28Z [email protected] $
*/
interface RestClient {
/**
* GET method.
*/
String GET = "GET";
/**
* POST method.
*/
String POST = "POST";
/**
* Provide query param.
* @param name Name of the parameter
* @param value The value of it
* @return This object
*/
RestClient queryParam(String name, String value);
/**
* Fetch HTTP GET response.
* @param message Explanation of the operation
* @return This object
*/
RestResponse get(String message);
/**
* Fetch HTTP POST response.
* @param message Explanation of the operation
* @param params Form names and params
* @return This object
*/
RestResponse post(String message, String... params);
/**
* Just clone this client.
* @return New client
*/
RestClient copy();
/**
* Clone this client with a new URI.
* @param uri New entry point
* @return New client
*/
RestClient copy(URI uri);
/**
* Clone this client with a new URI.
* @param uri New entry point
* @return New client
*/
RestClient copy(String uri);
/**
* Get URI of this client.
* @return The URI
*/
URI uri();
}