public final class RequestMappingInfo extends java.lang.Object implements RequestCondition<RequestMappingInfo>
PatternsRequestCondition
RequestMethodsRequestCondition
ParamsRequestCondition
HeadersRequestCondition
ConsumesRequestCondition
ProducesRequestCondition
RequestCondition
(optional, custom request condition)
Modifier and Type | Class and Description |
---|---|
static interface |
RequestMappingInfo.Builder
Defines a builder for creating a RequestMappingInfo.
|
static class |
RequestMappingInfo.BuilderConfiguration
Container for configuration options used for request mapping purposes.
|
private static class |
RequestMappingInfo.DefaultBuilder |
Modifier and Type | Field and Description |
---|---|
private ConsumesRequestCondition |
consumesCondition |
private RequestConditionHolder |
customConditionHolder |
private HeadersRequestCondition |
headersCondition |
private RequestMethodsRequestCondition |
methodsCondition |
private java.lang.String |
name |
private ParamsRequestCondition |
paramsCondition |
private PatternsRequestCondition |
patternsCondition |
private ProducesRequestCondition |
producesCondition |
Constructor and Description |
---|
RequestMappingInfo(PatternsRequestCondition patterns,
RequestMethodsRequestCondition methods,
ParamsRequestCondition params,
HeadersRequestCondition headers,
ConsumesRequestCondition consumes,
ProducesRequestCondition produces,
RequestCondition<?> custom)
Creates a new instance with the given request conditions.
|
RequestMappingInfo(RequestMappingInfo info,
RequestCondition<?> customRequestCondition)
Re-create a RequestMappingInfo with the given custom request condition.
|
RequestMappingInfo(java.lang.String name,
PatternsRequestCondition patterns,
RequestMethodsRequestCondition methods,
ParamsRequestCondition params,
HeadersRequestCondition headers,
ConsumesRequestCondition consumes,
ProducesRequestCondition produces,
RequestCondition<?> custom) |
Modifier and Type | Method and Description |
---|---|
RequestMappingInfo |
combine(RequestMappingInfo other)
Combines "this" request mapping info (i.e.
|
private java.lang.String |
combineNames(RequestMappingInfo other) |
int |
compareTo(RequestMappingInfo other,
HttpServletRequest request)
Compares "this" info (i.e.
|
boolean |
equals(java.lang.Object obj) |
private RequestMethodsRequestCondition |
getAccessControlRequestMethodCondition(HttpServletRequest request)
Return a matching RequestMethodsRequestCondition based on the expected
HTTP method specified in a CORS pre-flight request.
|
ConsumesRequestCondition |
getConsumesCondition()
Returns the "consumes" condition of this
RequestMappingInfo ;
or instance with 0 consumes expressions, never null . |
RequestCondition<?> |
getCustomCondition()
Returns the "custom" condition of this
RequestMappingInfo ; or null . |
HeadersRequestCondition |
getHeadersCondition()
Returns the "headers" condition of this
RequestMappingInfo ;
or instance with 0 header expressions, never null . |
RequestMappingInfo |
getMatchingCondition(HttpServletRequest request)
Checks if all conditions in this request mapping info match the provided request and returns
a potentially new request mapping info with conditions tailored to the current request.
|
RequestMethodsRequestCondition |
getMethodsCondition()
Returns the HTTP request methods of this
RequestMappingInfo ;
or instance with 0 request methods, never null . |
java.lang.String |
getName()
Return the name for this mapping, or
null . |
ParamsRequestCondition |
getParamsCondition()
Returns the "parameters" condition of this
RequestMappingInfo ;
or instance with 0 parameter expressions, never null . |
PatternsRequestCondition |
getPatternsCondition()
Returns the URL patterns of this
RequestMappingInfo ;
or instance with 0 patterns, never null . |
ProducesRequestCondition |
getProducesCondition()
Returns the "produces" condition of this
RequestMappingInfo ;
or instance with 0 produces expressions, never null . |
int |
hashCode() |
static RequestMappingInfo.Builder |
paths(java.lang.String... paths)
Create a new
RequestMappingInfo.Builder with the given paths. |
java.lang.String |
toString() |
private final java.lang.String name
private final PatternsRequestCondition patternsCondition
private final RequestMethodsRequestCondition methodsCondition
private final ParamsRequestCondition paramsCondition
private final HeadersRequestCondition headersCondition
private final ConsumesRequestCondition consumesCondition
private final ProducesRequestCondition producesCondition
private final RequestConditionHolder customConditionHolder
public RequestMappingInfo(java.lang.String name, PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom)
public RequestMappingInfo(PatternsRequestCondition patterns, RequestMethodsRequestCondition methods, ParamsRequestCondition params, HeadersRequestCondition headers, ConsumesRequestCondition consumes, ProducesRequestCondition produces, RequestCondition<?> custom)
public RequestMappingInfo(RequestMappingInfo info, RequestCondition<?> customRequestCondition)
public java.lang.String getName()
null
.public PatternsRequestCondition getPatternsCondition()
RequestMappingInfo
;
or instance with 0 patterns, never null
.public RequestMethodsRequestCondition getMethodsCondition()
RequestMappingInfo
;
or instance with 0 request methods, never null
.public ParamsRequestCondition getParamsCondition()
RequestMappingInfo
;
or instance with 0 parameter expressions, never null
.public HeadersRequestCondition getHeadersCondition()
RequestMappingInfo
;
or instance with 0 header expressions, never null
.public ConsumesRequestCondition getConsumesCondition()
RequestMappingInfo
;
or instance with 0 consumes expressions, never null
.public ProducesRequestCondition getProducesCondition()
RequestMappingInfo
;
or instance with 0 produces expressions, never null
.public RequestCondition<?> getCustomCondition()
RequestMappingInfo
; or null
.public RequestMappingInfo combine(RequestMappingInfo other)
Example: combine type- and method-level request mappings.
combine
in interface RequestCondition<RequestMappingInfo>
other
- the condition to combine with.null
private java.lang.String combineNames(RequestMappingInfo other)
public RequestMappingInfo getMatchingCondition(HttpServletRequest request)
For example the returned instance may contain the subset of URL patterns that match to the current request, sorted with best matching patterns on top.
getMatchingCondition
in interface RequestCondition<RequestMappingInfo>
null
otherwiseprivate RequestMethodsRequestCondition getAccessControlRequestMethodCondition(HttpServletRequest request)
public int compareTo(RequestMappingInfo other, HttpServletRequest request)
Note: It is assumed both instances have been obtained via
getMatchingCondition(HttpServletRequest)
to ensure they have conditions with
content relevant to current request.
compareTo
in interface RequestCondition<RequestMappingInfo>
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static RequestMappingInfo.Builder paths(java.lang.String... paths)
RequestMappingInfo.Builder
with the given paths.paths
- the paths to use