001// *************************************************************************************************************************** 002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file * 003// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file * 004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance * 005// * with the License. You may obtain a copy of the License at * 006// * * 007// * http://www.apache.org/licenses/LICENSE-2.0 * 008// * * 009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an * 010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the * 011// * specific language governing permissions and limitations under the License. * 012// *************************************************************************************************************************** 013package org.apache.juneau.http.response; 014 015import static org.apache.juneau.http.response.Created.*; 016 017import java.net.*; 018import java.util.*; 019 020import org.apache.http.*; 021import org.apache.http.Header; 022import org.apache.juneau.annotation.*; 023import org.apache.juneau.http.*; 024import org.apache.juneau.http.annotation.*; 025import org.apache.juneau.http.header.*; 026import org.apache.juneau.internal.*; 027 028/** 029 * Represents an <c>HTTP 201 Created</c> response. 030 * 031 * <p> 032 * The request has been fulfilled, resulting in the creation of a new resource. 033 * 034 * <h5 class='section'>See Also:</h5><ul> 035 * <li class='link'><a class="doclink" href="../../../../../index.html#juneau-rest-common">juneau-rest-common</a> 036 * </ul> 037 */ 038@Response 039@StatusCode(STATUS_CODE) 040@Schema(description=REASON_PHRASE) 041@FluentSetters 042public class Created extends BasicHttpResponse { 043 044 /** HTTP status code */ 045 public static final int STATUS_CODE = 201; 046 047 /** Reason phrase */ 048 public static final String REASON_PHRASE = "Created"; 049 050 /** Default status line */ 051 private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE); 052 053 /** Default unmodifiable instance */ 054 public static final Created INSTANCE = new Created().setUnmodifiable(); 055 056 /** 057 * Constructor. 058 */ 059 public Created() { 060 super(STATUS_LINE); 061 } 062 063 /** 064 * Copy constructor. 065 * 066 * @param copyFrom The bean to copy from. 067 */ 068 public Created(Created copyFrom) { 069 super(copyFrom); 070 } 071 072 /** 073 * Constructor. 074 * 075 * <p> 076 * This is the constructor used when parsing an HTTP response. 077 * 078 * @param response The HTTP response to copy from. Must not be <jk>null</jk>. 079 * @throws AssertionError If HTTP response status code does not match what was expected. 080 */ 081 public Created(HttpResponse response) { 082 super(response); 083 assertStatusCode(response); 084 } 085 086 /** 087 * Creates a builder for this class initialized with the contents of this bean. 088 * 089 * @return A new builder bean. 090 */ 091 public Created copy() { 092 return new Created(this); 093 } 094 095 // <FluentSetters> 096 097 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 098 public Created setContent(String value) { 099 super.setContent(value); 100 return this; 101 } 102 103 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 104 public Created setContent(HttpEntity value) { 105 super.setContent(value); 106 return this; 107 } 108 109 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 110 public Created setHeader2(Header value) { 111 super.setHeader2(value); 112 return this; 113 } 114 115 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 116 public Created setHeader2(String name, String value) { 117 super.setHeader2(name, value); 118 return this; 119 } 120 121 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 122 public Created setHeaders(List<Header> values) { 123 super.setHeaders(values); 124 return this; 125 } 126 127 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 128 public Created setHeaders(HeaderList value) { 129 super.setHeaders(value); 130 return this; 131 } 132 133 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 134 public Created setHeaders2(Header...values) { 135 super.setHeaders2(values); 136 return this; 137 } 138 139 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 140 public Created setLocale2(Locale value) { 141 super.setLocale2(value); 142 return this; 143 } 144 145 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 146 public Created setLocation(String value) { 147 super.setLocation(value); 148 return this; 149 } 150 151 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 152 public Created setLocation(URI value) { 153 super.setLocation(value); 154 return this; 155 } 156 157 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 158 public Created setProtocolVersion(ProtocolVersion value) { 159 super.setProtocolVersion(value); 160 return this; 161 } 162 163 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 164 public Created setReasonPhrase2(String value) { 165 super.setReasonPhrase2(value); 166 return this; 167 } 168 169 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 170 public Created setReasonPhraseCatalog(ReasonPhraseCatalog value) { 171 super.setReasonPhraseCatalog(value); 172 return this; 173 } 174 175 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 176 public Created setStatusCode2(int value) { 177 super.setStatusCode2(value); 178 return this; 179 } 180 181 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 182 public Created setStatusLine(BasicStatusLine value) { 183 super.setStatusLine(value); 184 return this; 185 } 186 187 @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpResponse */ 188 public Created setUnmodifiable() { 189 super.setUnmodifiable(); 190 return this; 191 } 192 193 // </FluentSetters> 194}