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

Class FaviconProvider.Builder

java.lang.Object

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

Enclosing class:

FaviconProvider

public static class FaviconProvider.Builder
extends Object

Builder for FaviconProvider instances.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FaviconProvider	build()	Builds a FaviconProvider instance.
FaviconProvider.Builder	bytes(byte[] value)	Sets the raw favicon bytes.
FaviconProvider.Builder	cacheControl(String value)	Sets the Cache-Control header value emitted with the favicon response.
FaviconProvider.Builder	classpath(String value)	Sets the classpath resource path from which to load the favicon bytes.

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 FaviconProvider.create().

Method Details

bytes

public FaviconProvider.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 FaviconProvider.Builder classpath(String value)

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

Resolved via FaviconProvider.class.getResourceAsStream(...) at build() time. 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 FaviconProvider.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 FaviconProvider build()

Builds a FaviconProvider instance.

Returns:

A configured instance.