Module io.helidon.webserver.grpc.security

Package io.helidon.webserver.grpc.security

Class GrpcSecurityMethodConfig.BuilderBase.GrpcSecurityMethodConfigImpl

java.lang.Object

io.helidon.webserver.grpc.security.GrpcSecurityMethodConfig.BuilderBase.GrpcSecurityMethodConfigImpl

All Implemented Interfaces:

Prototype.Api, GrpcSecurityMethodConfig

Enclosing class:

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

protected static class GrpcSecurityMethodConfig.BuilderBase.GrpcSecurityMethodConfigImpl
extends Object
implements GrpcSecurityMethodConfig

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.GrpcSecurityMethodConfig

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcSecurityMethodConfigImpl(GrpcSecurityMethodConfig.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.
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)
int	hashCode()
String	name()	Bare gRPC method name such as Upper, not the full gRPC method path such as StringService/Upper.
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

GrpcSecurityMethodConfigImpl

protected GrpcSecurityMethodConfigImpl(GrpcSecurityMethodConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

name

public String name()

Description copied from interface: GrpcSecurityMethodConfig

Bare gRPC method name such as Upper, not the full gRPC method path such as StringService/Upper.

Specified by:

name in interface GrpcSecurityMethodConfig

Returns:

gRPC method name

rolesAllowed

public Set<String> rolesAllowed()

Description copied from interface: GrpcSecurityMethodConfig

An array of allowed roles for this gRPC method.

Specified by:

rolesAllowed in interface GrpcSecurityMethodConfig

Returns:

if subject is any of these roles, allow access

authenticator

public Optional<String> authenticator()

Description copied from interface: GrpcSecurityMethodConfig

Use a named authenticator.

Specified by:

authenticator in interface GrpcSecurityMethodConfig

Returns:

name of authenticator as configured in Security

authorizer

public Optional<String> authorizer()

Description copied from interface: GrpcSecurityMethodConfig

Use a named authorizer.

Specified by:

authorizer in interface GrpcSecurityMethodConfig

Returns:

name of authorizer as configured in Security

authenticate

public Optional<Boolean> authenticate()

Description copied from interface: GrpcSecurityMethodConfig

Whether to authenticate this request.

Specified by:

authenticate in interface GrpcSecurityMethodConfig

Returns:

whether to authenticate

authenticationOptional

public Optional<Boolean> authenticationOptional()

Description copied from interface: GrpcSecurityMethodConfig

Whether authentication failure should continue as anonymous.

Specified by:

authenticationOptional in interface GrpcSecurityMethodConfig

Returns:

whether authentication is optional

audit

public Optional<Boolean> audit()

Description copied from interface: GrpcSecurityMethodConfig

Whether to audit this request.

Specified by:

audit in interface GrpcSecurityMethodConfig

Returns:

whether to audit

authorize

public Optional<Boolean> authorize()

Description copied from interface: GrpcSecurityMethodConfig

Whether to authorize this request.

Specified by:

authorize in interface GrpcSecurityMethodConfig

Returns:

whether to authorize

auditEventType

public Optional<String> auditEventType()

Description copied from interface: GrpcSecurityMethodConfig

Override for audit event type.

Specified by:

auditEventType in interface GrpcSecurityMethodConfig

Returns:

audit event type

auditMessageFormat

public Optional<String> auditMessageFormat()

Description copied from interface: GrpcSecurityMethodConfig

Override for audit message format.

Specified by:

auditMessageFormat in interface GrpcSecurityMethodConfig

Returns:

audit message format

customObjects

public Optional<ClassToInstanceStore<Object>> customObjects()

Description copied from interface: GrpcSecurityMethodConfig

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

Specified by:

customObjects in interface GrpcSecurityMethodConfig

Returns:

custom objects

config

public Optional<Config> config()

Description copied from interface: GrpcSecurityMethodConfig

Configuration associated with this security handler.

Specified by:

config in interface GrpcSecurityMethodConfig

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