Package org.apache.juneau.rest.server.ops

Class HtdocMixin

java.lang.Object

org.apache.juneau.rest.server.servlet.RestMixin

org.apache.juneau.rest.server.ops.HtdocMixin

public class HtdocMixin
extends RestMixin

Mixin providing the residual [GET /htdocs/*] static-file endpoint.

Single-responsibility op-mixin carved out of the former BasicRestOperations interface. Delegates the requested path to StaticFilesMixin.resolveStaticFile(RestRequest,String,Locale) — the same resolution chokepoint used by the newer StaticFilesMixin's configurable-mount handlers — so there is a single implementation of the static-file lookup logic even though this mixin keeps its own fixed, GET-only /htdocs/* mount for backward compatibility.

The greedy /htdocs/* blob handler is not API-meaningful and is excluded from the published Swagger/OpenAPI specification via @OpSwagger(ignore=true).

See Also:

• StaticFilesMixin

Since:

10.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.rest.server.servlet.RestMixin

RestMixin.Builder<R extends RestMixin,SELF extends RestMixin.Builder<R,SELF>>, RestMixin.DefaultBuilder<R extends RestMixin>

Constructor Summary

Constructors

Constructor	Description
HtdocMixin()

Method Summary

Modifier and Type	Method	Description
HttpResource	getHtdoc(RestRequest req, String path, Locale locale)	[GET /htdocs/*] - Retrieve static file.

Methods inherited from class org.apache.juneau.rest.server.servlet.RestMixin

builder, getHostContext, getRestBuilder, setContext

Methods inherited from class java.lang.Object

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

Constructor Details

HtdocMixin

public HtdocMixin()

Method Details

getHtdoc

public HttpResource getHtdoc(RestRequest req,
 @Path("/*")
 String path,
 Locale locale)
                      throws NotFound

[GET /htdocs/*] - Retrieve static file.

Parameters:

req - The HTTP request.

path - The path to retrieve.

locale - The locale of the HTTP request.

Returns:

An HTTP resource representing the static file.

Throws:

NotFound - If no resource matches the requested path.