From a6509227febe4ad849cd2587d1b11fcb4532ec81 Mon Sep 17 00:00:00 2001 From: sdelamo Date: Fri, 10 Jan 2025 09:58:34 +0000 Subject: [PATCH] Deploying to gh-pages - 09:58:34 --- snapshot/api/allclasses-index.html | 19 +- snapshot/api/allpackages-index.html | 1 + snapshot/api/constant-values.html | 12 + snapshot/api/deprecated-list.html | 199 ++++-------- snapshot/api/help-doc.html | 6 + snapshot/api/index-all.html | 44 ++- snapshot/api/index.html | 1 + .../io/micronaut/problem/HttpStatusType.html | 1 + .../ProblemErrorResponseProcessor.html | 40 ++- .../ProblemJsonErrorResponseBodyProvider.html | 292 ++++++++++++++++++ .../problem/ThrowableProblemHandler.html | 1 + .../problem/conf/ProblemConfiguration.html | 1 + .../conf/ProblemConfigurationProperties.html | 1 + .../problem/conf/package-summary.html | 1 + .../micronaut/problem/conf/package-tree.html | 1 + .../io/micronaut/problem/package-summary.html | 11 +- .../io/micronaut/problem/package-tree.html | 2 + .../problem/serde/ProblemSerdeImport.html | 1 + .../problem/serde/package-summary.html | 1 + .../micronaut/problem/serde/package-tree.html | 1 + .../ConstraintViolationThrowableProblem.html | 1 + ...emConstraintViolationExceptionHandler.html | 1 + .../problem/violations/Violation.html | 1 + .../problem/violations/package-summary.html | 1 + .../problem/violations/package-tree.html | 1 + snapshot/api/member-search-index.js | 2 +- snapshot/api/overview-tree.html | 2 + snapshot/api/serialized-form.html | 1 + snapshot/api/type-search-index.js | 2 +- snapshot/guide/index.html | 6 +- 30 files changed, 485 insertions(+), 169 deletions(-) create mode 100644 snapshot/api/io/micronaut/problem/ProblemJsonErrorResponseBodyProvider.html diff --git a/snapshot/api/allclasses-index.html b/snapshot/api/allclasses-index.html index b61aa7d4..ed4301d7 100644 --- a/snapshot/api/allclasses-index.html +++ b/snapshot/api/allclasses-index.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -78,19 +79,23 @@

    All Classes and Interfaces<
    ProblemConstraintViolationExceptionHandler
     
    ProblemErrorResponseProcessor
    -
    -
    Error Response processor to respond Problem responses.
    +
    Deprecated, for removal: This API element is subject to removal in a future version. +
    Use ProblemJsonErrorResponseBodyProvider instead.
    -
    ProblemSerdeImport
    +
    ProblemJsonErrorResponseBodyProvider
    -
    adds problem serdes.
    +
    JsonErrorResponseBodyProvider to respond Problem responses.
    -
    ThrowableProblemHandler
    +
    ProblemSerdeImport
    -
    Handles exception of type ThrowableProblem.
    +
    adds problem serdes.
    -
    Violation
    +
    ThrowableProblemHandler
    +
    Handles exception of type ThrowableProblem.
    +
    +
    Violation
    +
    Constraint Violation information.
    diff --git a/snapshot/api/allpackages-index.html b/snapshot/api/allpackages-index.html index b3ad7200..95bf5246 100644 --- a/snapshot/api/allpackages-index.html +++ b/snapshot/api/allpackages-index.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/constant-values.html b/snapshot/api/constant-values.html index dce472ed..f4b25913 100644 --- a/snapshot/api/constant-values.html +++ b/snapshot/api/constant-values.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -69,6 +70,17 @@

    io.micronaut.*

    "application/problem+json"
    +
  • +
    io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
    +
    Modifier and Type
    +
    Constant Field
    +
    Value
    +
    public static final String
    +
    APPLICATION_PROBLEM_JSON
    +
    "application/problem+json"
    +
    +
    • @@ -67,6 +68,7 @@

    JavaDoc Help

  • Class or Interface
  • Other Files
  • Tree (Class Hierarchy)
    • +
  • Deprecated API
  • Constant Field Values
  • Serialized Form
  • All Packages
    • @@ -156,6 +158,10 @@

    Tree (Class Hierarchy)

  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
    • +
    +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +

    Constant Field Values

    The Constant Field Values page lists the static final fields and their values.

    diff --git a/snapshot/api/index-all.html b/snapshot/api/index-all.html index 27dcc949..102db4ff 100644 --- a/snapshot/api/index-all.html +++ b/snapshot/api/index-all.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -49,10 +50,19 @@

    Index

    -A C D G H I P S T V 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +A B C D G H I P S T V 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

    A

    APPLICATION_PROBLEM_JSON - Static variable in class io.micronaut.problem.ProblemErrorResponseProcessor
    +
    +
    Deprecated.
    + 
    +
    APPLICATION_PROBLEM_JSON - Static variable in class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
     
    +
    +

    B

    +
    +
    body(ErrorContext, HttpResponse<?>) - Method in class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
     

    C

    @@ -65,6 +75,8 @@

    C

     
    ConstraintViolationThrowableProblem(StatusType, List<Violation>) - Constructor for exception io.micronaut.problem.violations.ConstraintViolationThrowableProblem
     
    +
    contentType() - Method in class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
     
    createViolation(ConstraintViolation<?>) - Method in class io.micronaut.problem.violations.ProblemConstraintViolationExceptionHandler
     
    @@ -80,6 +92,11 @@

    D

    defaultProblem(ErrorContext, HttpStatus) - Method in class io.micronaut.problem.ProblemErrorResponseProcessor
    +
    Deprecated.
    +
    Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
    +
    +
    defaultProblem(ErrorContext, HttpStatus) - Method in class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
    Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
    @@ -119,6 +136,12 @@

    I

    includeErrorMessage(ErrorContext) - Method in class io.micronaut.problem.ProblemErrorResponseProcessor
    +
    Deprecated.
    +
    Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should + contain Error::getMessage in the problem detail.
    +
    +
    includeErrorMessage(ErrorContext) - Method in class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
    Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should contain Error::getMessage in the problem detail.
    @@ -165,10 +188,21 @@

    P

    ProblemErrorResponseProcessor - Class in io.micronaut.problem
    -
    Error Response processor to respond Problem responses.
    +
    Deprecated, for removal: This API element is subject to removal in a future version. +
    Use ProblemJsonErrorResponseBodyProvider instead.
    +
    ProblemErrorResponseProcessor(ProblemConfiguration) - Constructor for class io.micronaut.problem.ProblemErrorResponseProcessor
    +
    Deprecated.
    +
    Constructor.
    +
    +
    ProblemJsonErrorResponseBodyProvider - Class in io.micronaut.problem
    +
    +
    JsonErrorResponseBodyProvider to respond Problem responses.
    +
    +
    ProblemJsonErrorResponseBodyProvider(ProblemConfiguration) - Constructor for class io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
    Constructor.
    ProblemSerdeImport - Class in io.micronaut.problem.serde
    @@ -178,7 +212,9 @@

    P

    ProblemSerdeImport() - Constructor for class io.micronaut.problem.serde.ProblemSerdeImport
     
    processResponse(ErrorContext, MutableHttpResponse<?>) - Method in class io.micronaut.problem.ProblemErrorResponseProcessor
    -
     
    +
    +
    Deprecated.
    + 

    S

    @@ -217,7 +253,7 @@

    V

    Violation(String, String) - Constructor for class io.micronaut.problem.violations.Violation
     
    -A C D G H I P S T V 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +A B C D G H I P S T V 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form diff --git a/snapshot/api/index.html b/snapshot/api/index.html index 45c3a27b..b43cd833 100644 --- a/snapshot/api/index.html +++ b/snapshot/api/index.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/HttpStatusType.html b/snapshot/api/io/micronaut/problem/HttpStatusType.html index a66aa4eb..5c616139 100644 --- a/snapshot/api/io/micronaut/problem/HttpStatusType.html +++ b/snapshot/api/io/micronaut/problem/HttpStatusType.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/ProblemErrorResponseProcessor.html b/snapshot/api/io/micronaut/problem/ProblemErrorResponseProcessor.html index 129f8329..7887db2e 100644 --- a/snapshot/api/io/micronaut/problem/ProblemErrorResponseProcessor.html +++ b/snapshot/api/io/micronaut/problem/ProblemErrorResponseProcessor.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -79,10 +80,13 @@

    Class ProblemError
    io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>
    -
    @Singleton +
    @Deprecated(forRemoval=true) public class ProblemErrorResponseProcessor extends Object implements io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>
    +
    Deprecated, for removal: This API element is subject to removal in a future version. +
    Use ProblemJsonErrorResponseBodyProvider instead.
    +
    Error Response processor to respond Problem responses.
    • Adds application/problem+json content type
      • @@ -109,7 +113,9 @@

      Field Summary

      Description
      static final String
      APPLICATION_PROBLEM_JSON
      -
       
      +
      +
      Deprecated, for removal: This API element is subject to removal in a future version.
      + 

    @@ -123,6 +129,7 @@

    Constructor Summary

    Description
    ProblemErrorResponseProcessor(ProblemConfiguration config)
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor.
    @@ -133,28 +140,32 @@

    Constructor Summary

    Method Summary

    -
    +
    Modifier and Type
    Method
    Description
    -
    protected @NonNull org.zalando.problem.ThrowableProblem
    -
    defaultProblem(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, +
    protected @NonNull org.zalando.problem.ThrowableProblem
    +
    defaultProblem(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, @NonNull io.micronaut.http.HttpStatus httpStatus)
    -
    +
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
    -
    protected boolean
    -
    includeErrorMessage(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext)
    -
    +
    protected boolean
    +
    includeErrorMessage(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext)
    +
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should contain Error::getMessage in the problem detail.
    -
    @NonNull io.micronaut.http.MutableHttpResponse<org.zalando.problem.Problem>
    -
    processResponse(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, +
    @NonNull io.micronaut.http.MutableHttpResponse<org.zalando.problem.Problem>
    +
    processResponse(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, @NonNull io.micronaut.http.MutableHttpResponse<?> baseResponse)
    -
     
    +
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    + 
    @@ -176,6 +187,7 @@

    Field Details

    APPLICATION_PROBLEM_JSON

    public static final String APPLICATION_PROBLEM_JSON
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    See Also:
    @@ -198,6 +210,7 @@

    Constructor Details

    ProblemErrorResponseProcessor

    public ProblemErrorResponseProcessor(ProblemConfiguration config)
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor.
    Parameters:
    @@ -221,6 +234,7 @@

    processResponse

    @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, @NonNull @NonNull io.micronaut.http.MutableHttpResponse<?> baseResponse)
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Specified by:
    processResponse in interface io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<org.zalando.problem.Problem>
    @@ -235,6 +249,7 @@

    defaultProblem

    @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, @NonNull @NonNull io.micronaut.http.HttpStatus httpStatus)
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
    Parameters:
    @@ -250,6 +265,7 @@

    defaultProblem

    includeErrorMessage

    protected boolean includeErrorMessage(@NonNull @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext)
    +
    Deprecated, for removal: This API element is subject to removal in a future version.
    Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should contain Error::getMessage in the problem detail. diff --git a/snapshot/api/io/micronaut/problem/ProblemJsonErrorResponseBodyProvider.html b/snapshot/api/io/micronaut/problem/ProblemJsonErrorResponseBodyProvider.html new file mode 100644 index 00000000..815f5e26 --- /dev/null +++ b/snapshot/api/io/micronaut/problem/ProblemJsonErrorResponseBodyProvider.html @@ -0,0 +1,292 @@ + + + + +ProblemJsonErrorResponseBodyProvider (problem-json-parent 3.7.0-SNAPSHOT API) + + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package io.micronaut.problem
    +

    Class ProblemJsonErrorResponseBodyProvider

    +
    +
    java.lang.Object +
    io.micronaut.problem.ProblemJsonErrorResponseBodyProvider
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider<org.zalando.problem.Problem>, io.micronaut.http.server.exceptions.response.JsonErrorResponseBodyProvider<org.zalando.problem.Problem>
    +
    +
    +
    @Singleton +public class ProblemJsonErrorResponseBodyProvider +extends Object +implements io.micronaut.http.server.exceptions.response.JsonErrorResponseBodyProvider<org.zalando.problem.Problem>
    +
    JsonErrorResponseBodyProvider to respond Problem responses. +
      +
    • Adds application/problem+json content type
      • +
    • If the cause is a ThrowableProblem, it returns as the body.
      • +
    • If the cause is not a ThrowableProblem , it generates a default Problem based on the ErrorContext and returns it as the HTTP Body.
      • +
    +
    +
    Since:
    +
    1.0
    +
    Author:
    +
    Sergio del Amo
    +
    +
    +
    +
      + +
    • +
      +

      Field Summary

      +
      Fields
      +
      +
      Modifier and Type
      +
      Field
      +
      Description
      +
      static final String
      +
      APPLICATION_PROBLEM_JSON
      +
       
      +
      +
      +
      • + +
    • +
      +

      Constructor Summary

      +
      Constructors
      +
      +
      Constructor
      +
      Description
      +
      ProblemJsonErrorResponseBodyProvider(ProblemConfiguration config)
      +
      +
      Constructor.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      @NonNull org.zalando.problem.Problem
      +
      body(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, + @NonNull io.micronaut.http.HttpResponse<?> response)
      +
       
      +
      String
      +
      contentType()
      +
       
      +
      protected @NonNull org.zalando.problem.ThrowableProblem
      +
      defaultProblem(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, + @NonNull io.micronaut.http.HttpStatus httpStatus)
      +
      +
      Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
      +
      +
      protected boolean
      +
      includeErrorMessage(@NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext)
      +
      +
      Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should + contain Error::getMessage in the problem detail.
      +
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        APPLICATION_PROBLEM_JSON

        +
        public static final String APPLICATION_PROBLEM_JSON
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProblemJsonErrorResponseBodyProvider

        +
        public ProblemJsonErrorResponseBodyProvider(ProblemConfiguration config)
        +
        Constructor.
        +
        +
        Parameters:
        +
        config - Problem configuration
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        contentType

        +
        public String contentType()
        +
        +
        Specified by:
        +
        contentType in interface io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider<org.zalando.problem.Problem>
        +
        Specified by:
        +
        contentType in interface io.micronaut.http.server.exceptions.response.JsonErrorResponseBodyProvider<org.zalando.problem.Problem>
        +
        +
        +
        • +
      • +
        +

        body

        +
        @NonNull +public @NonNull org.zalando.problem.Problem body(@NonNull + @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, + @NonNull + @NonNull io.micronaut.http.HttpResponse<?> response)
        +
        +
        Specified by:
        +
        body in interface io.micronaut.http.server.exceptions.response.ErrorResponseBodyProvider<org.zalando.problem.Problem>
        +
        +
        +
        • +
      • +
        +

        defaultProblem

        +
        @NonNull +protected @NonNull org.zalando.problem.ThrowableProblem defaultProblem(@NonNull + @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext, + @NonNull + @NonNull io.micronaut.http.HttpStatus httpStatus)
        +
        Creates a ThrowableProblem when the root cause was not an exception of type ThrowableProblem.
        +
        +
        Parameters:
        +
        errorContext - Error Context
        +
        httpStatus - HTTP Status
        +
        Returns:
        +
        Default problem
        +
        +
        +
        • +
      • +
        +

        includeErrorMessage

        +
        protected boolean includeErrorMessage(@NonNull + @NonNull io.micronaut.http.server.exceptions.response.ErrorContext errorContext)
        +
        Whether ThrowableProblem, created when the root cause is not an exception of type ThrowableProblem, should + contain Error::getMessage in the problem detail. + + To avoid accidental information leakage defaults to false unless the root cause is of type UnsatisfiedRouteException + which contains helpful information to diagnose the issue (e.g. missing required query value) in the details.
        +
        +
        Parameters:
        +
        errorContext - Error Context
        +
        Returns:
        +
        To avoid accidental information leakage defaults to false unless the root cause is of type UnsatisfiedRouteException
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    +
    +
    + + diff --git a/snapshot/api/io/micronaut/problem/ThrowableProblemHandler.html b/snapshot/api/io/micronaut/problem/ThrowableProblemHandler.html index d07f8626..f30e75d8 100644 --- a/snapshot/api/io/micronaut/problem/ThrowableProblemHandler.html +++ b/snapshot/api/io/micronaut/problem/ThrowableProblemHandler.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/conf/ProblemConfiguration.html b/snapshot/api/io/micronaut/problem/conf/ProblemConfiguration.html index 35b11a08..e89f5567 100644 --- a/snapshot/api/io/micronaut/problem/conf/ProblemConfiguration.html +++ b/snapshot/api/io/micronaut/problem/conf/ProblemConfiguration.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/conf/ProblemConfigurationProperties.html b/snapshot/api/io/micronaut/problem/conf/ProblemConfigurationProperties.html index bcb7ef9f..4b3c171e 100644 --- a/snapshot/api/io/micronaut/problem/conf/ProblemConfigurationProperties.html +++ b/snapshot/api/io/micronaut/problem/conf/ProblemConfigurationProperties.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/conf/package-summary.html b/snapshot/api/io/micronaut/problem/conf/package-summary.html index 795b4e56..99fffca1 100644 --- a/snapshot/api/io/micronaut/problem/conf/package-summary.html +++ b/snapshot/api/io/micronaut/problem/conf/package-summary.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/conf/package-tree.html b/snapshot/api/io/micronaut/problem/conf/package-tree.html index c50e176f..a51521f4 100644 --- a/snapshot/api/io/micronaut/problem/conf/package-tree.html +++ b/snapshot/api/io/micronaut/problem/conf/package-tree.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/package-summary.html b/snapshot/api/io/micronaut/problem/package-summary.html index ebd19c4f..fd43f59b 100644 --- a/snapshot/api/io/micronaut/problem/package-summary.html +++ b/snapshot/api/io/micronaut/problem/package-summary.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -110,11 +111,15 @@

    Package io.micronaut.prob
    Implementation of StatusType which uses Micronaut HttpStatus and renders as JSON the HTTP status code.

    ProblemErrorResponseProcessor
    -
    -
    Error Response processor to respond Problem responses.
    +
    Deprecated, for removal: This API element is subject to removal in a future version. +
    Use ProblemJsonErrorResponseBodyProvider instead.
    -
    ThrowableProblemHandler
    +
    ProblemJsonErrorResponseBodyProvider
    +
    JsonErrorResponseBodyProvider to respond Problem responses.
    +
    +
    ThrowableProblemHandler
    +
    Handles exception of type ThrowableProblem.
    diff --git a/snapshot/api/io/micronaut/problem/package-tree.html b/snapshot/api/io/micronaut/problem/package-tree.html index 6b0047a7..f9481710 100644 --- a/snapshot/api/io/micronaut/problem/package-tree.html +++ b/snapshot/api/io/micronaut/problem/package-tree.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -60,6 +61,7 @@

    Class Hierarchy

    diff --git a/snapshot/api/io/micronaut/problem/serde/ProblemSerdeImport.html b/snapshot/api/io/micronaut/problem/serde/ProblemSerdeImport.html index 77aed688..0e741a5d 100644 --- a/snapshot/api/io/micronaut/problem/serde/ProblemSerdeImport.html +++ b/snapshot/api/io/micronaut/problem/serde/ProblemSerdeImport.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/serde/package-summary.html b/snapshot/api/io/micronaut/problem/serde/package-summary.html index 6f910830..d1dc0973 100644 --- a/snapshot/api/io/micronaut/problem/serde/package-summary.html +++ b/snapshot/api/io/micronaut/problem/serde/package-summary.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/serde/package-tree.html b/snapshot/api/io/micronaut/problem/serde/package-tree.html index 29a35e5f..b4b22302 100644 --- a/snapshot/api/io/micronaut/problem/serde/package-tree.html +++ b/snapshot/api/io/micronaut/problem/serde/package-tree.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/violations/ConstraintViolationThrowableProblem.html b/snapshot/api/io/micronaut/problem/violations/ConstraintViolationThrowableProblem.html index 666696dd..55bf37d8 100644 --- a/snapshot/api/io/micronaut/problem/violations/ConstraintViolationThrowableProblem.html +++ b/snapshot/api/io/micronaut/problem/violations/ConstraintViolationThrowableProblem.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/violations/ProblemConstraintViolationExceptionHandler.html b/snapshot/api/io/micronaut/problem/violations/ProblemConstraintViolationExceptionHandler.html index 3e61bf1e..109fe86d 100644 --- a/snapshot/api/io/micronaut/problem/violations/ProblemConstraintViolationExceptionHandler.html +++ b/snapshot/api/io/micronaut/problem/violations/ProblemConstraintViolationExceptionHandler.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/violations/Violation.html b/snapshot/api/io/micronaut/problem/violations/Violation.html index 6ea186c0..d8033bf6 100644 --- a/snapshot/api/io/micronaut/problem/violations/Violation.html +++ b/snapshot/api/io/micronaut/problem/violations/Violation.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/violations/package-summary.html b/snapshot/api/io/micronaut/problem/violations/package-summary.html index 26390834..252ffc36 100644 --- a/snapshot/api/io/micronaut/problem/violations/package-summary.html +++ b/snapshot/api/io/micronaut/problem/violations/package-summary.html @@ -35,6 +35,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/io/micronaut/problem/violations/package-tree.html b/snapshot/api/io/micronaut/problem/violations/package-tree.html index 44167815..d5bc5040 100644 --- a/snapshot/api/io/micronaut/problem/violations/package-tree.html +++ b/snapshot/api/io/micronaut/problem/violations/package-tree.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • diff --git a/snapshot/api/member-search-index.js b/snapshot/api/member-search-index.js index 88ad5350..9eac82ae 100644 --- a/snapshot/api/member-search-index.js +++ b/snapshot/api/member-search-index.js @@ -1 +1 @@ -memberSearchIndex = [{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"APPLICATION_PROBLEM_JSON"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"ConstraintViolationThrowableProblem(StatusType, List)","u":"%3Cinit%3E(org.zalando.problem.StatusType,java.util.List)"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"ConstraintViolationThrowableProblem(URI, StatusType, List)","u":"%3Cinit%3E(java.net.URI,org.zalando.problem.StatusType,java.util.List)"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"createViolation(ConstraintViolation)","u":"createViolation(jakarta.validation.ConstraintViolation)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"DEFAULT_ENABLED"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"DEFAULT_STACK_TRACKE"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"defaultProblem(ErrorContext, HttpStatus)","u":"defaultProblem(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.HttpStatus)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"getField()"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"getMessage()"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"getReasonPhrase()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getStatus()"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"getStatusCode()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getTitle()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getType()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getViolations()"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"handle(HttpRequest, ConstraintViolationException)","u":"handle(io.micronaut.http.HttpRequest,jakarta.validation.ConstraintViolationException)"},{"p":"io.micronaut.problem","c":"ThrowableProblemHandler","l":"handle(HttpRequest, ThrowableProblem)","u":"handle(io.micronaut.http.HttpRequest,org.zalando.problem.ThrowableProblem)"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"HttpStatusType(HttpStatus)","u":"%3Cinit%3E(io.micronaut.http.HttpStatus)"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"includeErrorMessage(ErrorContext)","u":"includeErrorMessage(io.micronaut.http.server.exceptions.response.ErrorContext)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"isEnabled()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfiguration","l":"isStackTrace()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"isStackTrace()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"PREFIX"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"ProblemConfigurationProperties()","u":"%3Cinit%3E()"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"ProblemConstraintViolationExceptionHandler(ErrorResponseProcessor)","u":"%3Cinit%3E(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor)"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"ProblemErrorResponseProcessor(ProblemConfiguration)","u":"%3Cinit%3E(io.micronaut.problem.conf.ProblemConfiguration)"},{"p":"io.micronaut.problem.serde","c":"ProblemSerdeImport","l":"ProblemSerdeImport()","u":"%3Cinit%3E()"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"processResponse(ErrorContext, MutableHttpResponse)","u":"processResponse(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.MutableHttpResponse)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"setEnabled(boolean)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"setField(String)","u":"setField(java.lang.String)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"setMessage(String)","u":"setMessage(java.lang.String)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"setStackTrace(boolean)"},{"p":"io.micronaut.problem","c":"ThrowableProblemHandler","l":"ThrowableProblemHandler(ErrorResponseProcessor)","u":"%3Cinit%3E(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor)"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"TYPE"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"TYPE_VALUE"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"Violation(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"}];updateSearchResults(); \ No newline at end of file +memberSearchIndex = [{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"APPLICATION_PROBLEM_JSON"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"APPLICATION_PROBLEM_JSON"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"body(ErrorContext, HttpResponse)","u":"body(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.HttpResponse)"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"ConstraintViolationThrowableProblem(StatusType, List)","u":"%3Cinit%3E(org.zalando.problem.StatusType,java.util.List)"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"ConstraintViolationThrowableProblem(URI, StatusType, List)","u":"%3Cinit%3E(java.net.URI,org.zalando.problem.StatusType,java.util.List)"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"contentType()"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"createViolation(ConstraintViolation)","u":"createViolation(jakarta.validation.ConstraintViolation)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"DEFAULT_ENABLED"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"DEFAULT_STACK_TRACKE"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"defaultProblem(ErrorContext, HttpStatus)","u":"defaultProblem(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.HttpStatus)"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"defaultProblem(ErrorContext, HttpStatus)","u":"defaultProblem(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.HttpStatus)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"getField()"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"getMessage()"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"getReasonPhrase()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getStatus()"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"getStatusCode()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getTitle()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getType()"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"getViolations()"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"handle(HttpRequest, ConstraintViolationException)","u":"handle(io.micronaut.http.HttpRequest,jakarta.validation.ConstraintViolationException)"},{"p":"io.micronaut.problem","c":"ThrowableProblemHandler","l":"handle(HttpRequest, ThrowableProblem)","u":"handle(io.micronaut.http.HttpRequest,org.zalando.problem.ThrowableProblem)"},{"p":"io.micronaut.problem","c":"HttpStatusType","l":"HttpStatusType(HttpStatus)","u":"%3Cinit%3E(io.micronaut.http.HttpStatus)"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"includeErrorMessage(ErrorContext)","u":"includeErrorMessage(io.micronaut.http.server.exceptions.response.ErrorContext)"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"includeErrorMessage(ErrorContext)","u":"includeErrorMessage(io.micronaut.http.server.exceptions.response.ErrorContext)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"isEnabled()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfiguration","l":"isStackTrace()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"isStackTrace()"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"PREFIX"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"ProblemConfigurationProperties()","u":"%3Cinit%3E()"},{"p":"io.micronaut.problem.violations","c":"ProblemConstraintViolationExceptionHandler","l":"ProblemConstraintViolationExceptionHandler(ErrorResponseProcessor)","u":"%3Cinit%3E(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor)"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"ProblemErrorResponseProcessor(ProblemConfiguration)","u":"%3Cinit%3E(io.micronaut.problem.conf.ProblemConfiguration)"},{"p":"io.micronaut.problem","c":"ProblemJsonErrorResponseBodyProvider","l":"ProblemJsonErrorResponseBodyProvider(ProblemConfiguration)","u":"%3Cinit%3E(io.micronaut.problem.conf.ProblemConfiguration)"},{"p":"io.micronaut.problem.serde","c":"ProblemSerdeImport","l":"ProblemSerdeImport()","u":"%3Cinit%3E()"},{"p":"io.micronaut.problem","c":"ProblemErrorResponseProcessor","l":"processResponse(ErrorContext, MutableHttpResponse)","u":"processResponse(io.micronaut.http.server.exceptions.response.ErrorContext,io.micronaut.http.MutableHttpResponse)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"setEnabled(boolean)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"setField(String)","u":"setField(java.lang.String)"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"setMessage(String)","u":"setMessage(java.lang.String)"},{"p":"io.micronaut.problem.conf","c":"ProblemConfigurationProperties","l":"setStackTrace(boolean)"},{"p":"io.micronaut.problem","c":"ThrowableProblemHandler","l":"ThrowableProblemHandler(ErrorResponseProcessor)","u":"%3Cinit%3E(io.micronaut.http.server.exceptions.response.ErrorResponseProcessor)"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"TYPE"},{"p":"io.micronaut.problem.violations","c":"ConstraintViolationThrowableProblem","l":"TYPE_VALUE"},{"p":"io.micronaut.problem.violations","c":"Violation","l":"Violation(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"}];updateSearchResults(); \ No newline at end of file diff --git a/snapshot/api/overview-tree.html b/snapshot/api/overview-tree.html index f33a699a..7f9f83ef 100644 --- a/snapshot/api/overview-tree.html +++ b/snapshot/api/overview-tree.html @@ -31,6 +31,7 @@
  • Package
  • Class
  • Tree
    • +
  • Deprecated
  • Index
  • Help
    • @@ -65,6 +66,7 @@

    Class Hierarchy

  • io.micronaut.problem.conf.ProblemConfigurationProperties (implements io.micronaut.problem.conf.ProblemConfiguration)
  • io.micronaut.problem.violations.ProblemConstraintViolationExceptionHandler (implements io.micronaut.http.server.exceptions.ExceptionHandler<T,R>)
  • io.micronaut.problem.ProblemErrorResponseProcessor (implements io.micronaut.http.server.exceptions.response.ErrorResponseProcessor<T>)
    • +
  • io.micronaut.problem.ProblemJsonErrorResponseBodyProvider (implements io.micronaut.http.server.exceptions.response.JsonErrorResponseBodyProvider<T>)
  • io.micronaut.problem.serde.ProblemSerdeImport
  • java.lang.Throwable (implements java.io.Serializable)
      diff --git a/snapshot/api/serialized-form.html b/snapshot/api/serialized-form.html index be965d0d..4e8408e0 100644 --- a/snapshot/api/serialized-form.html +++ b/snapshot/api/serialized-form.html @@ -31,6 +31,7 @@
    • Package
    • Class
    • Tree
      • +
    • Deprecated
    • Index
    • Help
    diff --git a/snapshot/api/type-search-index.js b/snapshot/api/type-search-index.js index cb2b661e..f6865f77 100644 --- a/snapshot/api/type-search-index.js +++ b/snapshot/api/type-search-index.js @@ -1 +1 @@ -typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.micronaut.problem.violations","l":"ConstraintViolationThrowableProblem"},{"p":"io.micronaut.problem","l":"HttpStatusType"},{"p":"io.micronaut.problem.conf","l":"ProblemConfiguration"},{"p":"io.micronaut.problem.conf","l":"ProblemConfigurationProperties"},{"p":"io.micronaut.problem.violations","l":"ProblemConstraintViolationExceptionHandler"},{"p":"io.micronaut.problem","l":"ProblemErrorResponseProcessor"},{"p":"io.micronaut.problem.serde","l":"ProblemSerdeImport"},{"p":"io.micronaut.problem","l":"ThrowableProblemHandler"},{"p":"io.micronaut.problem.violations","l":"Violation"}];updateSearchResults(); \ No newline at end of file +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"io.micronaut.problem.violations","l":"ConstraintViolationThrowableProblem"},{"p":"io.micronaut.problem","l":"HttpStatusType"},{"p":"io.micronaut.problem.conf","l":"ProblemConfiguration"},{"p":"io.micronaut.problem.conf","l":"ProblemConfigurationProperties"},{"p":"io.micronaut.problem.violations","l":"ProblemConstraintViolationExceptionHandler"},{"p":"io.micronaut.problem","l":"ProblemErrorResponseProcessor"},{"p":"io.micronaut.problem","l":"ProblemJsonErrorResponseBodyProvider"},{"p":"io.micronaut.problem.serde","l":"ProblemSerdeImport"},{"p":"io.micronaut.problem","l":"ThrowableProblemHandler"},{"p":"io.micronaut.problem.violations","l":"Violation"}];updateSearchResults(); \ No newline at end of file diff --git a/snapshot/guide/index.html b/snapshot/guide/index.html index 691a3f10..76c4825f 100644 --- a/snapshot/guide/index.html +++ b/snapshot/guide/index.html @@ -535,14 +535,14 @@

    -

    You can extend ProblemErrorResponseProcessor to customize the behaviour:

    +

    You can extend ProblemJsonErrorResponseBodyProvider to customize the behaviour:

    • -
    @Replaces(ProblemErrorResponseProcessor.class)
+
    @Replaces(ProblemJsonErrorResponseBodyProvider.class)
 @Singleton
 public class ProblemErrorResponseProcessorReplacement
-        extends ProblemErrorResponseProcessor {
+        extends ProblemJsonErrorResponseBodyProvider {
     ProblemErrorResponseProcessorReplacement(ProblemConfiguration config) {
         super(config);
     }