Package io.microsphere.spring.web.rule

Class WebRequestProducesRule

java.lang.Object

io.microsphere.spring.web.rule.AbstractWebRequestRule<ProduceMediaTypeExpression>

io.microsphere.spring.web.rule.WebRequestProducesRule

All Implemented Interfaces:

WebRequestRule

public class WebRequestProducesRule
extends AbstractWebRequestRule<ProduceMediaTypeExpression>

WebRequest Produces WebRequestRule

A logical disjunction (' || ') request condition to match a request's 'Accept' header to a list of media type expressions. Two kinds of media type expressions are supported, which are described in RequestMapping.produces() and RequestMapping.headers() where the header name is 'Accept'. Regardless of which syntax is used, the semantics are the same.

Since:

1.0.0

Author:

Arjen Poutsma, Rossen Stoyanchev, Mercy

See Also:

• WebRequestRule
• org.springframework.web.servlet.mvc.condition.ProducesRequestCondition
• org.springframework.web.reactive.result.condition.ProducesRequestCondition

Constructor Summary

Constructors

Constructor	Description
WebRequestProducesRule(String... produces)
WebRequestProducesRule(String[] produces, String... headers)
WebRequestProducesRule(String[] produces, String[] headers, org.springframework.web.accept.ContentNegotiationManager manager)

Method Summary

Modifier and Type	Method	Description
protected Collection<ProduceMediaTypeExpression>	getContent()	Return the discrete items a request condition is composed of.
protected String	getToStringInfix()	The notation to use when printing discrete items of content.
boolean	matches(org.springframework.web.context.request.NativeWebRequest request)

Methods inherited from class io.microsphere.spring.web.rule.AbstractWebRequestRule

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebRequestProducesRule

public WebRequestProducesRule(String... produces)

WebRequestProducesRule

public WebRequestProducesRule(String[] produces,
 @Nullable
 String... headers)

WebRequestProducesRule

public WebRequestProducesRule(String[] produces,
 @Nullable
 String[] headers,
 @Nullable
 org.springframework.web.accept.ContentNegotiationManager manager)

Method Details

getContent

protected Collection<ProduceMediaTypeExpression> getContent()

Description copied from class: AbstractWebRequestRule

Return the discrete items a request condition is composed of.

For example URL patterns, HTTP request methods, param expressions, etc.

Specified by:

getContent in class AbstractWebRequestRule<ProduceMediaTypeExpression>

Returns:

a collection of objects (never null)

getToStringInfix

protected String getToStringInfix()

Description copied from class: AbstractWebRequestRule

The notation to use when printing discrete items of content.

For example " || " for URL patterns or " && " for param expressions.

Specified by:

getToStringInfix in class AbstractWebRequestRule<ProduceMediaTypeExpression>

matches

public boolean matches(org.springframework.web.context.request.NativeWebRequest request)