Module io.helidon.webserver.grpc.security

Package io.helidon.webserver.grpc.security

Class GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl

java.lang.Object

io.helidon.webserver.grpc.security.GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<GrpcSecurityHandler>, GrpcSecurityHandlerConfig, Supplier<GrpcSecurityHandler>

Enclosing class:

GrpcSecurityHandlerConfig.BuilderBase<BUILDER extends GrpcSecurityHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GrpcSecurityHandlerConfig>

protected static class GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl
extends Object
implements GrpcSecurityHandlerConfig, Supplier<GrpcSecurityHandler>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.grpc.security.GrpcSecurityHandlerConfig

GrpcSecurityHandlerConfig.Builder, GrpcSecurityHandlerConfig.BuilderBase<BUILDER extends GrpcSecurityHandlerConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends GrpcSecurityHandlerConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcSecurityHandlerConfigImpl(GrpcSecurityHandlerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	audit()	Whether to audit this request.
Optional<String>	auditEventType()	Override for audit event type.
Optional<String>	auditMessageFormat()	Override for audit message format.
Optional<Boolean>	authenticate()	Whether to authenticate this request.
Optional<Boolean>	authenticationOptional()	Whether authentication failure should continue as anonymous.
Optional<String>	authenticator()	Use a named authenticator.
Optional<Boolean>	authorize()	Whether to authorize this request.
Optional<String>	authorizer()	Use a named authorizer.
GrpcSecurityHandler	build()	Create a new instance of the runtime type from this config object.
Optional<Config>	config()	Configuration associated with this security handler.
Optional<ClassToInstanceStore<Object>>	customObjects()	A store of custom objects, that can be used to customize specific security providers.
boolean	equals(Object o)
GrpcSecurityHandler	get()
int	hashCode()
Set<String>	rolesAllowed()	An array of allowed roles for this gRPC method.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GrpcSecurityHandlerConfigImpl

protected GrpcSecurityHandlerConfigImpl(GrpcSecurityHandlerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public GrpcSecurityHandler build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<GrpcSecurityHandler>

Returns:

new configured runtime instance

get

public GrpcSecurityHandler get()

Specified by:

get in interface Supplier<GrpcSecurityHandler>

rolesAllowed

public Set<String> rolesAllowed()

Description copied from interface: GrpcSecurityHandlerConfig

An array of allowed roles for this gRPC method.

Specified by:

rolesAllowed in interface GrpcSecurityHandlerConfig

Returns:

if subject is any of these roles, allow access

authenticator

public Optional<String> authenticator()

Description copied from interface: GrpcSecurityHandlerConfig

Use a named authenticator.

Specified by:

authenticator in interface GrpcSecurityHandlerConfig

Returns:

name of authenticator as configured in Security

authorizer

public Optional<String> authorizer()

Description copied from interface: GrpcSecurityHandlerConfig

Use a named authorizer.

Specified by:

authorizer in interface GrpcSecurityHandlerConfig

Returns:

name of authorizer as configured in Security

authenticate

public Optional<Boolean> authenticate()

Description copied from interface: GrpcSecurityHandlerConfig

Whether to authenticate this request.

Specified by:

authenticate in interface GrpcSecurityHandlerConfig

Returns:

whether to authenticate

authenticationOptional

public Optional<Boolean> authenticationOptional()

Description copied from interface: GrpcSecurityHandlerConfig

Whether authentication failure should continue as anonymous.

Specified by:

authenticationOptional in interface GrpcSecurityHandlerConfig

Returns:

whether authentication is optional

audit

public Optional<Boolean> audit()

Description copied from interface: GrpcSecurityHandlerConfig

Whether to audit this request.

Specified by:

audit in interface GrpcSecurityHandlerConfig

Returns:

whether to audit

authorize

public Optional<Boolean> authorize()

Description copied from interface: GrpcSecurityHandlerConfig

Whether to authorize this request.

Specified by:

authorize in interface GrpcSecurityHandlerConfig

Returns:

whether to authorize

auditEventType

public Optional<String> auditEventType()

Description copied from interface: GrpcSecurityHandlerConfig

Override for audit event type.

Specified by:

auditEventType in interface GrpcSecurityHandlerConfig

Returns:

audit event type

auditMessageFormat

public Optional<String> auditMessageFormat()

Description copied from interface: GrpcSecurityHandlerConfig

Override for audit message format.

Specified by:

auditMessageFormat in interface GrpcSecurityHandlerConfig

Returns:

audit message format

customObjects

public Optional<ClassToInstanceStore<Object>> customObjects()

Description copied from interface: GrpcSecurityHandlerConfig

A store of custom objects, that can be used to customize specific security providers.

Specified by:

customObjects in interface GrpcSecurityHandlerConfig

Returns:

custom objects

config

public Optional<Config> config()

Description copied from interface: GrpcSecurityHandlerConfig

Configuration associated with this security handler.

Specified by:

config in interface GrpcSecurityHandlerConfig

Returns:

the configuration

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object