Class AudienceValidator.Builder

java.lang.Object

io.helidon.security.jwt.AudienceValidator.Builder

All Implemented Interfaces:

Builder<io.helidon.security.jwt.CommonValidator.BaseBuilder<AudienceValidator.Builder, AudienceValidator>, AudienceValidator>, Supplier<AudienceValidator>

Enclosing class:

AudienceValidator

public static final class AudienceValidator.Builder
extends Object

Builder of the AudienceValidator.

Method Summary

Modifier and Type	Method	Description
AudienceValidator.Builder	addExpectedAudience(String audience)	Add expected audience value.
AudienceValidator	build()	Build the instance from this builder.
AudienceValidator.Builder	expectedAudience(Set<String> expectedAudience)	Overwrite previously set audience with the new Set of values.
AudienceValidator.Builder	mandatory(boolean mandatory)	Whether handled claim is mandatory to be present.
protected AudienceValidator.Builder	me()	Typed builder instance.
AudienceValidator.Builder	missingClaimMessage(String missingClaimMessage)	Custom missing claim error message.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default AudienceValidator	get()
default io.helidon.security.jwt.CommonValidator.BaseBuilder<AudienceValidator.Builder, AudienceValidator>	identity()	Instance of this builder as the correct type.
default io.helidon.security.jwt.CommonValidator.BaseBuilder<AudienceValidator.Builder, AudienceValidator>	update(Consumer<io.helidon.security.jwt.CommonValidator.BaseBuilder<AudienceValidator.Builder, AudienceValidator>> consumer)	Update the builder in a fluent API way.

Method Details

build

public AudienceValidator build()

Description copied from interface: Builder

Build the instance from this builder.

Returns:

instance of the built type

addExpectedAudience

public AudienceValidator.Builder addExpectedAudience(String audience)

Add expected audience value.

Parameters:

audience - expected audience

Returns:

updated builder instance

expectedAudience

public AudienceValidator.Builder expectedAudience(Set<String> expectedAudience)

Overwrite previously set audience with the new Set of values.

Parameters:

expectedAudience - expected audience values

Returns:

updated builder instance

mandatory

public AudienceValidator.Builder mandatory(boolean mandatory)

Whether handled claim is mandatory to be present. Default value is false.

Parameters:

mandatory - mandatory to be present

Returns:

updated builder instance

missingClaimMessage

public AudienceValidator.Builder missingClaimMessage(String missingClaimMessage)

Custom missing claim error message.

Parameters:

missingClaimMessage - missing claim error message

Returns:

updated builder instance

me

protected AudienceValidator.Builder me()

Typed builder instance.

Returns:

this builder instance