Undertow 2.3.12.Final · io.undertow.server.handlers.resource.ResourceHandler

Modifier and Type	Class and Description
public static class	ResourceHandler.Builder
private static class	ResourceHandler.Wrapper

Field Summary

Modifier and Type	Field and Description
private volatile Predicate	allowed
private volatile Predicate	cachable
private volatile Integer	cacheTime If this is set this will be the maximum time (in seconds) the client will cache the resource.
private volatile boolean	canonicalizePaths If the canonical version of paths should be passed into the resource manager.
private volatile ContentEncodedResourceManager	contentEncodedResourceManager
private volatile boolean	directoryListingEnabled If directory listing is enabled.
private static final Set<HttpString>	KNOWN_METHODS Set of methods prescribed by HTTP 1.1.
private volatile MimeMappings	mimeMappings The mime mappings that are used to determine the content type.
private final HttpHandler	next Handler that is called if no resource is found
private volatile ResourceManager	resourceManager
private volatile ResourceSupplier	resourceSupplier
private final List<String>	welcomeFiles

Constructor Summary

Access	Constructor and Description
public	ResourceHandler(ResourceManager resourceSupplier)
public	ResourceHandler(ResourceManager resourceManager, HttpHandler next)
public	ResourceHandler(ResourceSupplier resourceSupplier)
public	ResourceHandler(ResourceSupplier resourceManager, HttpHandler next)
public	ResourceHandler() Deprecated You should use `ResourceHandler(ResourceManager)` instead.

Method Summary

Modifier and Type	Method and Description
public ResourceHandler	addWelcomeFiles(String... files)
private String	canonicalize(String s)
private void	clearCacheHeaders(HttpServerExchange exchange)
public Predicate	getAllowed()
public Predicate	getCachable()
public Integer	getCacheTime()
public ContentEncodedResourceManager	getContentEncodedResourceManager()
private Resource	getIndexFiles(HttpServerExchange exchange, ResourceSupplier resourceManager, final String base, List<String> possible)
public MimeMappings	getMimeMappings()
public ResourceManager	getResourceManager()
public ResourceSupplier	getResourceSupplier()
public void	handleRequest(final HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
public boolean	isCanonicalizePaths()
public boolean	isDirectoryListingEnabled()
private void	serveResource(final HttpServerExchange exchange, final boolean sendContent)
public ResourceHandler	setAllowed(final Predicate allowed)
public ResourceHandler	setCachable(final Predicate cachable)
public ResourceHandler	setCacheTime(final Integer cacheTime)
public void	setCanonicalizePaths(boolean If paths should be canonicalized canonicalizePaths) If this handler should use canonicalized paths.
public ResourceHandler	setContentEncodedResourceManager(ContentEncodedResourceManager contentEncodedResourceManager)
public ResourceHandler	setDirectoryListingEnabled(final boolean directoryListingEnabled)
public ResourceHandler	setMimeMappings(final MimeMappings mimeMappings)
public ResourceHandler	setResourceManager(final ResourceManager resourceManager)
public ResourceHandler	setResourceSupplier(final ResourceSupplier resourceSupplier)
public ResourceHandler	setWelcomeFiles(String... files)

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

Field Detail

allowed	back to summary
private volatile Predicate allowed

cachable	back to summary
private volatile Predicate cachable

cacheTime back to summary

cacheTime	back to summary
private volatile Integer cacheTime If this is set this will be the maximum time (in seconds) the client will cache the resource. Note Do not set this for private resources, as it will cause a Cache-Control: public to be sent. Todo make this more flexible This will only be used if the `cachable` predicate returns true

private volatile Integer cacheTime

If this is set this will be the maximum time (in seconds) the client will cache the resource.

Note

Do not set this for private resources, as it will cause a Cache-Control: public to be sent.

Todo

make this more flexible

This will only be used if the cachable predicate returns true

canonicalizePaths	back to summary
private volatile boolean canonicalizePaths If the canonical version of paths should be passed into the resource manager.

contentEncodedResourceManager	back to summary
private volatile ContentEncodedResourceManager contentEncodedResourceManager

directoryListingEnabled	back to summary
private volatile boolean directoryListingEnabled If directory listing is enabled.

KNOWN_METHODS	back to summary
private static final Set<HttpString> KNOWN_METHODS Set of methods prescribed by HTTP 1.1. If request method is not one of those, handler will return NOT_IMPLEMENTED.

mimeMappings	back to summary
private volatile MimeMappings mimeMappings The mime mappings that are used to determine the content type.

next	back to summary
private final HttpHandler next Handler that is called if no resource is found

resourceManager	back to summary
private volatile ResourceManager resourceManager

resourceSupplier	back to summary
private volatile ResourceSupplier resourceSupplier

welcomeFiles	back to summary
private final List<String> welcomeFiles

Constructor Detail

ResourceHandler	back to summary
public ResourceHandler(ResourceManager resourceSupplier)

ResourceHandler	back to summary
public ResourceHandler(ResourceManager resourceManager, HttpHandler next)

ResourceHandler	back to summary
public ResourceHandler(ResourceSupplier resourceSupplier)

ResourceHandler	back to summary
public ResourceHandler(ResourceSupplier resourceManager, HttpHandler next)

ResourceHandler back to summary

ResourceHandler	back to summary
public ResourceHandler() Deprecated You should use `ResourceHandler(ResourceManager)` instead. Annotations @Deprecated

public ResourceHandler()

Deprecated

You should use ResourceHandler(ResourceManager) instead.

Annotations

@Deprecated

Method Detail

addWelcomeFiles	back to summary
public ResourceHandler addWelcomeFiles(String... files)

canonicalize	back to summary
private String canonicalize(String s)

clearCacheHeaders	back to summary
private void clearCacheHeaders(HttpServerExchange exchange)

getAllowed	back to summary
public Predicate getAllowed()

getCachable	back to summary
public Predicate getCachable()

getCacheTime	back to summary
public Integer getCacheTime()

getContentEncodedResourceManager	back to summary
public ContentEncodedResourceManager getContentEncodedResourceManager()

getIndexFiles	back to summary
private Resource getIndexFiles(HttpServerExchange exchange, ResourceSupplier resourceManager, final String base, List<String> possible) throws IOException

getMimeMappings	back to summary
public MimeMappings getMimeMappings()

getResourceManager	back to summary
public ResourceManager getResourceManager()

getResourceSupplier	back to summary
public ResourceSupplier getResourceSupplier()

handleRequest	back to summary
public void handleRequest(final HttpServerExchange exchange) throws Exception Implements io.undertow.server.HttpHandler.handleRequest. Doc from io.undertow.server.HttpHandler.handleRequest. Handle the request. Parameters exchange:HttpServerExchange the HTTP request/response exchange Annotations @Override

handleRequest

back to summary

public void handleRequest(final HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters

exchange:HttpServerExchange: the HTTP request/response exchange

Annotations

@Override

isCanonicalizePaths	back to summary
public boolean isCanonicalizePaths()

isDirectoryListingEnabled	back to summary
public boolean isDirectoryListingEnabled()

serveResource	back to summary
private void serveResource(final HttpServerExchange exchange, final boolean sendContent) throws Exception

setAllowed	back to summary
public ResourceHandler setAllowed(final Predicate allowed)

setCachable	back to summary
public ResourceHandler setCachable(final Predicate cachable)

setCacheTime	back to summary
public ResourceHandler setCacheTime(final Integer cacheTime)

setCanonicalizePaths back to summary

setCanonicalizePaths	back to summary
public void setCanonicalizePaths(boolean canonicalizePaths) If this handler should use canonicalized paths. Warning If this is not true and `io.undertow.server.handlers.CanonicalPathHandler` is not installed in the handler chain then is may be possible to perform a directory traversal attack. If you set this to false make sure you have some kind of check in place to control the path. Parameters canonicalizePaths:boolean If paths should be canonicalized

public void setCanonicalizePaths(boolean canonicalizePaths)

If this handler should use canonicalized paths.

Warning

If this is not true and io.undertow.server.handlers.CanonicalPathHandler is not installed in the handler chain then is may be possible to perform a directory traversal attack. If you set this to false make sure you have some kind of check in place to control the path.

Parameters

canonicalizePaths:boolean: If paths should be canonicalized

setContentEncodedResourceManager	back to summary
public ResourceHandler setContentEncodedResourceManager(ContentEncodedResourceManager contentEncodedResourceManager)

setDirectoryListingEnabled	back to summary
public ResourceHandler setDirectoryListingEnabled(final boolean directoryListingEnabled)

setMimeMappings	back to summary
public ResourceHandler setMimeMappings(final MimeMappings mimeMappings)

setResourceManager	back to summary
public ResourceHandler setResourceManager(final ResourceManager resourceManager)

setResourceSupplier	back to summary
public ResourceHandler setResourceSupplier(final ResourceSupplier resourceSupplier)

setWelcomeFiles	back to summary
public ResourceHandler setWelcomeFiles(String... files)

Modifier and Type	Method and Description
public HandlerWrapper	build(Map<String, Object> The handler config config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler
public String	defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.
public String	name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name.
public Map<String, Class<?>>	parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types.
public Set<String>	requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Modifier and Type	Field and Description
private final boolean	allowDirectoryListing
private final String	location

public Class ResourceHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ResourceHandler.Builder

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ResourceHandler.Wrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail