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

Class FaviconProvider

java.lang.Object

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

public class FaviconProvider
extends Object

Flavor-neutral favicon worker bean shared by the favicon @Rest flavors.

Holds the capability state (the icon bytes + Cache-Control header value) and the serve logic (build an HttpResource with Content-Type: image/x-icon + the cache header). The FaviconMixin (mixin), FaviconResource (child), and FaviconServlet (servlet) flavors are independent @Rest classes that each hold a FaviconProvider worker and delegate to it — so the three deployment forms cannot drift, and no flavor is another flavor's worker.

See Also:

• FaviconMixin
• FaviconResource
• FaviconServlet
• REST Server — Mixins and Multi-Mount Paths

Since:

10.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FaviconProvider.Builder	Builder for FaviconProvider instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CACHE_CONTROL	Default Cache-Control header value: max-age=2592000, public (30 days).

Constructor Summary

Constructors

Modifier	Constructor	Description
	FaviconProvider()	No-arg constructor — loads the default Juneau-branded favicon from the classpath.
protected	FaviconProvider(FaviconProvider.Builder builder)	Builder constructor.

Method Summary

Modifier and Type	Method	Description
static FaviconProvider.Builder	create()	Creates a new builder for configuring a FaviconProvider.
HttpResource	serve()	Serves the configured favicon bytes.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CACHE_CONTROL

public static final String DEFAULT_CACHE_CONTROL

Default Cache-Control header value: max-age=2592000, public (30 days).

See Also:

• Constant Field Values

Constructor Details

FaviconProvider

public FaviconProvider()

No-arg constructor — loads the default Juneau-branded favicon from the classpath.

FaviconProvider

protected FaviconProvider(FaviconProvider.Builder builder)

Builder constructor.

Parameters:

builder - The builder. Must not be null.

Method Details

create

public static FaviconProvider.Builder create()

Creates a new builder for configuring a FaviconProvider.

Returns:

A new builder.

serve

public HttpResource serve()

Serves the configured favicon bytes.

Returns:

The favicon as an HttpResource with Content-Type: image/x-icon and the configured Cache-Control header.