Interface GrpcSecurityHandlerConfig

All Superinterfaces:
Prototype.Api, Prototype.Factory<GrpcSecurityHandler>
All Known Implementing Classes:
GrpcSecurityHandlerConfig.BuilderBase.GrpcSecurityHandlerConfigImpl
public interface GrpcSecurityHandlerConfig extends Prototype.Api
Configuration of a GrpcSecurityHandler.
See Also:

  • Method Details

    • builder

      static GrpcSecurityHandlerConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static GrpcSecurityHandlerConfig.Builder builder(GrpcSecurityHandlerConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static GrpcSecurityHandlerConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static GrpcSecurityHandlerConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • rolesAllowed

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

    • clearInheritedRolesAllowed

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

    • securityLevels

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

    • authenticator

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

    • clearInheritedAuthenticator

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

    • authorizer

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

    • clearInheritedAuthorizer

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

    • authenticate

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

    • authenticationOptional

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

    • audit

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

    • authorize

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

    • auditEventType

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

    • auditMessageFormat

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

    • auditOkSeverity

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

    • auditErrorSeverity

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

    • customObjects

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

    • config

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