Class SecurityHandlerConfig.Builder

java.lang.Object

io.helidon.webserver.security.SecurityHandlerConfig.BuilderBase<SecurityHandlerConfig.Builder, SecurityHandlerConfig>

io.helidon.webserver.security.SecurityHandlerConfig.Builder

All Implemented Interfaces:

Prototype.Builder<SecurityHandlerConfig.Builder, SecurityHandlerConfig>, Builder<SecurityHandlerConfig.Builder, SecurityHandler>, ConfigBuilderSupport.ConfiguredBuilder<SecurityHandlerConfig.Builder, SecurityHandlerConfig>, Supplier<SecurityHandler>

Enclosing interface:

SecurityHandlerConfig

public static class SecurityHandlerConfig.Builder
extends SecurityHandlerConfig.BuilderBase<SecurityHandlerConfig.Builder, SecurityHandlerConfig>
implements Builder<SecurityHandlerConfig.Builder, SecurityHandler>

Fluent API builder for SecurityHandler.

Nested Class Summary

Nested classes/interfaces inherited from class SecurityHandlerConfig.BuilderBase

SecurityHandlerConfig.BuilderBase.SecurityHandlerConfigImpl

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

Method Summary

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

Methods inherited from class SecurityHandlerConfig.BuilderBase

addObject, addObject, addQueryParam, addQueryParams, addRoleAllowed, addRolesAllowed, addSockets, audit, audit, auditEventType, auditEventType, auditMessageFormat, auditMessageFormat, authenticate, authenticate, authenticationOptional, authenticationOptional, authenticator, authenticator, authorize, authorize, authorizer, authorizer, clearAudit, clearAuditEventType, clearAuditMessageFormat, clearAuthenticate, clearAuthenticationOptional, clearAuthenticator, clearAuthorize, clearAuthorizer, clearCustomObjects, clearQueryParams, clearRolesAllowed, clearSockets, combined, combined, config, config, customObjects, customObjects, from, from, preBuildPrototype, queryParams, queryParams, rolesAllowed, rolesAllowed, sockets, sockets, toString, validatePrototype

Modifier and Type	Method	Description
SecurityHandlerConfig.Builder	addObject(Class<?> objectType, Object object)	Register a custom object for security request(s).
SecurityHandlerConfig.Builder	addObject(Object object)	Register a custom object for security request(s).
SecurityHandlerConfig.Builder	addQueryParam(SecurityHandler.QueryParamHandler queryParam)	Query parameter handler(s).
SecurityHandlerConfig.Builder	addQueryParams(List<? extends SecurityHandler.QueryParamHandler> queryParams)	Query parameter handler(s).
SecurityHandlerConfig.Builder	addRoleAllowed(String roleAllowed)	An array of allowed roles for this path - must have a security provider supporting roles (either authentication or authorization provider).
SecurityHandlerConfig.Builder	addRolesAllowed(Set<String> rolesAllowed)	An array of allowed roles for this path - must have a security provider supporting roles (either authentication or authorization provider).
SecurityHandlerConfig.Builder	addSockets(List<String> sockets)	List of sockets this configuration should be applied to.
Optional<Boolean>	audit()	Whether to audit this request - defaults to false, if enabled, request is audited with event type "request".
SecurityHandlerConfig.Builder	audit(boolean audit)	Whether to audit this request - defaults to false, if enabled, request is audited with event type "request".
Optional<String>	auditEventType()	Override for event-type, defaults to "request".
SecurityHandlerConfig.Builder	auditEventType(String auditEventType)	Override for event-type, defaults to "request".
Optional<String>	auditMessageFormat()	Override for audit message format, defaults to "%3$s %1$s \"%2$s\" %5$s %6$s requested by %4$s".
SecurityHandlerConfig.Builder	auditMessageFormat(String auditMessageFormat)	Override for audit message format, defaults to "%3$s %1$s \"%2$s\" %5$s %6$s requested by %4$s".
Optional<Boolean>	authenticate()	If called, request will go through authentication process - defaults to false (even if authorize is true).
SecurityHandlerConfig.Builder	authenticate(boolean authenticate)	If called, request will go through authentication process - defaults to false (even if authorize is true).
Optional<Boolean>	authenticationOptional()	If called, authentication failure will not abort request and will continue as anonymous (defaults to false).
SecurityHandlerConfig.Builder	authenticationOptional(boolean authenticationOptional)	If called, authentication failure will not abort request and will continue as anonymous (defaults to false).
Optional<String>	authenticator()	Use a named authenticator (as supported by security - if not defined, default authenticator is used).
SecurityHandlerConfig.Builder	authenticator(String authenticator)	Use a named authenticator (as supported by security - if not defined, default authenticator is used).
Optional<Boolean>	authorize()	Enable authorization for this route.
SecurityHandlerConfig.Builder	authorize(boolean authorize)	Enable authorization for this route.
Optional<String>	authorizer()	Use a named authorizer (as supported by security - if not defined, default authorizer is used, if none defined, all is permitted).
SecurityHandlerConfig.Builder	authorizer(String authorizer)	Use a named authorizer (as supported by security - if not defined, default authorizer is used, if none defined, all is permitted).
SecurityHandlerConfig.Builder	clearAudit()	Clear existing value of audit.
SecurityHandlerConfig.Builder	clearAuditEventType()	Clear existing value of auditEventType.
SecurityHandlerConfig.Builder	clearAuditMessageFormat()	Clear existing value of auditMessageFormat.
SecurityHandlerConfig.Builder	clearAuthenticate()	Clear existing value of authenticate.
SecurityHandlerConfig.Builder	clearAuthenticationOptional()	Clear existing value of authenticationOptional.
SecurityHandlerConfig.Builder	clearAuthenticator()	Clear existing value of authenticator.
SecurityHandlerConfig.Builder	clearAuthorize()	Clear existing value of authorize.
SecurityHandlerConfig.Builder	clearAuthorizer()	Clear existing value of authorizer.
SecurityHandlerConfig.Builder	clearCustomObjects()	Clear existing value of customObjects.
SecurityHandlerConfig.Builder	clearQueryParams()	Clear all queryParams.
SecurityHandlerConfig.Builder	clearRolesAllowed()	Clear all rolesAllowed.
SecurityHandlerConfig.Builder	clearSockets()	Clear all sockets.
boolean	combined()	Whether this is a combined handler.
SecurityHandlerConfig.Builder	combined(boolean combined)	Whether this is a combined handler.
Optional<Config>	config()	Configuration associated with this security handler.
SecurityHandlerConfig.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.
SecurityHandlerConfig.Builder	customObjects(ClassToInstanceStore<Object> customObjects)	A store of custom objects, that can be used to customize specific security providers.
SecurityHandlerConfig.Builder	from(SecurityHandlerConfig prototype)	Update this builder from an existing prototype instance.
SecurityHandlerConfig.Builder	from(SecurityHandlerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
List<SecurityHandler.QueryParamHandler>	queryParams()	Query parameter handler(s).
SecurityHandlerConfig.Builder	queryParams(List<? extends SecurityHandler.QueryParamHandler> queryParams)	Query parameter handler(s).
Set<String>	rolesAllowed()	An array of allowed roles for this path - must have a security provider supporting roles (either authentication or authorization provider).
SecurityHandlerConfig.Builder	rolesAllowed(Set<String> rolesAllowed)	An array of allowed roles for this path - must have a security provider supporting roles (either authentication or authorization provider).
List<String>	sockets()	List of sockets this configuration should be applied to.
SecurityHandlerConfig.Builder	sockets(List<String> sockets)	List of sockets this configuration should be applied to.
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 SecurityHandler	get()
default SecurityHandlerConfig.Builder	identity()	Instance of this builder as the correct type.
default SecurityHandlerConfig.Builder	update(Consumer<SecurityHandlerConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public SecurityHandlerConfig 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<SecurityHandlerConfig.Builder, SecurityHandlerConfig>

Returns:

an instance of the setup object created from this builder

build

public SecurityHandler 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<SecurityHandlerConfig.Builder, SecurityHandler>

Returns:

instance of the built type