001/* 002 * Copyright 2002-2018 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.http; 018 019import java.net.URI; 020 021import org.springframework.lang.Nullable; 022 023/** 024 * Represents an HTTP request message, consisting of 025 * {@linkplain #getMethod() method} and {@linkplain #getURI() uri}. 026 * 027 * @author Arjen Poutsma 028 * @since 3.1 029 */ 030public interface HttpRequest extends HttpMessage { 031 032 /** 033 * Return the HTTP method of the request. 034 * @return the HTTP method as an HttpMethod enum value, or {@code null} 035 * if not resolvable (e.g. in case of a non-standard HTTP method) 036 * @see #getMethodValue() 037 * @see HttpMethod#resolve(String) 038 */ 039 @Nullable 040 default HttpMethod getMethod() { 041 return HttpMethod.resolve(getMethodValue()); 042 } 043 044 /** 045 * Return the HTTP method of the request as a String value. 046 * @return the HTTP method as a plain String 047 * @since 5.0 048 * @see #getMethod() 049 */ 050 String getMethodValue(); 051 052 /** 053 * Return the URI of the request (including a query string if any, 054 * but only if it is well-formed for a URI representation). 055 * @return the URI of the request (never {@code null}) 056 */ 057 URI getURI(); 058 059}