Class GrpcSecurityHandlerConfig.Builder

java.lang.Object

io.helidon.webserver.grpc.security.GrpcSecurityHandlerConfig.BuilderBase<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig>

io.helidon.webserver.grpc.security.GrpcSecurityHandlerConfig.Builder

All Implemented Interfaces:

Prototype.Builder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig>, Builder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandler>, ConfigBuilderSupport.ConfiguredBuilder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig>, Supplier<GrpcSecurityHandler>

Enclosing interface:

GrpcSecurityHandlerConfig

public static class GrpcSecurityHandlerConfig.Builder
extends GrpcSecurityHandlerConfig.BuilderBase<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig>
implements Builder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandler>

Fluent API builder for GrpcSecurityHandler.

Nested Class Summary

Nested classes/interfaces inherited from class GrpcSecurityHandlerConfig.BuilderBase

GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl

Modifier and Type	Class	Description
protected static class	GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
GrpcSecurityHandler	build()	Create an instance from this builder.
GrpcSecurityHandlerConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class GrpcSecurityHandlerConfig.BuilderBase

addObject, addObject, addRoleAllowed, addRolesAllowed, addSecurityLevel, addSecurityLevel, addSecurityLevels, audit, audit, auditErrorSeverity, auditErrorSeverity, auditEventType, auditEventType, auditMessageFormat, auditMessageFormat, auditOkSeverity, auditOkSeverity, authenticate, authenticate, authenticationOptional, authenticationOptional, authenticator, authenticator, authorize, authorize, authorizer, authorizer, clearAudit, clearAuditErrorSeverity, clearAuditEventType, clearAuditMessageFormat, clearAuditOkSeverity, clearAuthenticate, clearAuthenticationOptional, clearAuthenticator, clearAuthorize, clearAuthorizer, clearCustomObjects, clearInheritedAuthenticator, clearInheritedAuthenticator, clearInheritedAuthorizer, clearInheritedAuthorizer, clearInheritedRolesAllowed, clearInheritedRolesAllowed, clearRolesAllowed, clearSecurityLevels, config, config, customObjects, customObjects, from, from, preBuildPrototype, rolesAllowed, rolesAllowed, securityLevels, securityLevels, toString, validatePrototype

Modifier and Type	Method	Description
GrpcSecurityHandlerConfig.Builder	addObject(Class<?> objectType, Object object)	Register a custom object for security request(s).
GrpcSecurityHandlerConfig.Builder	addObject(Object object)	Register a custom object for security request(s).
GrpcSecurityHandlerConfig.Builder	addRoleAllowed(String roleAllowed)	An array of allowed roles for this gRPC method.
GrpcSecurityHandlerConfig.Builder	addRolesAllowed(Set<String> rolesAllowed)	An array of allowed roles for this gRPC method.
GrpcSecurityHandlerConfig.Builder	addSecurityLevel(SecurityLevel securityLevel)	Security levels discovered from endpoint annotations.
GrpcSecurityHandlerConfig.Builder	addSecurityLevel(Consumer<SecurityLevel.SecurityLevelBuilder> consumer)	Security levels discovered from endpoint annotations.
GrpcSecurityHandlerConfig.Builder	addSecurityLevels(List<? extends SecurityLevel> securityLevels)	Security levels discovered from endpoint annotations.
Optional<Boolean>	audit()	Whether to audit this request.
GrpcSecurityHandlerConfig.Builder	audit(boolean audit)	Whether to audit this request.
Optional<AuditEvent.AuditSeverity>	auditErrorSeverity()	Severity to use for failed requests.
GrpcSecurityHandlerConfig.Builder	auditErrorSeverity(AuditEvent.AuditSeverity auditErrorSeverity)	Severity to use for failed requests.
Optional<String>	auditEventType()	Override for audit event type.
GrpcSecurityHandlerConfig.Builder	auditEventType(String auditEventType)	Override for audit event type.
Optional<String>	auditMessageFormat()	Override for audit message format.
GrpcSecurityHandlerConfig.Builder	auditMessageFormat(String auditMessageFormat)	Override for audit message format.
Optional<AuditEvent.AuditSeverity>	auditOkSeverity()	Severity to use for successful requests.
GrpcSecurityHandlerConfig.Builder	auditOkSeverity(AuditEvent.AuditSeverity auditOkSeverity)	Severity to use for successful requests.
Optional<Boolean>	authenticate()	Whether to authenticate this request.
GrpcSecurityHandlerConfig.Builder	authenticate(boolean authenticate)	Whether to authenticate this request.
Optional<Boolean>	authenticationOptional()	Whether authentication failure should continue as anonymous.
GrpcSecurityHandlerConfig.Builder	authenticationOptional(boolean authenticationOptional)	Whether authentication failure should continue as anonymous.
Optional<String>	authenticator()	Use a named authenticator.
GrpcSecurityHandlerConfig.Builder	authenticator(String authenticator)	Use a named authenticator.
Optional<Boolean>	authorize()	Whether to authorize this request.
GrpcSecurityHandlerConfig.Builder	authorize(boolean authorize)	Whether to authorize this request.
Optional<String>	authorizer()	Use a named authorizer.
GrpcSecurityHandlerConfig.Builder	authorizer(String authorizer)	Use a named authorizer.
GrpcSecurityHandlerConfig.Builder	clearAudit()	Clear existing value of audit.
GrpcSecurityHandlerConfig.Builder	clearAuditErrorSeverity()	Clear existing value of auditErrorSeverity.
GrpcSecurityHandlerConfig.Builder	clearAuditEventType()	Clear existing value of auditEventType.
GrpcSecurityHandlerConfig.Builder	clearAuditMessageFormat()	Clear existing value of auditMessageFormat.
GrpcSecurityHandlerConfig.Builder	clearAuditOkSeverity()	Clear existing value of auditOkSeverity.
GrpcSecurityHandlerConfig.Builder	clearAuthenticate()	Clear existing value of authenticate.
GrpcSecurityHandlerConfig.Builder	clearAuthenticationOptional()	Clear existing value of authenticationOptional.
GrpcSecurityHandlerConfig.Builder	clearAuthenticator()	Clear existing value of authenticator.
GrpcSecurityHandlerConfig.Builder	clearAuthorize()	Clear existing value of authorize.
GrpcSecurityHandlerConfig.Builder	clearAuthorizer()	Clear existing value of authorizer.
GrpcSecurityHandlerConfig.Builder	clearCustomObjects()	Clear existing value of customObjects.
boolean	clearInheritedAuthenticator()	Whether to clear an authenticator inherited from service defaults.
GrpcSecurityHandlerConfig.Builder	clearInheritedAuthenticator(boolean clearInheritedAuthenticator)	Whether to clear an authenticator inherited from service defaults.
boolean	clearInheritedAuthorizer()	Whether to clear an authorizer inherited from service defaults.
GrpcSecurityHandlerConfig.Builder	clearInheritedAuthorizer(boolean clearInheritedAuthorizer)	Whether to clear an authorizer inherited from service defaults.
boolean	clearInheritedRolesAllowed()	Whether to clear roles inherited from service defaults.
GrpcSecurityHandlerConfig.Builder	clearInheritedRolesAllowed(boolean clearInheritedRolesAllowed)	Whether to clear roles inherited from service defaults.
GrpcSecurityHandlerConfig.Builder	clearRolesAllowed()	Clear all rolesAllowed.
GrpcSecurityHandlerConfig.Builder	clearSecurityLevels()	Clear all securityLevels.
Optional<Config>	config()	Configuration associated with this security handler.
GrpcSecurityHandlerConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Optional<ClassToInstanceStore<Object>>	customObjects()	A store of custom objects, that can be used to customize specific security providers.
GrpcSecurityHandlerConfig.Builder	customObjects(ClassToInstanceStore<Object> customObjects)	A store of custom objects, that can be used to customize specific security providers.
GrpcSecurityHandlerConfig.Builder	from(GrpcSecurityHandlerConfig prototype)	Update this builder from an existing prototype instance.
GrpcSecurityHandlerConfig.Builder	from(GrpcSecurityHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
Set<String>	rolesAllowed()	An array of allowed roles for this gRPC method.
GrpcSecurityHandlerConfig.Builder	rolesAllowed(Set<String> rolesAllowed)	An array of allowed roles for this gRPC method.
List<SecurityLevel>	securityLevels()	Security levels discovered from endpoint annotations.
GrpcSecurityHandlerConfig.Builder	securityLevels(List<? extends SecurityLevel> securityLevels)	Security levels discovered from endpoint annotations.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default GrpcSecurityHandler	get()
default GrpcSecurityHandlerConfig.Builder	identity()	Instance of this builder as the correct type.
default GrpcSecurityHandlerConfig.Builder	update(Consumer<GrpcSecurityHandlerConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default GrpcSecurityHandlerConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public GrpcSecurityHandlerConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig>

Returns:

an instance of the setup object created from this builder

build

public GrpcSecurityHandler build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandler>

Returns:

instance of the built type