org.apache.juneau.rest.annotation

Annotation Type RestHook

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface RestHook

Identifies Java methods on a resource/servlet class that get invoked during particular lifecycle events of the servlet or REST call.

For example, if you want to add an initialization method to your resource:

@Rest(...) public class MyResource { // Our database. private Map<Integer,Object> myDatabase; @RestHook(INIT) public void initMyDatabase(RestContextBuilder builder) throws Exception { myDatabase = new LinkedHashMap<>(); } }

Or if you want to intercept REST calls:

@Rest(...) public class MyResource { // Add a request attribute to all incoming requests. @RestHook(PRE_CALL) public void onPreCall(RestRequest req) { req.setAttribute("foo", "bar"); } }

The hook events can be broken down into two categories:

• Resource lifecycle events:
  • INIT - Right before initialization.
  • POST_INIT - Right after initialization.
  • POST_INIT_CHILD_FIRST - Right after initialization, but run child methods first.
  • DESTROY - Right before servlet destroy.
• REST call lifecycle events:
  • START_CALL - At the beginning of a REST call.
  • PRE_CALL - Right before the @RestMethod method is invoked.
  • POST_CALL - Right after the @RestMethod method is invoked.
  • END_CALL - At the end of the REST call after the response has been flushed.

• Overview > juneau-rest-server > Instantiation > Lifecycle Hooks

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
HookEvent	value The lifecycle event.

Element Detail

value

public abstract HookEvent value

The lifecycle event.