Package org.apache.juneau.rest.server.converter

Class IntrospectableSettings.Builder

java.lang.Object

org.apache.juneau.rest.server.converter.IntrospectableSettings.Builder

Enclosing class:

IntrospectableSettings

public static class IntrospectableSettings.Builder
extends Object

Builder for IntrospectableSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IntrospectableSettings.Builder	allow(Class<?> declaringClass, String... signatures)	Allow-lists specific method signatures declared on (or inherited by) the specified class.
IntrospectableSettings.Builder	allow(Predicate<Method> filter)	Allow-lists methods matching the specified filter.
IntrospectableSettings.Builder	allowAll()	Allow-lists any public, non-deprecated method — the pre-10.0 behavior.
IntrospectableSettings	build()	Builds the settings.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

allow

public IntrospectableSettings.Builder allow(Predicate<Method> filter)

Allow-lists methods matching the specified filter.

Can be called multiple times; the filters are OR'ed together, so a method is allowed if it matches any filter that was added.

Parameters:

filter - Filter that returns true for methods that may be invoked.

Returns:

This object.

allow

public IntrospectableSettings.Builder allow(Class<?> declaringClass,
 String... signatures)

Allow-lists specific method signatures declared on (or inherited by) the specified class.

Example:

IntrospectableSettings.create().allow(MyBean.class, "getName", "getAge");

Parameters:

declaringClass - The class the allow-listed methods must be declared on (or a subtype thereof).

signatures - One or more method signatures as returned by MethodInfo.getSignature() (e.g. "getName", "substring(int,int)").

Returns:

This object.

allowAll

public IntrospectableSettings.Builder allowAll()

Allow-lists any public, non-deprecated method — the pre-10.0 behavior.

Use only for trusted resources whose response objects' full public API surface is one you're comfortable exposing to any caller who can reach this endpoint, since the method name and arguments for Introspectable always come from untrusted request query parameters.

Returns:

This object.

build

public IntrospectableSettings build()

Builds the settings.

Returns:

A new IntrospectableSettings.