Package io.smallrye.graphql.client.typesafe.api

Annotation Interface AuthorizationHeader

@Retention(RUNTIME) @Target({TYPE,METHOD}) public @interface AuthorizationHeader
A specialized Header for Authorization. Either BASIC (default) or BEARER. Credentials are configured with MP Config.

@Header annotations can be defined via @Steretypes.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    AuthorizationHeader.Type
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    confPrefix
    The prefix of the config key to be used, plus /mp-graphql/.
    AuthorizationHeader.Type
    type
    The first word of the Authorization header value, i.e.

  • Element Details

    • confPrefix

      String confPrefix
      The prefix of the config key to be used, plus /mp-graphql/.

      If the prefix ends with *, /mp-graphql/ will not be appended, e.g. @AuthorizationHeader(confPrefix = "org.superheroes.security.basic.* will use org.superheroes.security.basic.username, while * will use plain username.

      Defaults to the fully qualified name of the API interface or its GraphQLClientApi.configKey().

      Default:
      ""

    • type

      AuthorizationHeader.Type type
      The first word of the Authorization header value, i.e. Basic or Bearer. Also determines the config keys to use. See AuthorizationHeader.Type.BASIC/AuthorizationHeader.Type.BEARER for details.
      Default:
      BASIC