Package org.apache.juneau.rest.server.convention

Class FaviconServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.apache.juneau.rest.server.servlet.RestServlet

org.apache.juneau.rest.server.convention.FaviconServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class FaviconServlet
extends RestServlet

Standalone servlet companion of the FaviconMixin mixin.

Mounts as a sibling top-level servlet at /favicon.ico and serves the configured favicon bytes by delegating to a shared flavor-neutral FaviconProvider worker bean — the same worker the mixin and child flavors use, so the forms cannot drift. Browsers fetch /favicon.ico from the site root, so a standalone servlet at that fixed path is the natural deployment for sites that do not compose the mixin into an existing host resource.

Microservice registration:

@Bean Servlet favicon() { return new FaviconServlet(); // auto-mounted at /favicon.ico }

See Also:

• FaviconMixin
• FaviconProvider
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Nested Class Summary

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

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

Field Summary

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FaviconServlet()	No-arg constructor — uses a default FaviconProvider worker.
protected	FaviconServlet(FaviconProvider worker)	Worker constructor.

Method Summary

Modifier and Type	Method	Description
HttpResource	getFavicon()	[GET /*] — serve the configured favicon bytes.

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

builder, createAuthenticator, destroy, doLog, getContext, getPath, getPaths, getRequest, getResponse, getRestBuilder, init, log, log, service, setContext

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, isSensitiveHeader, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

FaviconServlet

public FaviconServlet()

No-arg constructor — uses a default FaviconProvider worker.

FaviconServlet

protected FaviconServlet(FaviconProvider worker)

Worker constructor.

Parameters:

worker - The shared flavor-neutral favicon worker this servlet delegates to. Must not be null.

Method Details

getFavicon

public HttpResource getFavicon()

[GET /*] — serve the configured favicon bytes.

Returns:

The favicon as an HttpResource with proper headers.