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.sonar.api.server.ws; 021 022import java.io.OutputStream; 023import java.util.Collection; 024import javax.annotation.CheckForNull; 025import org.sonar.api.utils.text.JsonWriter; 026import org.sonar.api.utils.text.XmlWriter; 027 028/** 029 * HTTP response 030 * 031 * @since 4.2 032 */ 033public interface Response { 034 035 interface Stream { 036 Stream setMediaType(String s); 037 038 /** 039 * HTTP status code. See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes. 040 * By default value is set to 200. 041 */ 042 Stream setStatus(int httpStatus); 043 OutputStream output(); 044 } 045 046 JsonWriter newJsonWriter(); 047 048 XmlWriter newXmlWriter(); 049 050 Response noContent(); 051 052 Response setHeader(String name, String value); 053 054 Collection<String> getHeaderNames(); 055 056 @CheckForNull 057 String getHeader(String name); 058 059 Stream stream(); 060 061}