Interface JavaMicronautClientOptionsBuilder

All Superinterfaces:
GeneratorOptionsBuilder
public interface JavaMicronautClientOptionsBuilder extends GeneratorOptionsBuilder
The client generator options builder.

  • Method Details

    • withAuthorization

      JavaMicronautClientOptionsBuilder withAuthorization(boolean useAuth)
      If set to true the client will be configured for authorization.
      Parameters:
      useAuth - the authorization flag
      Returns:
      this builder

    • withGenerateAuthClasses

      JavaMicronautClientOptionsBuilder withGenerateAuthClasses(boolean generateAuthorizationClasses)
      Generate authorization classes or not.
      Parameters:
      generateAuthorizationClasses - Generate authorization classes or not.
      Returns:
      this builder

    • withAuthFilter

      JavaMicronautClientOptionsBuilder withAuthFilter(boolean authFilter)
      Generate AuthorizationFilter or not.
      Parameters:
      authFilter - Generate AuthorizationFilter or not.
      Returns:
      this builder

    • withUseOauth

      JavaMicronautClientOptionsBuilder withUseOauth(boolean useOauth)
      Generate AuthorizationFilter with support OAuth2.0 or not.
      Parameters:
      useOauth - if true, then AuthorizationFilter will be created with support OAuth2.0
      Returns:
      this builder

    • withUseBasicAuth

      JavaMicronautClientOptionsBuilder withUseBasicAuth(boolean useBasicAuth)
      Generate HttpBasicAuthConfig class or not.
      Parameters:
      useBasicAuth - if true, then HttpBasicAuthConfig class will be generated
      Returns:
      this builder

    • withUseApiKeyAuth

      JavaMicronautClientOptionsBuilder withUseApiKeyAuth(boolean useApiKeyAuth)
      Generate ApiKeyAuthConfig config or not.
      Parameters:
      useApiKeyAuth - if true, then ApiKeyAuthConfig class will be generated
      Returns:
      this builder

    • withAuthorizationFilterPattern

      JavaMicronautClientOptionsBuilder withAuthorizationFilterPattern(String authorizationFilterPattern)
      Sets the authorization filter pattern. Can be a list of strings, or single string with `;` separator
      Parameters:
      authorizationFilterPattern - the filter pattern
      Returns:
      this builder

    • withAuthorizationFilterPatternStyle

      JavaMicronautClientOptionsBuilder withAuthorizationFilterPatternStyle(String authorizationFilterPatternStyle)
      Sets the authorization filter pattern style. Available values: ANT, REGEX.

      Default: ANT

      Parameters:
      authorizationFilterPatternStyle - the filter pattern style. Default: ANT
      Returns:
      this builder

    • withAuthFilterClientIds

      JavaMicronautClientOptionsBuilder withAuthFilterClientIds(List<String> authFilterClientIds)
      Sets serviceId annotation property for AuthorizationFilter. Usefully, when use one filter for several clients. Can be a list of strings, or single string with `;` separator.

      By default, if you don't set any authFilterClientIds, value will be a list with one element - `clientId` property value. If you don't want to add any serviceId annotation property for AuthorizationFilter, just set empty list (not null!).

      Parameters:
      authFilterClientIds - the list of client IDs, for which this filter will be used
      Returns:
      this builder

    • withAuthFilterExcludedClientIds

      JavaMicronautClientOptionsBuilder withAuthFilterExcludedClientIds(List<String> authFilterExcludedClientIds)
      The list of client IDs, for which this filter will NOT be used. Can be a list of strings, or single string with `;` separator (if you set this property, by additionalProperties)
      Parameters:
      authFilterExcludedClientIds - the list of client IDs, for which this filter will NOT be used
      Returns:
      this builder

    • withAuthConfigName

      JavaMicronautClientOptionsBuilder withAuthConfigName(String authConfigName)
      Authorization config name. Using in config properties for HttpBasicAuthConfig and ApiKeyAuthConfig. If not set, clientId value will be used.
      Parameters:
      authConfigName - the client id
      Returns:
      this builder

    • withClientId

      JavaMicronautClientOptionsBuilder withClientId(String clientId)
      Sets the client id.
      Parameters:
      clientId - the client id
      Returns:
      this builder

    • withAdditionalClientTypeAnnotations

      JavaMicronautClientOptionsBuilder withAdditionalClientTypeAnnotations(List<String> additionalClientTypeAnnotations)
      Sets annotations for client type (class level annotations). Can be a list of strings, or single string with `;` separator
      Parameters:
      additionalClientTypeAnnotations - the type annotations
      Returns:
      this builder

    • withBasePathSeparator

      JavaMicronautClientOptionsBuilder withBasePathSeparator(String basePathSeparator)
      Sets the separator to use between the application name and base path when referencing the property.
      Parameters:
      basePathSeparator - the base path separator
      Returns:
      this builder

    • withPlural

      JavaMicronautClientOptionsBuilder withPlural(boolean plural)
      If set to true, the generated code will pluralize parameters and properties for arrays.
      Parameters:
      plural - generate pluralized parameters and properties for arrays
      Returns:
      this builder

    • withFluxForArrays

      JavaMicronautClientOptionsBuilder withFluxForArrays(boolean fluxForArrays)
      If set to true, generated code will be with Flux<?> instead Mono<List<?>>.
      Parameters:
      fluxForArrays - generate code with Flux<?> instead Mono<List<?>> or not
      Returns:
      this builder

    • withGeneratedAnnotation

      JavaMicronautClientOptionsBuilder withGeneratedAnnotation(boolean generatedAnnotation)
      If set to true, generated code will be with jakarta.annotation.Generated annotation.
      Parameters:
      generatedAnnotation - generate code with jakarta.annotation.Generated annotation or not
      Returns:
      this builder

    • withClientPath

      JavaMicronautClientOptionsBuilder withClientPath(boolean clientPath)
      If set to true, Api annotation @Client will be with `path` attribute.
      Parameters:
      clientPath - do we need add path attribute to @Client annotation
      Returns:
      this builder

    • withNoArgsConstructor

      JavaMicronautClientOptionsBuilder withNoArgsConstructor(boolean noArgsConstructor)
      Generate or not public no-args constructor always.
      Parameters:
      noArgsConstructor - generate or not public no-args constructor always
      Returns:
      this builder

    • withLombok

      JavaMicronautClientOptionsBuilder withLombok(boolean lombok)
      If set to true, generated code will be with lombok annotations.
      Parameters:
      lombok - generate code with lombok annotations or not
      Returns:
      this builder

    • withRetryable

      JavaMicronautClientOptionsBuilder withRetryable(boolean retryable)
      Add or not @Retryable annotation to client interface. Default: false
      Parameters:
      retryable - if true, then @Retryable annotation will be added to client interface
      Returns:
      this builder

    • withRetryableIncludes

      JavaMicronautClientOptionsBuilder withRetryableIncludes(List<String> retryableIncludes)
      Set includes parameter for Retryable annotation.
      Parameters:
      retryableIncludes - includes value for Retryable annotation
      Returns:
      this builder

    • withRetryableExcludes

      JavaMicronautClientOptionsBuilder withRetryableExcludes(List<String> retryableExcludes)
      Set excludes parameter for Retryable annotation.
      Parameters:
      retryableExcludes - excludes value for Retryable annotation
      Returns:
      this builder

    • withRetryableAttempts

      JavaMicronautClientOptionsBuilder withRetryableAttempts(int retryableAttempts)
      Set attempts parameter for Retryable annotation.
      Parameters:
      retryableAttempts - attempts value for Retryable annotation
      Returns:
      this builder

    • withRetryableDelay

      JavaMicronautClientOptionsBuilder withRetryableDelay(String retryableDelay)
      Set delay parameter for Retryable annotation.
      Parameters:
      retryableDelay - delay value for Retryable annotation
      Returns:
      this builder

    • withRetryableMaxDelay

      JavaMicronautClientOptionsBuilder withRetryableMaxDelay(String retryableMaxDelay)
      Set maxDelay parameter for Retryable annotation.
      Parameters:
      retryableMaxDelay - maxDelay value for Retryable annotation
      Returns:
      this builder

    • withRetryableMultiplier

      JavaMicronautClientOptionsBuilder withRetryableMultiplier(String retryableMultiplier)
      Set multiplier parameter for Retryable annotation.
      Parameters:
      retryableMultiplier - multiplier value for Retryable annotation
      Returns:
      this builder

    • withRetryableJitter

      JavaMicronautClientOptionsBuilder withRetryableJitter(String retryableJitter)
      Set jitter parameter for Retryable annotation.
      Parameters:
      retryableJitter - jitter value for Retryable annotation
      Returns:
      this builder

    • withRetryablePredicate

      JavaMicronautClientOptionsBuilder withRetryablePredicate(String retryablePredicate)
      Set predicate parameter for Retryable annotation.
      Parameters:
      retryablePredicate - predicate value for Retryable annotation
      Returns:
      this builder

    • withRetryableCapturedException

      JavaMicronautClientOptionsBuilder withRetryableCapturedException(String retryableCapturedException)
      Set capturedException parameter for Retryable annotation.
      Parameters:
      retryableCapturedException - capturedException value for Retryable annotation
      Returns:
      this builder