org.jsoftware.restclient.RestClientResponse Maven / Gradle / Ivy
package org.jsoftware.restclient;
import org.apache.http.Header;
import org.apache.http.StatusLine;
import org.xml.sax.SAXException;
import javax.xml.namespace.QName;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.xpath.XPathExpressionException;
import java.io.IOException;
import java.io.PrintStream;
import java.io.Serializable;
/**
* Http response
* @author szalik
*/
public interface RestClientResponse extends Serializable {
/**
* @return http status line
*/
StatusLine getStatusLine();
/**
* @return response http headers
*/
Header[] getAllHeaders();
/**
* @throws IOException if http response cannot be read
* @return response body as String
*/
String getContent() throws IOException;
/**
* Parse response body as json
* @param path json path
* @return String, Number, List...
* @throws IOException if response cannot be read or is not valid json
* @see Jayway
*/
Object json(String path) throws IOException;
/**
* Parse response body as xml
* @see javax.xml.xpath.XPathConstants
* @param xPath xPath definition
* @param type requested xPath type
* @return requested value
* @throws IOException if response cannot be read
* @throws SAXException if response is not valid xml
* @throws XPathExpressionException if argument xPath is not valid xPath definition
*/
Object xPath(String xPath, QName type) throws IOException, SAXException, XPathExpressionException;
/**
* Parse response body as xml
* @param xPath xPath definition
* @return requested value
* @throws IOException if response cannot be read
* @throws SAXException if response is not valid xml
* @throws XPathExpressionException if argument xPath is not valid xPath definition
*/
String xPath(String xPath) throws IOException, SAXException, XPathExpressionException;
/**
* Dump response to PrintStream
* @param withHeaders add headers if true
* @param to output stream
* @throws IOException if response cannot be read
*/
void dump(boolean withHeaders, PrintStream to) throws IOException;
/**
* Dump response to stdout
* @param withHeaders add headers if true
* @throws IOException if response cannot be read
*/
default void dump(boolean withHeaders) throws IOException {
dump(withHeaders, System.out);
}
}