blob: 43ca9414e3b7cda09fb2156a60822d1435394f90 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a>
<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.http;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.CollectionUtils.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Represents valid HTTP 1.1 method name static strings per the RFC 2616 spec.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;ul class='seealso'&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;li class='link'&gt;{@doc jm.HttpParts}<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;li class='extlink'&gt;{@doc ext.RFC2616}<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;li class='extlink'&gt;{@source}<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;/ul&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public class HttpMethod {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span> /** {@doc ext.RFC2616.section9#sec9.2 OPTIONS} */<a name="line.31"></a>
<span class="sourceLineNo">032</span> public static final String OPTIONS = "OPTIONS";<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> /** {@doc ext.RFC2616.section9#sec9.3 GET} */<a name="line.34"></a>
<span class="sourceLineNo">035</span> public static final String GET = "GET";<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> /** {@doc ext.RFC2616.section9#sec9.4 HEAD} */<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static final String HEAD = "HEAD";<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /** {@doc ext.RFC2616.section9#sec9.5 POST} */<a name="line.40"></a>
<span class="sourceLineNo">041</span> public static final String POST = "POST";<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /** {@doc ext.RFC2616.section9#sec9.6 PUT} */<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final String PUT = "PUT";<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /** {@doc ext.RFC2616.section9#sec9.7 DELETE} */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static final String DELETE = "DELETE";<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /** {@doc ext.RFC2616.section9#sec9.8 TRACE} */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public static final String TRACE = "TRACE";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /** {@doc ext.RFC2616.section9#sec9.9 CONNECT} */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static final String CONNECT = "CONNECT";<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /** {@doc https://tools.ietf.org/html/rfc5789 PATCH} */<a name="line.55"></a>
<span class="sourceLineNo">056</span> public static final String PATCH = "PATCH";<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /** Special case for a REST method that implements a REST-RPC interface. */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public static final String RRPC = "RRPC";<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /** A non-standard value. */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public static final String OTHER = "OTHER";<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /** Represents any HTTP method. */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static final String ANY = "*";<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private static final Set&lt;String&gt; NO_BODY_METHODS = unmodifiable(set("GET","HEAD","DELETE","CONNECT","OPTIONS","TRACE"));<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * Returns &lt;jk&gt;true&lt;/jk&gt; if specified http method has content.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;p&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * By default, anything not in this list can have content: &lt;c&gt;GET, HEAD, DELETE, CONNECT, OPTIONS, TRACE&lt;/c&gt;.<a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param name The HTTP method.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @return &lt;jk&gt;true&lt;/jk&gt; if specified http method has content.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public static boolean hasContent(String name) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return ! NO_BODY_METHODS.contains(emptyIfNull(name).toUpperCase());<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span>}<a name="line.80"></a>
</pre>
</div>
</body>
</html>