Package org.kohsuke.stapler.verb

Class HttpVerbInterceptor

java.lang.Object

org.kohsuke.stapler.interceptor.Interceptor

org.kohsuke.stapler.verb.HttpVerbInterceptor

public class HttpVerbInterceptor
extends Interceptor

Restricts the routing to matching HTTP verbs.

Usage

This package defines a number of HTTP verb (method) annotations that can be used to restrict routing. For example,

 @WebMethod(name="") @DELETE
 public void delete() {
     // this method will be invoked only when the request is DELETE
     ...
 }

 @WebMethod(name="") @POST
 public void create(@JsonBody Order order) {
     // this method will be invoked only when the request is POST
     ...
 }
 

This class is the actual logic that implements this semantics on top of Interceptor.

Author:

Kohsuke Kawaguchi

See Also:

• GET
• POST
• PUT
• DELETE

Field Summary

Fields inherited from class org.kohsuke.stapler.interceptor.Interceptor

target

Constructor Summary

Constructors

Constructor	Description
HttpVerbInterceptor()

Method Summary

Modifier and Type	Method	Description
Object	invoke(StaplerRequest2 request, StaplerResponse2 response, Object instance, Object[] arguments)	Intercepts the call.

Methods inherited from class org.kohsuke.stapler.interceptor.Interceptor

invoke, setTarget

Methods inherited from class java.lang.Object

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

Constructor Details

HttpVerbInterceptor

public HttpVerbInterceptor()

Method Details

invoke

public Object invoke(StaplerRequest2 request,
 StaplerResponse2 response,
 Object instance,
 Object[] arguments)
              throws IllegalAccessException,
InvocationTargetException,
jakarta.servlet.ServletException

Description copied from class: Interceptor

Intercepts the call.

The minimal no-op interceptor would do target.invoke(request,response,instance,arguments), but the implementation is free to do additional pre/post processing.

Overrides:

invoke in class Interceptor

Parameters:

request - The current request we are processing.

response - The current response object.

instance - The domain object instance whose method we are about to invoke.

arguments - Arguments of the method call.

Returns:

Return value from the method.

Throws:

InvocationTargetException - if you want to send e.g. something from HttpResponses

IllegalAccessException

jakarta.servlet.ServletException