Class WebPayloadParameterResolver

java.lang.Object
io.fluxzero.sdk.web.WebPayloadParameterResolver
public class WebPayloadParameterResolver extends Object
Resolves a method parameter from the payload of a WebRequest.

This resolver is only applied to methods annotated with HandleWeb or any of its meta-annotations (e.g. HandlePost). It converts the deserialized payload to the method parameter's declared type. For raw request bodies such as multipart/form-data, this resolver can still provide the full body as byte[] or String. Individual multipart fields and files are resolved via FormParam.

Optionally, the resolver can enforce validation and authorization:

  • If validatePayload is true, the resolved payload is validated using assertValid().
  • If authoriseUser is true, the current User must be authorized to execute the payload’s type via assertAuthorized().
See Also:

  • Constructor Details

    • WebPayloadParameterResolver

      public WebPayloadParameterResolver()

  • Method Details

    • resolve

      public Function<HasMessage, Object> resolve(Parameter p, Annotation methodAnnotation)
      Resolves the value for the given method parameter by converting the message payload to the expected parameter type. If configured, it also validates and authorizes the payload.
      Parameters:
      p - the method parameter to resolve
      methodAnnotation - the annotation on the handler method (typically @HandleWeb)
      Returns:
      a function that resolves the parameter from a HasMessage instance

    • test

      public boolean test(HasMessage m, Parameter p)

    • matches

      public boolean matches(Parameter parameter, Annotation methodAnnotation, HasMessage value)
      Determines whether this resolver should be used for the given method parameter. This resolver is active for any method annotated with HandleWeb or any annotation that is meta-annotated with it.
      Parameters:
      parameter - the method parameter
      methodAnnotation - the annotation on the method
      value - the incoming message
      Returns:
      true if the resolver is applicable to this parameter

    • mayApply

      public boolean mayApply(Executable method, Class<?> targetClass)

    • prepare

      default Function<HasMessage, Object> prepare(Parameter arg0, Annotation arg1)

    • determinesSpecificity

      default boolean determinesSpecificity()

    • specificityPriority

      default int specificityPriority()