| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.juneau.http.response, class: PayloadTooLarge"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">002</span><span id="line-2">// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *</span> |
| <span class="source-line-no">003</span><span id="line-3">// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *</span> |
| <span class="source-line-no">004</span><span id="line-4">// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *</span> |
| <span class="source-line-no">005</span><span id="line-5">// * with the License. You may obtain a copy of the License at *</span> |
| <span class="source-line-no">006</span><span id="line-6">// * *</span> |
| <span class="source-line-no">007</span><span id="line-7">// * http://www.apache.org/licenses/LICENSE-2.0 *</span> |
| <span class="source-line-no">008</span><span id="line-8">// * *</span> |
| <span class="source-line-no">009</span><span id="line-9">// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *</span> |
| <span class="source-line-no">010</span><span id="line-10">// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *</span> |
| <span class="source-line-no">011</span><span id="line-11">// * specific language governing permissions and limitations under the License. *</span> |
| <span class="source-line-no">012</span><span id="line-12">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">013</span><span id="line-13">package org.apache.juneau.http.response;</span> |
| <span class="source-line-no">014</span><span id="line-14"></span> |
| <span class="source-line-no">015</span><span id="line-15">import static org.apache.juneau.http.response.PayloadTooLarge.*;</span> |
| <span class="source-line-no">016</span><span id="line-16"></span> |
| <span class="source-line-no">017</span><span id="line-17">import java.text.*;</span> |
| <span class="source-line-no">018</span><span id="line-18">import java.util.*;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.http.*;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.http.Header;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.juneau.annotation.*;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.juneau.http.*;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.juneau.http.annotation.*;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.juneau.http.header.*;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.juneau.internal.*;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Exception representing an HTTP 413 (Payload Too Large).</span> |
| <span class="source-line-no">030</span><span id="line-30"> *</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <p></span> |
| <span class="source-line-no">032</span><span id="line-32"> * The request is larger than the server is willing or able to process.</span> |
| <span class="source-line-no">033</span><span id="line-33"> *</span> |
| <span class="source-line-no">034</span><span id="line-34"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">035</span><span id="line-35"> * <li class='link'><a class="doclink" href="../../../../../index.html#juneau-rest-common">juneau-rest-common</a></span> |
| <span class="source-line-no">036</span><span id="line-36"> * </ul></span> |
| <span class="source-line-no">037</span><span id="line-37"> *</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @serial exclude</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40">@Response</span> |
| <span class="source-line-no">041</span><span id="line-41">@StatusCode(STATUS_CODE)</span> |
| <span class="source-line-no">042</span><span id="line-42">@Schema(description=REASON_PHRASE)</span> |
| <span class="source-line-no">043</span><span id="line-43">@FluentSetters</span> |
| <span class="source-line-no">044</span><span id="line-44">public class PayloadTooLarge extends BasicHttpException {</span> |
| <span class="source-line-no">045</span><span id="line-45"> private static final long serialVersionUID = 1L;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /** HTTP status code */</span> |
| <span class="source-line-no">048</span><span id="line-48"> public static final int STATUS_CODE = 413;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /** Reason phrase */</span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final String REASON_PHRASE = "Payload Too Large";</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /** Default status line */</span> |
| <span class="source-line-no">054</span><span id="line-54"> private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE);</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /** Reusable unmodifiable instance */</span> |
| <span class="source-line-no">057</span><span id="line-57"> public static final PayloadTooLarge INSTANCE = new PayloadTooLarge().setUnmodifiable();</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Constructor.</span> |
| <span class="source-line-no">061</span><span id="line-61"> *</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @param cause The caused-by exception. Can be <jk>null</jk>.</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @param msg The message. Can be <jk>null</jk>.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param args The message arguments.</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public PayloadTooLarge(Throwable cause, String msg, Object...args) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> super(STATUS_CODE, cause, msg, args);</span> |
| <span class="source-line-no">068</span><span id="line-68"> setStatusLine(STATUS_LINE.copy());</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Constructor.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> public PayloadTooLarge() {</span> |
| <span class="source-line-no">075</span><span id="line-75"> this((Throwable)null, REASON_PHRASE);</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> /**</span> |
| <span class="source-line-no">079</span><span id="line-79"> * Constructor.</span> |
| <span class="source-line-no">080</span><span id="line-80"> *</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param msg The message. Can be <jk>null</jk>.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param args Optional {@link MessageFormat}-style arguments in the message.</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> public PayloadTooLarge(String msg, Object...args) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> this((Throwable)null, msg, args);</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /**</span> |
| <span class="source-line-no">089</span><span id="line-89"> * Constructor.</span> |
| <span class="source-line-no">090</span><span id="line-90"> *</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @param cause The cause. Can be <jk>null</jk>.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> public PayloadTooLarge(Throwable cause) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> this(cause, cause == null ? REASON_PHRASE : cause.getMessage());</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Constructor.</span> |
| <span class="source-line-no">099</span><span id="line-99"> *</span> |
| <span class="source-line-no">100</span><span id="line-100"> * <p></span> |
| <span class="source-line-no">101</span><span id="line-101"> * This is the constructor used when parsing an HTTP response.</span> |
| <span class="source-line-no">102</span><span id="line-102"> *</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @param response The HTTP response to copy from. Must not be <jk>null</jk>.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @throws AssertionError If HTTP response status code does not match what was expected.</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> public PayloadTooLarge(HttpResponse response) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> super(response);</span> |
| <span class="source-line-no">108</span><span id="line-108"> assertStatusCode(response);</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /**</span> |
| <span class="source-line-no">112</span><span id="line-112"> * Copy constructor.</span> |
| <span class="source-line-no">113</span><span id="line-113"> *</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @param copyFrom The bean to copy.</span> |
| <span class="source-line-no">115</span><span id="line-115"> */</span> |
| <span class="source-line-no">116</span><span id="line-116"> protected PayloadTooLarge(PayloadTooLarge copyFrom) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> super(copyFrom);</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /**</span> |
| <span class="source-line-no">121</span><span id="line-121"> * Creates a modifiable copy of this bean.</span> |
| <span class="source-line-no">122</span><span id="line-122"> *</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @return A new modifiable bean.</span> |
| <span class="source-line-no">124</span><span id="line-124"> */</span> |
| <span class="source-line-no">125</span><span id="line-125"> public PayloadTooLarge copy() {</span> |
| <span class="source-line-no">126</span><span id="line-126"> return new PayloadTooLarge(this);</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> // <FluentSetters></span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> @Override /* GENERATED - org.apache.juneau.BasicRuntimeException */</span> |
| <span class="source-line-no">132</span><span id="line-132"> public PayloadTooLarge setMessage(String message, Object...args) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> super.setMessage(message, args);</span> |
| <span class="source-line-no">134</span><span id="line-134"> return this;</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> @Override /* GENERATED - org.apache.juneau.BasicRuntimeException */</span> |
| <span class="source-line-no">138</span><span id="line-138"> public PayloadTooLarge setUnmodifiable() {</span> |
| <span class="source-line-no">139</span><span id="line-139"> super.setUnmodifiable();</span> |
| <span class="source-line-no">140</span><span id="line-140"> return this;</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">144</span><span id="line-144"> public PayloadTooLarge setHeader2(String name, Object value) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> super.setHeader2(name, value);</span> |
| <span class="source-line-no">146</span><span id="line-146"> return this;</span> |
| <span class="source-line-no">147</span><span id="line-147"> }</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">150</span><span id="line-150"> public PayloadTooLarge setHeaders(HeaderList value) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> super.setHeaders(value);</span> |
| <span class="source-line-no">152</span><span id="line-152"> return this;</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"></span> |
| <span class="source-line-no">155</span><span id="line-155"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">156</span><span id="line-156"> public PayloadTooLarge setHeaders2(Header...values) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> super.setHeaders2(values);</span> |
| <span class="source-line-no">158</span><span id="line-158"> return this;</span> |
| <span class="source-line-no">159</span><span id="line-159"> }</span> |
| <span class="source-line-no">160</span><span id="line-160"></span> |
| <span class="source-line-no">161</span><span id="line-161"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">162</span><span id="line-162"> public PayloadTooLarge setLocale2(Locale value) {</span> |
| <span class="source-line-no">163</span><span id="line-163"> super.setLocale2(value);</span> |
| <span class="source-line-no">164</span><span id="line-164"> return this;</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">168</span><span id="line-168"> public PayloadTooLarge setProtocolVersion(ProtocolVersion value) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> super.setProtocolVersion(value);</span> |
| <span class="source-line-no">170</span><span id="line-170"> return this;</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">174</span><span id="line-174"> public PayloadTooLarge setReasonPhrase2(String value) {</span> |
| <span class="source-line-no">175</span><span id="line-175"> super.setReasonPhrase2(value);</span> |
| <span class="source-line-no">176</span><span id="line-176"> return this;</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">180</span><span id="line-180"> public PayloadTooLarge setReasonPhraseCatalog(ReasonPhraseCatalog value) {</span> |
| <span class="source-line-no">181</span><span id="line-181"> super.setReasonPhraseCatalog(value);</span> |
| <span class="source-line-no">182</span><span id="line-182"> return this;</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">186</span><span id="line-186"> public PayloadTooLarge setStatusCode2(int code) throws IllegalStateException{</span> |
| <span class="source-line-no">187</span><span id="line-187"> super.setStatusCode2(code);</span> |
| <span class="source-line-no">188</span><span id="line-188"> return this;</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"></span> |
| <span class="source-line-no">191</span><span id="line-191"> @Override /* GENERATED - org.apache.juneau.http.response.BasicHttpException */</span> |
| <span class="source-line-no">192</span><span id="line-192"> public PayloadTooLarge setStatusLine(BasicStatusLine value) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> super.setStatusLine(value);</span> |
| <span class="source-line-no">194</span><span id="line-194"> return this;</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> // </FluentSetters></span> |
| <span class="source-line-no">198</span><span id="line-198">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
