Interceptor (Grails 8.0.0-SNAPSHOT)

grails.artefact.Interceptor

All Implemented Interfaces and Traits:

DataBinder, RequestForwarder, ResponseRedirector, ResponseRenderer, ServletAttributes, WebAttributes, Ordered
```
@Trait
@CompileStatic
trait Interceptor
extends java.lang.Object
implements DataBinder, RequestForwarder, ResponseRedirector, ResponseRenderer, ServletAttributes, WebAttributes, Ordered
```
An interceptor can be used to intercept requests to controllers and URIs They replace the notion of filters from earlier versions of Grails, prior to Grails 3.0
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, java.lang.Object>`	`model`
`ModelAndView`	`modelAndView`
`int`	`order`
`java.lang.String`	`view`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`after()` Executed after the action executes but prior to view rendering
	`void`	`afterView()` Executed after view rendering completes
	`boolean`	`before()` Executed before a matched action
	`boolean`	`doesMatch()` Returns: Whether the current interceptor does match
	`boolean`	`doesMatch(HttpServletRequest request)` Whether this interceptor matches the given request.
	`java.util.Collection<Matcher>`	`getMatchers()` The matchers defined by this interceptor
	`java.util.Map<java.lang.String, java.lang.Object>`	`getModel()` Returns: The current model
	`ModelAndView`	`getModelAndView()` Obtains the ModelAndView for the currently executing controller
	`int`	`getOrder()` The order the interceptor should execute in
	`java.lang.Throwable`	`getThrowable()` Obtains the exception thrown by an action execution
	`java.lang.String`	`getView()` Returns: The current view
	`void`	`header(java.lang.String headerName, java.lang.Object headerValue)` Sets a response header for the given name and value
	`Matcher`	`match(java.util.Map arguments)` Used to define a match.
	`Matcher`	`matchAll()` Matches all requests
	`void`	`render(java.util.Map argMap)` Overridden render method that renders the view directly inside before()
	`void`	`setModel(java.util.Map<java.lang.String, java.lang.Object> model)` Sets the model
	`void`	`setModelAndView(ModelAndView mav)` Sets the ModelAndView of the current controller
	`void`	`setOrder(int order)` The order the interceptor should execute in
	`void`	`setView(java.lang.String view)` Sets the view name

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - java.util.Map<java.lang.String, java.lang.Object> model
  - ModelAndView modelAndView
  - int order
  - java.lang.String view
- Method Detail
  - @Generated
    boolean after()
    
    Executed after the action executes but prior to view rendering
    Returns:
    True if view rendering should continue, false otherwise
  - @Generated
    void afterView()
    
    Executed after view rendering completes
    Parameters:
    t - The exception instance if an exception was thrown, null otherwise
  - @Generated
    boolean before()
    
    Executed before a matched action
    Returns:
    Whether the action should continue and execute
  - @Generated
    boolean doesMatch()
    
    Returns:
    Whether the current interceptor does match
  - @Generated
    boolean doesMatch(HttpServletRequest request)
    
    Whether this interceptor matches the given request.
    URI matchers see the same path that URL mappings route on, resolved with the same UrlPathHelper call: path parameters (;name=value) are removed per segment before percent-decoding, as Jakarta Servlet 6.0 section 3.5.2 requires of containers, so an encoded semicolon (%3B) stays a literal character (RFC 3986 section 2.2); the path is decoded exactly once (RFC 3986 section 2.4); and the context path is stripped. Two points follow Spring, and therefore dispatch, rather than the URI specification: the context path is compared case-insensitively although RFC 3986 section 6.2.2.1 defines paths as case-sensitive, and during a RequestDispatcher include the included path is matched, which is also the path the include is dispatched on. A matcher that disagreed with dispatch on either point would let a request reach a controller without its interceptors, so dispatch wins.
    The path is canonicalized once per call and passed to every Matcher. A request whose URI contains an illegal percent escape, which a Servlet 6.0 container rejects with 400 before dispatch, is matched undecoded rather than failing.
    Parameters:
    request - The request to match
    Returns:
    Whether the current interceptor does match
  - @Generated
    java.util.Collection<Matcher> getMatchers()
    
    The matchers defined by this interceptor
  - @Generated
    java.util.Map<java.lang.String, java.lang.Object> getModel()
    
    Returns:
    The current model
  - @Generated
    ModelAndView getModelAndView()
    
    Obtains the ModelAndView for the currently executing controller
    Returns:
    The ModelAndView
  - @Generated
    int getOrder()
    
    The order the interceptor should execute in
  - @Generated
    java.lang.Throwable getThrowable()
    
    Obtains the exception thrown by an action execution
    Parameters:
    t - The exception or null if none was thrown
  - @Generated
    java.lang.String getView()
    
    Returns:
    The current view
  - @Generated
    void header(java.lang.String headerName, java.lang.Object headerValue)
    
    Sets a response header for the given name and value
    Parameters:
    headerName - The header name
    headerValue - The header value
  - @Generated
    Matcher match(java.util.Map arguments)
    
    Used to define a match. Example: match(controller:'book', action:'*')
    Parameters:
    arguments - The match arguments
  - @Generated
    Matcher matchAll()
    
    Matches all requests
  - @Generated
    void render(java.util.Map argMap)
    
    Overridden render method that renders the view directly inside before()
    Parameters:
    argMap
  - @Generated
    void setModel(java.util.Map<java.lang.String, java.lang.Object> model)
    
    Sets the model
    Parameters:
    model - The model to set
  - @Generated
    void setModelAndView(ModelAndView mav)
    
    Sets the ModelAndView of the current controller
    Parameters:
    mav - The ModelAndView
  - @Generated
    void setOrder(int order)
    
    The order the interceptor should execute in
  - @Generated
    void setView(java.lang.String view)
    
    Sets the view name
    Parameters:
    view - The name of the view

Summary:
Property
Method

| Detail:
Property
Method

[Groovy] Trait Interceptor

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, java.lang.Object> model

ModelAndView modelAndView

int order

java.lang.String view

Method Detail

@Generated
boolean after()

@Generated
void afterView()

@Generated
boolean before()

@Generated
boolean doesMatch()

@Generated
boolean doesMatch(HttpServletRequest request)

@Generated
java.util.Collection<Matcher> getMatchers()

@Generated
java.util.Map<java.lang.String, java.lang.Object> getModel()

@Generated
ModelAndView getModelAndView()

@Generated
int getOrder()

@Generated
java.lang.Throwable getThrowable()

@Generated
java.lang.String getView()

@Generated
void header(java.lang.String headerName, java.lang.Object headerValue)

@Generated
Matcher match(java.util.Map arguments)

@Generated
Matcher matchAll()

@Generated
void render(java.util.Map argMap)

@Generated
void setModel(java.util.Map<java.lang.String, java.lang.Object> model)

@Generated
void setModelAndView(ModelAndView mav)

@Generated
void setOrder(int order)

@Generated
void setView(java.lang.String view)

[Groovy] Trait Interceptor

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, java.lang.Object> model

ModelAndView modelAndView

int order

java.lang.String view

Method Detail

@Generatedboolean after()

@Generatedvoid afterView()

@Generatedboolean before()

@Generatedboolean doesMatch()

@Generatedboolean doesMatch(HttpServletRequest request)

@Generatedjava.util.Collection<Matcher> getMatchers()

@Generatedjava.util.Map<java.lang.String, java.lang.Object> getModel()

@GeneratedModelAndView getModelAndView()

@Generatedint getOrder()

@Generatedjava.lang.Throwable getThrowable()

@Generatedjava.lang.String getView()

@Generatedvoid header(java.lang.String headerName, java.lang.Object headerValue)

@GeneratedMatcher match(java.util.Map arguments)

@GeneratedMatcher matchAll()

@Generatedvoid render(java.util.Map argMap)

@Generatedvoid setModel(java.util.Map<java.lang.String, java.lang.Object> model)

@Generatedvoid setModelAndView(ModelAndView mav)

@Generatedvoid setOrder(int order)

@Generatedvoid setView(java.lang.String view)

@Generated
boolean after()

@Generated
void afterView()

@Generated
boolean before()

@Generated
boolean doesMatch()

@Generated
boolean doesMatch(HttpServletRequest request)

@Generated
java.util.Collection<Matcher> getMatchers()

@Generated
java.util.Map<java.lang.String, java.lang.Object> getModel()

@Generated
ModelAndView getModelAndView()

@Generated
int getOrder()

@Generated
java.lang.Throwable getThrowable()

@Generated
java.lang.String getView()

@Generated
void header(java.lang.String headerName, java.lang.Object headerValue)

@Generated
Matcher match(java.util.Map arguments)

@Generated
Matcher matchAll()

@Generated
void render(java.util.Map argMap)

@Generated
void setModel(java.util.Map<java.lang.String, java.lang.Object> model)

@Generated
void setModelAndView(ModelAndView mav)

@Generated
void setOrder(int order)

@Generated
void setView(java.lang.String view)