Package org.infinispan.rest.framework

Interface Invocation

All Known Implementing Classes:
InvocationImpl
public interface Invocation
Defines an invocation to a REST resource.
Since:
10.0

  • Method Details

    • methods

      Set<Method> methods()
      Returns one or more methods supported.

    • getAction

      String getAction()
      Returns the associated action (request parameter) or null.

    • paths

      Set<String> paths()
      Returns one or more paths associated with the invocation. Paths can be constant, e.g. /a/b/c or use variables such as /a/{var1}/{var2}.

    • getName

      default String getName()
      The user friendly name of the invocation

    • handler

      Function<RestRequest,CompletionStage<RestResponse>> handler()
      Return the function to execute the invocation.

    • anonymous

      boolean anonymous()
      Returns:
      true whether the invocation can be done anonymously (without auth)

    • deprecated

      boolean deprecated()
      Returns:
      true if the invocation is deprecated

    • permission

      AuthorizationPermission permission()
      Returns:
      the required permission for this invocation when authorization is enabled

    • auditContext

      AuditContext auditContext()