org.springframework.web.servlet.mvc.method

Class RequestMappingInfo.BuilderConfiguration

java.lang.Object

org.springframework.web.servlet.mvc.method.RequestMappingInfo.BuilderConfiguration

Enclosing class:

RequestMappingInfo

public static class RequestMappingInfo.BuilderConfiguration
extends Object

Container for configuration options used for request mapping purposes. Such configuration is required to create RequestMappingInfo instances but is typically used across all RequestMappingInfo instances.

Since:

4.2

See Also:

RequestMappingInfo.Builder.options(org.springframework.web.servlet.mvc.method.RequestMappingInfo.BuilderConfiguration)

Constructor Summary

Constructors

Constructor and Description
BuilderConfiguration()

Method Summary

Modifier and Type	Method and Description
ContentNegotiationManager	getContentNegotiationManager()
List<String>	getFileExtensions() Return the file extensions to use for suffix pattern matching.
PathMatcher	getPathMatcher()
UrlPathHelper	getUrlPathHelper()
void	setContentNegotiationManager(ContentNegotiationManager manager) Set the ContentNegotiationManager to use for the ProducesRequestCondition.
void	setPathHelper(UrlPathHelper pathHelper) Set a custom UrlPathHelper to use for the PatternsRequestCondition.
void	setPathMatcher(PathMatcher pathMatcher) Set a custom PathMatcher to use for the PatternsRequestCondition.
void	setRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch) Whether suffix pattern matching should be restricted to registered file extensions only.
void	setSuffixPatternMatch(boolean suffixPatternMatch) Whether to apply suffix pattern matching in PatternsRequestCondition.
void	setTrailingSlashMatch(boolean trailingSlashMatch) Whether to apply trailing slash matching in PatternsRequestCondition.
boolean	useRegisteredSuffixPatternMatch()
boolean	useSuffixPatternMatch()
boolean	useTrailingSlashMatch()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuilderConfiguration

public BuilderConfiguration()

Method Detail

setPathHelper

public void setPathHelper(UrlPathHelper pathHelper)

Set a custom UrlPathHelper to use for the PatternsRequestCondition.

By default this is not set.

getUrlPathHelper

public UrlPathHelper getUrlPathHelper()

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set a custom PathMatcher to use for the PatternsRequestCondition.

By default this is not set.

getPathMatcher

public PathMatcher getPathMatcher()

setTrailingSlashMatch

public void setTrailingSlashMatch(boolean trailingSlashMatch)

Whether to apply trailing slash matching in PatternsRequestCondition.

By default this is set to 'true'.

useTrailingSlashMatch

public boolean useTrailingSlashMatch()

setSuffixPatternMatch

public void setSuffixPatternMatch(boolean suffixPatternMatch)

Whether to apply suffix pattern matching in PatternsRequestCondition.

By default this is set to 'true'.

See Also:

setRegisteredSuffixPatternMatch(boolean)

useSuffixPatternMatch

public boolean useSuffixPatternMatch()

setRegisteredSuffixPatternMatch

public void setRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch)

Whether suffix pattern matching should be restricted to registered file extensions only. Setting this property also sets suffixPatternMatch=true and requires that a setContentNegotiationManager(org.springframework.web.accept.ContentNegotiationManager) is also configured in order to obtain the registered file extensions.

useRegisteredSuffixPatternMatch

public boolean useRegisteredSuffixPatternMatch()

getFileExtensions

public List<String> getFileExtensions()

Return the file extensions to use for suffix pattern matching. If registeredSuffixPatternMatch=true, the extensions are obtained from the configured contentNegotiationManager.

setContentNegotiationManager

public void setContentNegotiationManager(ContentNegotiationManager manager)

Set the ContentNegotiationManager to use for the ProducesRequestCondition.

By default this is not set.

getContentNegotiationManager

public ContentNegotiationManager getContentNegotiationManager()