Spring Framework 6.1.4 · org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

RequestToViewNameTranslator that simply transforms the URI of the incoming request into a view name.

Can be explicitly defined as the viewNameTranslator bean in a org.springframework.web.servlet.DispatcherServlet context. Otherwise, a plain default instance will be used.

The default transformation simply strips leading and trailing slashes as well as the file extension of the URI, and returns the result as the view name with the configured prefix and a suffix added as appropriate.

The stripping of the leading slash and file extension can be disabled using the stripLeadingSlash and stripExtension properties, respectively.

Find below some examples of request to view name translation.

http://localhost:8080/gamecast/display.html » display
http://localhost:8080/gamecast/displayShoppingCart.html » displayShoppingCart
http://localhost:8080/gamecast/admin/index.html » admin/index

Modifier and Type	Field and Description
private String	prefix
private String	separator
private static final String	SLASH
private boolean	stripExtension
private boolean	stripLeadingSlash
private boolean	stripTrailingSlash
private String	suffix

Constructor Summary

Access	Constructor and Description
public	DefaultRequestToViewNameTranslator()

Method Summary

Modifier and Type	Method and Description
public String	getViewName(HttpServletRequest the incoming `HttpServletRequest` providing the context from which a view name is to be resolved request) Implements org.springframework.web.servlet.RequestToViewNameTranslator.getViewName. Translates the request URI of the incoming `HttpServletRequest` into the view name based on the configured parameters.
public void	setPrefix(String the prefix to prepend to generated view names prefix) Set the prefix to prepend to generated view names.
public void	setSeparator(String separator) Set the value that will replace '`/`' as the separator in the view name.
public void	setStripExtension(boolean stripExtension) Set whether file extensions should be stripped from the URI when generating the view name.
public void	setStripLeadingSlash(boolean stripLeadingSlash) Set whether leading slashes should be stripped from the URI when generating the view name.
public void	setStripTrailingSlash(boolean stripTrailingSlash) Set whether trailing slashes should be stripped from the URI when generating the view name.
public void	setSuffix(String the suffix to append to generated view names suffix) Set the suffix to append to generated view names.
protected String	Returns: the transformed path, with slashes and extensions stripped if desired transformPath(String the lookup path for the current request, as determined by the UrlPathHelper lookupPath) Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

prefix	back to summary
private String prefix

separator	back to summary
private String separator

SLASH	back to summary
private static final String SLASH

stripExtension	back to summary
private boolean stripExtension

stripLeadingSlash	back to summary
private boolean stripLeadingSlash

stripTrailingSlash	back to summary
private boolean stripTrailingSlash

suffix	back to summary
private String suffix

Constructor Detail

DefaultRequestToViewNameTranslator	back to summary
public DefaultRequestToViewNameTranslator()

Method Detail

getViewName back to summary

getViewName	back to summary
public String getViewName(HttpServletRequest request) Implements org.springframework.web.servlet.RequestToViewNameTranslator.getViewName. Translates the request URI of the incoming `HttpServletRequest` into the view name based on the configured parameters. Parameters request:HttpServletRequest Doc from org.springframework.web.servlet.RequestToViewNameTranslator.getViewName. the incoming `HttpServletRequest` providing the context from which a view name is to be resolved Returns:String Doc from org.springframework.web.servlet.RequestToViewNameTranslator.getViewName. the view name, or `null` if no default found Annotations @Override Exceptions IllegalArgumentException: if neither a parsed RequestPath, nor a String lookupPath have been resolved and cached as a request attribute. See Also `ServletRequestPathUtils#getCachedPath(ServletRequest)`, `transformPath`

public String getViewName(HttpServletRequest request)

Implements org.springframework.web.servlet.RequestToViewNameTranslator.getViewName.

Translates the request URI of the incoming HttpServletRequest into the view name based on the configured parameters.

Parameters

request:HttpServletRequest

Doc from org.springframework.web.servlet.RequestToViewNameTranslator.getViewName.

the incoming HttpServletRequest providing the context from which a view name is to be resolved

Returns:String

Doc from org.springframework.web.servlet.RequestToViewNameTranslator.getViewName.

the view name, or null if no default found

Annotations

@Override

Exceptions

IllegalArgumentException:: if neither a parsed RequestPath, nor a String lookupPath have been resolved and cached as a request attribute.

setPrefix	back to summary
public void setPrefix(String prefix) Set the prefix to prepend to generated view names. Parameters prefix:String the prefix to prepend to generated view names

setPrefix

back to summary

public void setPrefix(String prefix)

Set the prefix to prepend to generated view names.

Parameters

prefix:String: the prefix to prepend to generated view names

setSeparator	back to summary
public void setSeparator(String separator) Set the value that will replace '`/`' as the separator in the view name. The default behavior simply leaves '`/`' as the separator.

setStripExtension	back to summary
public void setStripExtension(boolean stripExtension) Set whether file extensions should be stripped from the URI when generating the view name. Default is "true".

setStripLeadingSlash	back to summary
public void setStripLeadingSlash(boolean stripLeadingSlash) Set whether leading slashes should be stripped from the URI when generating the view name. Default is "true".

setStripTrailingSlash	back to summary
public void setStripTrailingSlash(boolean stripTrailingSlash) Set whether trailing slashes should be stripped from the URI when generating the view name. Default is "true".

setSuffix	back to summary
public void setSuffix(String suffix) Set the suffix to append to generated view names. Parameters suffix:String the suffix to append to generated view names

setSuffix

back to summary

public void setSuffix(String suffix)

Set the suffix to append to generated view names.

Parameters

suffix:String: the suffix to append to generated view names

transformPath	back to summary
protected String transformPath(String lookupPath) Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required. Parameters lookupPath:String the lookup path for the current request, as determined by the UrlPathHelper Returns:String the transformed path, with slashes and extensions stripped if desired Annotations @Nullable

transformPath

back to summary

protected String transformPath(String lookupPath)

Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required.

Parameters

lookupPath:String: the lookup path for the current request, as determined by the UrlPathHelper

Returns:String

the transformed path, with slashes and extensions stripped if desired

Annotations

@Nullable

public Class DefaultRequestToViewNameTranslator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail