001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonarqube.ws.client;
021
022import java.io.InputStream;
023import java.io.Reader;
024
025/**
026 * @since 5.3
027 */
028public interface WsResponse {
029
030  /**
031   * The absolute requested URL
032   */
033  String requestUrl();
034
035  /**
036   * HTTP status code
037   */
038  int code();
039
040  /**
041   * Returns true if the code is in [200..300), which means the request was
042   * successfully received, understood, and accepted.
043   */
044  boolean isSuccessful() ;
045
046  /**
047   * Throws a {@link HttpException} if {@link #isSuccessful()} is false.
048   */
049  WsResponse failIfNotSuccessful();
050
051  String contentType();
052
053  boolean hasContent();
054
055  InputStream contentStream();
056
057  Reader contentReader();
058
059  String content();
060
061}