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

Class FaviconMixin.Builder

java.lang.Object

org.apache.juneau.rest.server.AbstractRestBuilder<R,SELF>

org.apache.juneau.rest.server.servlet.RestMixin.Builder<FaviconMixin,FaviconMixin.Builder>

org.apache.juneau.rest.server.convention.FaviconMixin.Builder

All Implemented Interfaces:

RestBuilder<FaviconMixin.Builder>

Enclosing class:

FaviconMixin

public static class FaviconMixin.Builder
extends RestMixin.Builder<FaviconMixin,FaviconMixin.Builder>

Builder for FaviconMixin instances.

Mirrors FaviconProvider.Builder's configuration methods on the mixin's own surface and forwards each call to an underlying FaviconProvider.Builder, which builds the shared worker the mixin delegates to.

Extends RestMixin.Builder so the mixin's bespoke worker-config setters (bytes(byte[]), classpath(String), cacheControl(String)) chain with true covariant returns alongside the inherited RestBuildersurface (e.g. path, roleGuard). This is how a multi-flavor capability avoids triplicating its REST-level config: the worker config is forwarded once into FaviconProvider.Builder, and the REST config is inherited once from AbstractRestBuilder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor — package access for FaviconMixin.create().

Method Summary

Modifier and Type	Method	Description
FaviconMixin	build()	Builds a FaviconMixin instance, delegating to the shared FaviconProvider worker and stashing this builder so its @Rest-level overrides take precedence over the annotation.
FaviconMixin.Builder	bytes(byte[] value)	Sets the raw favicon bytes.
FaviconMixin.Builder	cacheControl(String value)	Sets the Cache-Control header value emitted with the favicon response.
FaviconMixin.Builder	classpath(String value)	Sets the classpath resource path from which to load the favicon bytes.

Methods inherited from class org.apache.juneau.rest.server.AbstractRestBuilder

allowedHeaderParams, allowedMethodHeaders, allowedMethodParams, allowedParserOptions, allowedSerializerOptions, asyncCompletionExecutor, asyncTimeoutMillis, children, clientVersionHeader, config, consumes, converters, createResource, debugMarshalling, defaultAccept, defaultCharset, defaultContentType, defaultRequestAttributes, defaultRequestHeaders, defaultResponseHeaders, description, disableContentParam, eagerInit, encoders, getExtras, getMdcAsyncPropagation, getResourceType, guards, lazyChildren, maxInput, mdcAsyncPropagation, messages, mixinDefs, mixins, noInherit, observability, openApiProvider, parsers, partParser, partSerializer, path, paths, problemDetails, produces, renderResponseStackTraces, responseProcessors, restOpArgs, roleGuard, rolesDeclared, self, serializers, set, siteName, staticFiles, swaggerProvider, title, toRestAnnotation, uriAuthority, uriContext, uriRelativity, uriResolution, virtualThreads

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor — package access for FaviconMixin.create().

Method Details

bytes

public FaviconMixin.Builder bytes(byte[] value)

Sets the raw favicon bytes.

Mutually exclusive with classpath(String) — whichever is set last wins at build() time.

Parameters:

value - The favicon bytes (typically an .ico or .png payload). Must not be null.

Returns:

This object.

classpath

public FaviconMixin.Builder classpath(String value)

Sets the classpath resource path from which to load the favicon bytes.

A resolved-to-null stream falls back to the framework's default favicon. Mutually exclusive with bytes(byte[]).

Parameters:

value - The classpath resource path (e.g. "/myapp/icon.ico"). Must not be null or blank.

Returns:

This object.

cacheControl

public FaviconMixin.Builder cacheControl(String value)

Sets the Cache-Control header value emitted with the favicon response.

Defaults to "max-age=2592000, public" (30 days).

Parameters:

value - The new Cache-Control value. Must not be null or blank.

Returns:

This object.

build

public FaviconMixin build()

Builds a FaviconMixin instance, delegating to the shared FaviconProvider worker and stashing this builder so its @Rest-level overrides take precedence over the annotation.

Overrides:

build in class RestMixin.Builder<FaviconMixin,FaviconMixin.Builder>

Returns:

A configured instance.