Package org.infinispan.rest.framework
Interface Invocation
-
- All Known Implementing Classes:
InvocationImpl
public interface InvocationDefines an invocation to a REST resource.- Since:
- 10.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description booleananonymous()org.infinispan.security.AuditContextauditContext()booleandeprecated()StringgetAction()Returns the associated action (request parameter) or null.default StringgetName()The user friendly name of the invocationFunction<RestRequest,CompletionStage<RestResponse>>handler()Return the function to execute the invocation.Set<Method>methods()Returns one or more methods supported.Set<String>paths()Returns one or more paths associated with the invocation.org.infinispan.security.AuthorizationPermissionpermission()
-
-
-
Method Detail
-
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
org.infinispan.security.AuthorizationPermission permission()
- Returns:
- the required permission for this invocation when authorization is enabled
-
auditContext
org.infinispan.security.AuditContext auditContext()
-
-