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

java.lang.Object
io.helidon.webserver.grpc.security.GrpcSecurityHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER, PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Direct Known Subclasses:
GrpcSecurityHandlerConfig.Builder
Enclosing interface:
GrpcSecurityHandlerConfig
public abstract static class GrpcSecurityHandlerConfig.BuilderBase<BUILDER extends GrpcSecurityHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends GrpcSecurityHandlerConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>
Fluent API builder base for GrpcSecurityHandlerConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(GrpcSecurityHandlerConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(GrpcSecurityHandlerConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • addObject

      public BUILDER addObject(Object object)
      Register a custom object for security request(s).
      Parameters:
      object - object expected by a security provider
      Returns:
      updated builder instance

    • addObject

      public BUILDER addObject(Class<?> objectType, Object object)
      Register a custom object for security request(s).
      Parameters:
      objectType - type to use for the object
      object - object expected by a security provider
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends GrpcSecurityHandlerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends GrpcSecurityHandlerConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • clearRolesAllowed

      public BUILDER clearRolesAllowed()
      Clear all rolesAllowed.
      Returns:
      updated builder instance
      See Also:

    • rolesAllowed

      public BUILDER rolesAllowed(Set<String> rolesAllowed)
      An array of allowed roles for this gRPC method.
      Parameters:
      rolesAllowed - if subject is any of these roles, allow access
      Returns:
      updated builder instance
      See Also:

    • addRolesAllowed

      public BUILDER addRolesAllowed(Set<String> rolesAllowed)
      An array of allowed roles for this gRPC method.
      Parameters:
      rolesAllowed - if subject is any of these roles, allow access
      Returns:
      updated builder instance
      See Also:

    • addRoleAllowed

      public BUILDER addRoleAllowed(String roleAllowed)
      An array of allowed roles for this gRPC method.
      Parameters:
      roleAllowed - add single if subject is any of these roles, allow access
      Returns:
      updated builder instance
      See Also:

    • clearInheritedRolesAllowed

      public BUILDER clearInheritedRolesAllowed(boolean clearInheritedRolesAllowed)
      Whether to clear roles inherited from service defaults.
      Parameters:
      clearInheritedRolesAllowed - whether to clear inherited roles
      Returns:
      updated builder instance
      See Also:

    • clearSecurityLevels

      public BUILDER clearSecurityLevels()
      Clear all securityLevels.
      Returns:
      updated builder instance
      See Also:

    • securityLevels

      public BUILDER securityLevels(List<? extends SecurityLevel> securityLevels)
      Security levels discovered from endpoint annotations.
      Parameters:
      securityLevels - security levels
      Returns:
      updated builder instance
      See Also:

    • addSecurityLevels

      public BUILDER addSecurityLevels(List<? extends SecurityLevel> securityLevels)
      Security levels discovered from endpoint annotations.
      Parameters:
      securityLevels - security levels
      Returns:
      updated builder instance
      See Also:

    • addSecurityLevel

      public BUILDER addSecurityLevel(SecurityLevel securityLevel)
      Security levels discovered from endpoint annotations.
      Parameters:
      securityLevel - add single security levels
      Returns:
      updated builder instance
      See Also:

    • addSecurityLevel

      public BUILDER addSecurityLevel(Consumer<SecurityLevel.SecurityLevelBuilder> consumer)
      Security levels discovered from endpoint annotations.
      Parameters:
      consumer - consumer of builder for security levels
      Returns:
      updated builder instance
      See Also:

    • clearAuthenticator

      public BUILDER clearAuthenticator()
      Clear existing value of authenticator.
      Returns:
      updated builder instance
      See Also:

    • authenticator

      public BUILDER authenticator(String authenticator)
      Use a named authenticator.
      Parameters:
      authenticator - name of authenticator as configured in Security
      Returns:
      updated builder instance
      See Also:

    • clearInheritedAuthenticator

      public BUILDER clearInheritedAuthenticator(boolean clearInheritedAuthenticator)
      Whether to clear an authenticator inherited from service defaults.
      Parameters:
      clearInheritedAuthenticator - whether to clear the inherited authenticator
      Returns:
      updated builder instance
      See Also:

    • clearAuthorizer

      public BUILDER clearAuthorizer()
      Clear existing value of authorizer.
      Returns:
      updated builder instance
      See Also:

    • authorizer

      public BUILDER authorizer(String authorizer)
      Use a named authorizer.
      Parameters:
      authorizer - name of authorizer as configured in Security
      Returns:
      updated builder instance
      See Also:

    • clearInheritedAuthorizer

      public BUILDER clearInheritedAuthorizer(boolean clearInheritedAuthorizer)
      Whether to clear an authorizer inherited from service defaults.
      Parameters:
      clearInheritedAuthorizer - whether to clear the inherited authorizer
      Returns:
      updated builder instance
      See Also:

    • clearAuthenticate

      public BUILDER clearAuthenticate()
      Clear existing value of authenticate.
      Returns:
      updated builder instance
      See Also:

    • authenticate

      public BUILDER authenticate(boolean authenticate)
      Whether to authenticate this request.
      Parameters:
      authenticate - whether to authenticate
      Returns:
      updated builder instance
      See Also:

    • clearAuthenticationOptional

      public BUILDER clearAuthenticationOptional()
      Clear existing value of authenticationOptional.
      Returns:
      updated builder instance
      See Also:

    • authenticationOptional

      public BUILDER authenticationOptional(boolean authenticationOptional)
      Whether authentication failure should continue as anonymous.
      Parameters:
      authenticationOptional - whether authentication is optional
      Returns:
      updated builder instance
      See Also:

    • clearAudit

      public BUILDER clearAudit()
      Clear existing value of audit.
      Returns:
      updated builder instance
      See Also:

    • audit

      public BUILDER audit(boolean audit)
      Whether to audit this request.
      Parameters:
      audit - whether to audit
      Returns:
      updated builder instance
      See Also:

    • clearAuthorize

      public BUILDER clearAuthorize()
      Clear existing value of authorize.
      Returns:
      updated builder instance
      See Also:

    • authorize

      public BUILDER authorize(boolean authorize)
      Whether to authorize this request.
      Parameters:
      authorize - whether to authorize
      Returns:
      updated builder instance
      See Also:

    • clearAuditEventType

      public BUILDER clearAuditEventType()
      Clear existing value of auditEventType.
      Returns:
      updated builder instance
      See Also:

    • auditEventType

      public BUILDER auditEventType(String auditEventType)
      Override for audit event type.
      Parameters:
      auditEventType - audit event type
      Returns:
      updated builder instance
      See Also:

    • clearAuditMessageFormat

      public BUILDER clearAuditMessageFormat()
      Clear existing value of auditMessageFormat.
      Returns:
      updated builder instance
      See Also:

    • auditMessageFormat

      public BUILDER auditMessageFormat(String auditMessageFormat)
      Override for audit message format.
      Parameters:
      auditMessageFormat - audit message format
      Returns:
      updated builder instance
      See Also:

    • clearAuditOkSeverity

      public BUILDER clearAuditOkSeverity()
      Clear existing value of auditOkSeverity.
      Returns:
      updated builder instance
      See Also:

    • auditOkSeverity

      public BUILDER auditOkSeverity(AuditEvent.AuditSeverity auditOkSeverity)
      Severity to use for successful requests.
      Parameters:
      auditOkSeverity - successful request audit severity
      Returns:
      updated builder instance
      See Also:

    • clearAuditErrorSeverity

      public BUILDER clearAuditErrorSeverity()
      Clear existing value of auditErrorSeverity.
      Returns:
      updated builder instance
      See Also:

    • auditErrorSeverity

      public BUILDER auditErrorSeverity(AuditEvent.AuditSeverity auditErrorSeverity)
      Severity to use for failed requests.
      Parameters:
      auditErrorSeverity - failed request audit severity
      Returns:
      updated builder instance
      See Also:

    • clearCustomObjects

      public BUILDER clearCustomObjects()
      Clear existing value of customObjects.
      Returns:
      updated builder instance
      See Also:

    • customObjects

      public BUILDER customObjects(ClassToInstanceStore<Object> customObjects)
      A store of custom objects, that can be used to customize specific security providers.
      Parameters:
      customObjects - custom objects
      Returns:
      updated builder instance
      See Also:

    • rolesAllowed

      public Set<String> rolesAllowed()
      An array of allowed roles for this gRPC method.
      Returns:
      if subject is any of these roles, allow access

    • clearInheritedRolesAllowed

      public boolean clearInheritedRolesAllowed()
      Whether to clear roles inherited from service defaults.
      Returns:
      whether to clear inherited roles

    • securityLevels

      public List<SecurityLevel> securityLevels()
      Security levels discovered from endpoint annotations.
      Returns:
      security levels

    • authenticator

      public Optional<String> authenticator()
      Use a named authenticator.
      Returns:
      name of authenticator as configured in Security

    • clearInheritedAuthenticator

      public boolean clearInheritedAuthenticator()
      Whether to clear an authenticator inherited from service defaults.
      Returns:
      whether to clear the inherited authenticator

    • authorizer

      public Optional<String> authorizer()
      Use a named authorizer.
      Returns:
      name of authorizer as configured in Security

    • clearInheritedAuthorizer

      public boolean clearInheritedAuthorizer()
      Whether to clear an authorizer inherited from service defaults.
      Returns:
      whether to clear the inherited authorizer

    • authenticate

      public Optional<Boolean> authenticate()
      Whether to authenticate this request.
      Returns:
      whether to authenticate

    • authenticationOptional

      public Optional<Boolean> authenticationOptional()
      Whether authentication failure should continue as anonymous.
      Returns:
      whether authentication is optional

    • audit

      public Optional<Boolean> audit()
      Whether to audit this request.
      Returns:
      whether to audit

    • authorize

      public Optional<Boolean> authorize()
      Whether to authorize this request.
      Returns:
      whether to authorize

    • auditEventType

      public Optional<String> auditEventType()
      Override for audit event type.
      Returns:
      audit event type

    • auditMessageFormat

      public Optional<String> auditMessageFormat()
      Override for audit message format.
      Returns:
      audit message format

    • auditOkSeverity

      public Optional<AuditEvent.AuditSeverity> auditOkSeverity()
      Severity to use for successful requests.
      Returns:
      successful request audit severity

    • auditErrorSeverity

      public Optional<AuditEvent.AuditSeverity> auditErrorSeverity()
      Severity to use for failed requests.
      Returns:
      failed request audit severity

    • customObjects

      public Optional<ClassToInstanceStore<Object>> customObjects()
      A store of custom objects, that can be used to customize specific security providers.
      Returns:
      custom objects

    • config

      public Optional<Config> config()
      Configuration associated with this security handler.
      Returns:
      the configuration

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.