Package io.smallrye.faulttolerance.autoconfig

Interface Config

All Known Subinterfaces:
ConfigDeclarativeOnly
public interface Config

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<? extends Annotation>
    annotationType()
    Returns the type of the annotation that this Config wraps.
    org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
    fail(String reason)
    Returns a new FaultToleranceDefinitionException for this annotation type with given reason.
    org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
    fail(String member, String reason)
    Returns a new FaultToleranceDefinitionException for this annotation type and its member with given reason.
    void
    materialize()
    Ensures this configuration is loaded.
    void
    validate()
    Defines local validation, that is, validation of the single annotation the config interface represents.

  • Method Details

    • validate

      void validate()
      Defines local validation, that is, validation of the single annotation the config interface represents. Global validation (such as cross-checking configuration across multiple annotations) must be done elsewhere.

      Must be implemented (as a default method) in the config interface.

    • annotationType

      Class<? extends Annotation> annotationType()
      Returns the type of the annotation that this Config wraps.

    • materialize

      void materialize()
      Ensures this configuration is loaded. Subsequent method invocations on this instance are guaranteed to not touch MP Config.

    • fail

      org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException fail(String reason)
      Returns a new FaultToleranceDefinitionException for this annotation type with given reason.

    • fail

      org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException fail(String member, String reason)
      Returns a new FaultToleranceDefinitionException for this annotation type and its member with given reason.