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

Class SeoMixin.Builder

java.lang.Object

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

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

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

All Implemented Interfaces:

RestBuilder<SeoMixin.Builder>

Enclosing class:

SeoMixin

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

Builder for SeoMixin instances.

Extends RestMixin.Builder so the mixin's bespoke robots/sitemap setters chain with true covariant returns alongside the inherited RestBuildersurface (e.g. path, roleGuard).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SeoMixin	build()	Builds a SeoMixin instance.
SeoMixin.Builder	robotsAllow(String userAgent, String... paths)	Adds an Allow rule to the robots policy.
SeoMixin.Builder	robotsDisallow(String userAgent, String... paths)	Adds a Disallow rule to the robots policy.
SeoMixin.Builder	robotsTxt(String value)	Sets a fully-formed robots.txt body, overriding any rule-builder calls.
SeoMixin.Builder	sitemapEntry(String url)	Adds a sitemap entry with only the loc URL.
SeoMixin.Builder	sitemapEntry(String url, ZonedDateTime lastmod, String changefreq, Double priority)	Adds a sitemap entry with optional lastmod, changefreq, and priority components.

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

Method Details

robotsAllow

public SeoMixin.Builder robotsAllow(String userAgent,
 String... paths)

Adds an Allow rule to the robots policy.

Multiple invocations append rules in order. The first call to either robotsAllow(...) or robotsDisallow(...) replaces the deny-all default; subsequent calls continue to append.

Parameters:

userAgent - The user agent (e.g. "*" or "Googlebot"). Must not be null or blank.

paths - Allowed path prefixes (e.g. "/"). At least one path is required.

Returns:

This object.

robotsDisallow

public SeoMixin.Builder robotsDisallow(String userAgent,
 String... paths)

Adds a Disallow rule to the robots policy.

Parameters:

userAgent - The user agent (e.g. "*"). Must not be null or blank.

paths - Disallowed path prefixes. At least one path is required.

Returns:

This object.

robotsTxt

public SeoMixin.Builder robotsTxt(String value)

Sets a fully-formed robots.txt body, overriding any rule-builder calls.

Useful when the desired policy doesn't fit the simple allow/disallow/per-user-agent shape of robotsAllow(...) / robotsDisallow(...) (e.g. when including Sitemap: or Crawl-delay: directives).

Parameters:

value - The full robots.txt body. Must not be null.

Returns:

This object.

sitemapEntry

public SeoMixin.Builder sitemapEntry(String url)

Adds a sitemap entry with only the loc URL.

Parameters:

url - The fully-qualified URL.

Returns:

This object.

sitemapEntry

public SeoMixin.Builder sitemapEntry(String url,
 ZonedDateTime lastmod,
 String changefreq,
 Double priority)

Adds a sitemap entry with optional lastmod, changefreq, and priority components.

Parameters:

url - The fully-qualified URL.

lastmod - The last-modified instant (or null to omit).

changefreq - Change-frequency hint (e.g. "weekly", "daily"; or null to omit).

priority - Priority value 0.0..1.0 (or null to omit).

Returns:

This object.

build

public SeoMixin build()

Builds a SeoMixin instance.

Overrides:

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

Returns:

A configured instance.