GroovyChainAction (Ratpack API (0.9.3))

java.lang.Object
- ratpack.groovy.handling.GroovyChainAction

All Implemented Interfaces:: Action<Chain>, GroovyChain, Chain

public abstract class GroovyChainAction
extends Object
implements Action<Chain>, GroovyChain

Convenient super class for packaging up Groovy handler chain logic.

Implementations can naturally use the GroovyChain DSL in their implementation of execute().

 import ratpack.groovy.handling.GroovyChainAction
 import ratpack.test.embed.PathBaseDirBuilder
 import ratpack.groovy.test.TestHttpClients
 import ratpack.groovy.test.embed.ClosureBackedEmbeddedApplication

 def baseDir = new PathBaseDirBuilder(new File("some/dir"))
 def app = new ClosureBackedEmbeddedApplication(baseDir)

 app.handlers {
   get("someHandler") {
     render "someHandler"
   }

   // Include the handlers defined in OtherHandlers
   handler chain(new OtherHandlers())
 }

 // In another file…

 class OtherHandlers extends GroovyChainAction {
   protected void execute() {
     // The GroovyChain DSL can be used in this method

     get("foo") {
       render "foo"
     }
     get("bar") {
       render "bar"
     }
   }
 }

 // Functionally test the whole app…

 def client = TestHttpClients.testHttpClient(app)

 assert client.getText("someHandler") == "someHandler"
 assert client.getText("foo") == "foo"
 assert client.getText("bar") == "bar"

 app.close()

 // Factoring out into GroovyChainAction implementations mean they can be unit tested in isolation…

 import ratpack.handling.Handlers
 import ratpack.test.MockLaunchConfig
 import static ratpack.groovy.test.GroovyUnitTest.invoke

 def launchConfig = new MockLaunchConfig()
 def handler = Handlers.chain(launchConfig, new OtherHandlers())

 assert invoke(handler) { uri "bar" }.rendered(String) == "bar"
 assert invoke(handler) { uri "foo" }.rendered(String) == "foo"

This class implements the GroovyChain interface by delegating each method to the chain returned by getChain(). This method only returns a value during execution of execute(Chain), which is the given chain available as a GroovyChain.

Constructor Summary

Constructors
Constructor and Description

GroovyChainAction()

Constructors
Constructor and Description
`GroovyChainAction()`

Method Summary

Methods
Modifier and Type	Method and Description
`GroovyChain`	`assets(String path, String... indexFiles)` Adds a handler that serves static assets at the given file system path, relative to the contextual file system binding.
`Handler`	`chain(Action<? super Chain> action)` Constructs a handler using the given action to define a chain.
`GroovyChain`	`delete(Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` `HTTPMethod` is `DELETE` and the `path` is at the current root.
`GroovyChain`	`delete(Handler handler)` Adds a handler that delegates to the given handler if the `request` `HTTPMethod` is `DELETE` and the `path` is at the current root.
`GroovyChain`	`delete(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `DELETE`.
`GroovyChain`	`delete(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `DELETE`.
`protected abstract void`	`execute()` Implementations can naturally use the `GroovyChain` DSL for the duration of this method.
`void`	`execute(Chain chain)` Delegates to `execute()`, using the given `chain` for delegation.
`GroovyChain`	`fileSystem(String path, Action<? super Chain> action)` Adds a handler to this chain that changes the `FileSystemBinding` for the given handler chain.
`GroovyChain`	`fileSystem(String path, Closure<?> handlers)` Creates a `List` of `Handler` from the given `Closure` and adds a `Handler` to this `GroovyChain` that changes the `FileSystemBinding` for the `Handler` list.
`GroovyChain`	`fileSystem(String path, Handler handler)` Adds a handler to this chain that changes the `FileSystemBinding` for the given handler.
`GroovyChain`	`get(Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` `HTTPMethod` is `GET` and the `path` is at the current root.
`GroovyChain`	`get(Handler handler)` Adds a handler that delegates to the given handler if the `request` `HTTPMethod` is `GET` and the `path` is at the current root.
`GroovyChain`	`get(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `GET`.
`GroovyChain`	`get(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `GET`.
`protected GroovyChain`	`getChain()`
`LaunchConfig`	`getLaunchConfig()` The launch config of the application that this chain is being created for.
`Registry`	`getRegistry()` The registry that backs this.
`GroovyChain`	`handler(Closure<?> handler)` Adds the given `Closure` as a `Handler` to this `GroovyChain`.
`GroovyChain`	`handler(Handler handler)` Adds the given handler to this.
`GroovyChain`	`handler(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` exactly.
`GroovyChain`	`handler(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` exactly.
`GroovyChain`	`header(String headerName, String headerValue, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` has a `HTTPHeader` with the given name and a it's value matches the given value exactly.
`GroovyChain`	`header(String headerName, String headerValue, Handler handler)` Adds a handler to the chain that delegates to the given handler if the request has a header with the given name and a its value matches the given value exactly.
`GroovyChain`	`patch(Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` `HTTPMethod` is `PATCH` and the `path` is at the current root.
`GroovyChain`	`patch(Handler handler)` Adds a handler that delegates to the given handler if the `request` `HTTPMethod` is `PATCH` and the `path` is at the current root.
`GroovyChain`	`patch(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `PATCH`.
`GroovyChain`	`patch(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `PATCH`.
`GroovyChain`	`post(Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` `HTTPMethod` is `POST` and the `path` is at the current root.
`GroovyChain`	`post(Handler handler)` Adds a handler that delegates to the given handler if the `request` `HTTPMethod` is `POST` and the `path` is at the current root.
`GroovyChain`	`post(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `POST`.
`GroovyChain`	`post(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `POST`.
`GroovyChain`	`prefix(String prefix, Action<? super Chain> action)` Adds a handler that delegates to the given handlers if the relative path starts with the given `prefix`.
`GroovyChain`	`prefix(String prefix, Closure<?> chain)` Creates a `List` of `Handler` from the given `Closure` and adds a `Handler` to this `GroovyChain` that delegates to the `Handler` list if the relative path starts with the given `prefix`.
`GroovyChain`	`prefix(String prefix, Handler handler)` Adds a handler that delegates to the given handler if the relative path starts with the given `prefix`.
`GroovyChain`	`put(Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the `request` `HTTPMethod` is `PUT` and the `path` is at the current root.
`GroovyChain`	`put(Handler handler)` Adds a handler that delegates to the given handler if the `request` `HTTPMethod` is `PUT` and the `path` is at the current root.
`GroovyChain`	`put(String path, Closure<?> handler)` Adds a `Handler` to this `GroovyChain` that delegates to the given `Closure` as a `Handler` if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `PUT`.
`GroovyChain`	`put(String path, Handler handler)` Adds a handler that delegates to the given handler if the relative `path` matches the given `path` and the `request` `HTTPMethod` is `PUT`.
`<T> GroovyChain`	`register(Class<? super T> type, T service, Action<? super Chain> action)` Adds a handler to this chain that inserts the given handler chain with the given service addition.
`<T> GroovyChain`	`register(Class<? super T> type, T service, Closure<?> handlers)` Creates a `List` of `Handler` from the given `Closure` and adds a `Handler` to this `GroovyChain` that inserts the the `Handler` list with the given `service` addition.
`<T> GroovyChain`	`register(Class<? super T> type, T object, Handler handler)` Adds a handler that inserts the given handlers with the given service addition.
`GroovyChain`	`register(Object service, Action<? super Chain> action)` Adds a handler to this chain that inserts the given handler with the given service addition.
`GroovyChain`	`register(Object service, Closure<?> handlers)` Creates a `List` of `Handler` from the given `Closure` and adds a `Handler` to this `GroovyChain` that inserts the `Handler` list with the given `service` addition.
`GroovyChain`	`register(Object object, Handler handler)` Adds a handler that inserts the given handler with the given service addition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroovyChainAction
```
public GroovyChainAction()
```
- Method Detail
  - getChain
```
protected GroovyChain getChain()
                        throws IllegalStateException
```
    Throws:
    
    IllegalStateException
  - execute
```
public final void execute(Chain chain)
                   throws Exception
```
    Delegates to execute(), using the given chain for delegation.
    
    Specified by:
    
    execute in interface Action<Chain>
    
    Parameters:
    chain - The chain to add handlers to
    
    Throws:
    
    Exception - Any thrown by execute()
  - execute
```
protected abstract void execute()
                         throws Exception
```
    Implementations can naturally use the GroovyChain DSL for the duration of this method.
    See the class level documentation for an implementation example.
    
    Throws:
    
    Exception - Any exception thrown while defining the handlers
  - handler
```
public GroovyChain handler(@DelegatesTo(value=GroovyContext.class,strategy=1)
                  Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds the given Closure as a Handler to this GroovyChain.
    
    Specified by:
    
    handler in interface GroovyChain
    
    Parameters:
    handler - the Closure to add
    
    Returns:
    this GroovyChain
  - handler
```
public GroovyChain handler(String path,
                  @DelegatesTo(value=GroovyContext.class,strategy=1)
                  Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path exactly.
    See GroovyChain.handler(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    handler in interface GroovyChain
    
    Parameters:
    path - the relative path to match exactly on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - handler
```
public GroovyChain handler(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds the given handler to this.
    
    Specified by:
    
    handler in interface GroovyChain
    
    Specified by:
    
    handler in interface Chain
    
    Parameters:
    handler - the handler to add
    
    Returns:
    this
  - prefix
```
public GroovyChain prefix(String prefix,
                 Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path starts with the given prefix.
    All path based handlers become relative to the given prefix.
    See Handlers.prefix(String, Handler) for format details on the prefix string.
    
    Specified by:
    
    prefix in interface GroovyChain
    
    Specified by:
    
    prefix in interface Chain
    
    Parameters:
    prefix - the relative path to match on
    handler - the handler to delegate to if the prefix matches
    
    Returns:
    this
  - prefix
```
public GroovyChain prefix(String prefix,
                 Action<? super Chain> action)
                   throws Exception
```
    Description copied from interface: GroovyChain
    Adds a handler that delegates to the given handlers if the relative path starts with the given prefix.
    All path based handlers become relative to the given prefix.
```
   chain
     .prefix("person/:id", new Action<Chain>() {
       public void execute(Chain personChain) {
         personChain
           .get("info", new Handler() {
             public void handle(Context context) {
               // e.g. /person/2/info
             }
           })
           .post("save", new Handler() {
             public void handle(Context context) {
               // e.g. /person/2/save
             }
           })
           .prefix("child/:childId", new Action<Chain>() {
             public void execute(Chain childChain) {
               childChain
                 .get("info", new Handler() {
                   public void handle(Context context) {
                     // e.g. /person/2/child/1/info
                   }
                 });
             }
           });
       }
     });
 
```
    See Handlers.prefix(String, Handler) for format details on the prefix string.
    Specified by:
    
    prefix in interface GroovyChain
    
    Specified by:
    
    prefix in interface Chain
    
    Parameters:
    prefix - the relative path to match on
    action - the handler chain to delegate to if the prefix matches
    
    Returns:
    this
    
    Throws:
    
    Exception - any thrown by action
  - prefix
```
public GroovyChain prefix(String prefix,
                 @DelegatesTo(value=GroovyChain.class,strategy=1)
                 Closure<?> chain)
                   throws Exception
```
    Description copied from interface: GroovyChain
    
    Creates a List of Handler from the given Closure and adds a Handler to this GroovyChain that delegates to the Handler list if the relative path starts with the given prefix.
    See Chain.prefix(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    prefix in interface GroovyChain
    
    Parameters:
    prefix - the relative path to match on
    chain - the definition of the chain to delegate to
    
    Returns:
    this GroovyChain
    
    Throws:
    
    Exception - any exception thrown by the given closure
  - handler
```
public GroovyChain handler(String path,
                  Handler handler)
```
    Description copied from interface: GroovyChain
    Adds a handler that delegates to the given handler if the relative path matches the given path exactly.
    Nesting path handlers will not work due to the exact matching, use a combination of path and prefix instead. See Chain.prefix(String, Handler) for details.
```
   // this will not work
   path("person/:id") {
     path("child/:childId") {
       // a request of /person/2/child/1 will not get passed the first handler as it will try
       // to match "person/2/child/1" with "person/2" which does not match
     }

   // this will work
   prefix("person/:id") {
     path("child/:childId") {
       // a request of /person/2/child/1 will work this time
     }
   }
 
```
    See Handlers.path(String, Handler) for the details on how path is interpreted.
    Specified by:
    
    handler in interface GroovyChain
    
    Specified by:
    
    handler in interface Chain
    
    Parameters:
    path - the relative path to match exactly on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.post(String, Handler), Chain.get(String, Handler), Chain.put(String, Handler), Chain.patch(String, Handler), Chain.delete(String, Handler)
  - get
```
public GroovyChain get(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the request HTTPMethod is GET and the path is at the current root.
    
    Specified by:
    
    get in interface GroovyChain
    
    Specified by:
    
    get in interface Chain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.post(Handler), Chain.put(Handler), Chain.patch(Handler), Chain.delete(Handler)
  - get
```
public GroovyChain get(String path,
              Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is GET.
    
    Specified by:
    
    get in interface GroovyChain
    
    Specified by:
    
    get in interface Chain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.post(String, Handler), Chain.put(String, Handler), Chain.patch(String, Handler), Chain.delete(String, Handler), Chain.handler(String, Handler)
  - get
```
public GroovyChain get(String path,
              @DelegatesTo(value=GroovyContext.class,strategy=1)
              Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is GET.
    See GroovyChain.get(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    get in interface GroovyChain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - get
```
public GroovyChain get(@DelegatesTo(value=GroovyContext.class,strategy=1)
              Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is GET and the path is at the current root.
    See GroovyChain.get(ratpack.handling.Handler) for more details.
    
    Specified by:
    
    get in interface GroovyChain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - post
```
public GroovyChain post(String path,
               Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is POST.
    
    Specified by:
    
    post in interface GroovyChain
    
    Specified by:
    
    post in interface Chain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(String, Handler), Chain.put(String, Handler), Chain.patch(String, Handler), Chain.delete(String, Handler), Chain.handler(String, Handler)
  - post
```
public GroovyChain post(String path,
               @DelegatesTo(value=GroovyContext.class,strategy=1)
               Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is POST.
    See GroovyChain.post(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    post in interface GroovyChain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - post
```
public GroovyChain post(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the request HTTPMethod is POST and the path is at the current root.
    
    Specified by:
    
    post in interface GroovyChain
    
    Specified by:
    
    post in interface Chain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(Handler), Chain.put(Handler), Chain.patch(Handler), Chain.delete(Handler)
  - post
```
public GroovyChain post(@DelegatesTo(value=GroovyContext.class,strategy=1)
               Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is POST and the path is at the current root.
    See GroovyChain.post(ratpack.handling.Handler) for more details.
    
    Specified by:
    
    post in interface GroovyChain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - put
```
public GroovyChain put(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the request HTTPMethod is PUT and the path is at the current root.
    
    Specified by:
    
    put in interface GroovyChain
    
    Specified by:
    
    put in interface Chain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(Handler), Chain.post(Handler), Chain.patch(Handler), Chain.delete(Handler)
  - put
```
public GroovyChain put(String path,
              Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is PUT.
    
    Specified by:
    
    put in interface GroovyChain
    
    Specified by:
    
    put in interface Chain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(String, Handler), Chain.post(String, Handler), Chain.patch(String, Handler), Chain.delete(String, Handler), Chain.handler(String, Handler)
  - put
```
public GroovyChain put(String path,
              @DelegatesTo(value=GroovyContext.class,strategy=1)
              Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is PUT.
    See GroovyChain.put(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    put in interface GroovyChain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - put
```
public GroovyChain put(@DelegatesTo(value=GroovyContext.class,strategy=1)
              Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is PUT and the path is at the current root.
    See GroovyChain.put(ratpack.handling.Handler) for more details.
    
    Specified by:
    
    put in interface GroovyChain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - patch
```
public GroovyChain patch(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the request HTTPMethod is PATCH and the path is at the current root.
    
    Specified by:
    
    patch in interface GroovyChain
    
    Specified by:
    
    patch in interface Chain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(Handler), Chain.post(Handler), Chain.put(Handler), Chain.delete(Handler)
  - patch
```
public GroovyChain patch(String path,
                Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is PATCH.
    
    Specified by:
    
    patch in interface GroovyChain
    
    Specified by:
    
    patch in interface Chain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(String, Handler), Chain.post(String, Handler), Chain.put(String, Handler), Chain.delete(String, Handler), Chain.handler(String, Handler)
  - patch
```
public GroovyChain patch(String path,
                @DelegatesTo(value=GroovyContext.class,strategy=1)
                Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is PATCH.
    See GroovyChain.put(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    patch in interface GroovyChain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - patch
```
public GroovyChain patch(@DelegatesTo(value=GroovyContext.class,strategy=1)
                Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is PATCH and the path is at the current root.
    See GroovyChain.put(ratpack.handling.Handler) for more details.
    
    Specified by:
    
    patch in interface GroovyChain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - delete
```
public GroovyChain delete(Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the request HTTPMethod is DELETE and the path is at the current root.
    
    Specified by:
    
    delete in interface GroovyChain
    
    Specified by:
    
    delete in interface Chain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(Handler), Chain.post(Handler), Chain.put(Handler), Chain.patch(Handler)
  - delete
```
public GroovyChain delete(String path,
                 Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is DELETE.
    
    Specified by:
    
    delete in interface GroovyChain
    
    Specified by:
    
    delete in interface Chain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this
    See Also:
    Chain.get(String, Handler), Chain.post(String, Handler), Chain.put(String, Handler), Chain.patch(String, Handler), Chain.handler(String, Handler)
  - delete
```
public GroovyChain delete(String path,
                 @DelegatesTo(value=GroovyContext.class,strategy=1)
                 Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is DELETE.
    See GroovyChain.delete(String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    delete in interface GroovyChain
    
    Parameters:
    path - the relative path to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - delete
```
public GroovyChain delete(@DelegatesTo(value=GroovyContext.class,strategy=1)
                 Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is DELETE and the path is at the current root.
    See GroovyChain.delete(ratpack.handling.Handler) for more details.
    
    Specified by:
    
    delete in interface GroovyChain
    
    Parameters:
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - register
```
public GroovyChain register(Object object,
                   Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that inserts the given handler with the given service addition.
    The service object will be available by its concrete type.
    See Handlers.register(Object, Handler) for more details on the handler created
    
    Specified by:
    
    register in interface GroovyChain
    
    Specified by:
    
    register in interface Chain
    
    Parameters:
    object - the object to add to the service for the handlers
    handler - the handlers to register the service with
    
    Returns:
    this
    See Also:
    Chain.register(Class, Object, Handler)
  - register
```
public GroovyChain register(Object service,
                   Action<? super Chain> action)
                     throws Exception
```
    Description copied from interface: GroovyChain
    
    Adds a handler to this chain that inserts the given handler with the given service addition.
    The service object will be available by its concrete type.
    See Handlers.register(Object, Handler) for more details on the handler created
    
    Specified by:
    
    register in interface GroovyChain
    
    Specified by:
    
    register in interface Chain
    
    Parameters:
    service - the object to add to the service for the handlers
    action - the handlers to register the service with
    
    Returns:
    this
    
    Throws:
    
    Exception - any thrown by action
    See Also:
    Chain.register(Class, Object, Handler)
  - register
```
public GroovyChain register(Object service,
                   @DelegatesTo(value=GroovyChain.class,strategy=1)
                   Closure<?> handlers)
                     throws Exception
```
    Description copied from interface: GroovyChain
    
    Creates a List of Handler from the given Closure and adds a Handler to this GroovyChain that inserts the Handler list with the given service addition.
    See GroovyChain.register(Object, Handler) for more details.
    
    Specified by:
    
    register in interface GroovyChain
    
    Parameters:
    service - the object to add to the service for the handlers
    handlers - the handlers to register the service with
    
    Returns:
    this GroovyChain
    
    Throws:
    
    Exception - any exception thrown by the given closure
  - register
```
public <T> GroovyChain register(Class<? super T> type,
                       T object,
                       Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler that inserts the given handlers with the given service addition.
    The service object will be available by the given type.
    See Handlers.register(Class, Object, Handler) for more details on the handler created
    
    Specified by:
    
    register in interface GroovyChain
    
    Specified by:
    
    register in interface Chain
    
    Type Parameters:
    T - the concrete type of the service addition
    Parameters:
    type - the Type by which to make the service object available
    object - the object to add to the service for the handlers
    handler - the handlers to register the service with
    
    Returns:
    this
    See Also:
    Chain.register(Object, Handler)
  - register
```
public <T> GroovyChain register(Class<? super T> type,
                       T service,
                       Action<? super Chain> action)
                     throws Exception
```
    Description copied from interface: Chain
    
    Adds a handler to this chain that inserts the given handler chain with the given service addition.
    The service object will be available by the given type.
    See Handlers.register(Class, Object, Handler) for more details on the handler created
    
    Specified by:
    
    register in interface GroovyChain
    
    Specified by:
    
    register in interface Chain
    
    Type Parameters:
    T - the concrete type of the service addition
    Parameters:
    type - the Type by which to make the service object available
    service - the object to add to the service for the handlers
    action - the handlers which to register the service for
    
    Returns:
    this
    
    Throws:
    
    Exception - any thrown by action
    See Also:
    Chain.register(Object, Handler)
  - register
```
public <T> GroovyChain register(Class<? super T> type,
                       T service,
                       @DelegatesTo(value=GroovyChain.class,strategy=1)
                       Closure<?> handlers)
                     throws Exception
```
    Description copied from interface: GroovyChain
    
    Creates a List of Handler from the given Closure and adds a Handler to this GroovyChain that inserts the the Handler list with the given service addition.
    See GroovyChain.register(Class, Object, Handler) for more details.
    
    Specified by:
    
    register in interface GroovyChain
    
    Type Parameters:
    T - the concrete type of the service addition
    Parameters:
    type - the Type by which to make the service object available
    service - the object to add to the service for the handlers
    handlers - the handlers to register the service with
    
    Returns:
    this GroovyChain
    
    Throws:
    
    Exception - any exception thrown by the given closure
  - assets
```
public GroovyChain assets(String path,
                 String... indexFiles)
```
    Description copied from interface: GroovyChain
    Adds a handler that serves static assets at the given file system path, relative to the contextual file system binding.
    See Handlers.assets(String, java.util.List) for more details on the handler created
```
    prefix("foo") {
      assets("d1", "index.html", "index.xhtml")
    }
 
```
    In the above configuration a request like "/foo/app.js" will return the static file "app.js" that is located in the directory "d1".
    If the request matches a directory e.g. "/foo", an index file may be served. The indexFiles array specifies the names of files to look for in order to serve.
    Specified by:
    
    assets in interface GroovyChain
    
    Specified by:
    
    assets in interface Chain
    
    Parameters:
    path - the relative path to the location of the assets to serve
    indexFiles - the index files to try if the request is for a directory
    
    Returns:
    this
  - fileSystem
```
public GroovyChain fileSystem(String path,
                     Handler handler)
```
    Description copied from interface: GroovyChain
    
    Adds a handler to this chain that changes the FileSystemBinding for the given handler.
    
    Specified by:
    
    fileSystem in interface GroovyChain
    
    Specified by:
    
    fileSystem in interface Chain
    
    Parameters:
    path - the relative path to the new file system binding point
    handler - the handler
    
    Returns:
    this}
  - fileSystem
```
public GroovyChain fileSystem(String path,
                     Action<? super Chain> action)
                       throws Exception
```
    Description copied from interface: Chain
    
    Adds a handler to this chain that changes the FileSystemBinding for the given handler chain.
    
    Specified by:
    
    fileSystem in interface GroovyChain
    
    Specified by:
    
    fileSystem in interface Chain
    
    Parameters:
    path - the relative path to the new file system binding point
    action - the definition of the handler chain
    
    Returns:
    this
    
    Throws:
    
    Exception - any thrown by action
  - fileSystem
```
public GroovyChain fileSystem(String path,
                     @DelegatesTo(value=GroovyChain.class,strategy=1)
                     Closure<?> handlers)
                       throws Exception
```
    Description copied from interface: GroovyChain
    
    Creates a List of Handler from the given Closure and adds a Handler to this GroovyChain that changes the FileSystemBinding for the Handler list.
    See GroovyChain.fileSystem(String, Handler) for more details.
    
    Specified by:
    
    fileSystem in interface GroovyChain
    
    Parameters:
    path - the relative path to the new file system binding point
    handlers - the definition of the handler chain
    
    Returns:
    this GroovyChain
    
    Throws:
    
    Exception - any exception thrown by the given closure
  - header
```
public GroovyChain header(String headerName,
                 String headerValue,
                 Handler handler)
```
    Description copied from interface: GroovyChain
    Adds a handler to the chain that delegates to the given handler if the request has a header with the given name and a its value matches the given value exactly.
    Specified by:
    
    header in interface GroovyChain
    
    Specified by:
    
    header in interface Chain
    
    Parameters:
    headerName - the name of the HTTP Header to match on
    headerValue - the value of the HTTP Header to match on
    handler - the handler to delegate to
    
    Returns:
    this
  - header
```
public GroovyChain header(String headerName,
                 String headerValue,
                 @DelegatesTo(value=GroovyContext.class,strategy=1)
                 Closure<?> handler)
```
    Description copied from interface: GroovyChain
    
    Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request has a HTTPHeader with the given name and a it's value matches the given value exactly.
    See GroovyChain.header(String, String, ratpack.handling.Handler) for more details.
    
    Specified by:
    
    header in interface GroovyChain
    
    Parameters:
    headerName - the name of the HTTP Header to match on
    headerValue - the value of the HTTP Header to match on
    handler - the handler to delegate to
    
    Returns:
    this GroovyChain
  - getRegistry
```
@Nullable
public Registry getRegistry()
```
    Description copied from interface: Chain
    
    The registry that backs this.
    The registry that is available is dependent on how the GroovyChain was constructed.
    
    Specified by:
    
    getRegistry in interface Chain
    
    Returns:
    The registry that backs this, or null if this has no registry.
    See Also:
    Handlers.chain(LaunchConfig, ratpack.registry.Registry, ratpack.func.Action)
  - getLaunchConfig
```
public LaunchConfig getLaunchConfig()
```
    Description copied from interface: Chain
    
    The launch config of the application that this chain is being created for.
    
    Specified by:
    
    getLaunchConfig in interface Chain
    
    Returns:
    The launch config of the application that this chain is being created for.
  - chain
```
public Handler chain(Action<? super Chain> action)
              throws Exception
```
    Description copied from interface: Chain
    
    Constructs a handler using the given action to define a chain.
    
    Specified by:
    
    chain in interface Chain
    
    Parameters:
    action - The action that defines the handler chain
    
    Returns:
    A handler representing the chain
    
    Throws:
    
    Exception - any thrown by action

Class GroovyChainAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroovyChainAction

Method Detail

getChain

execute

execute

handler

handler

handler

prefix

prefix

prefix

handler

get

get

get

get

post

post

post

post

put

put

put

put

patch

patch

patch

patch

delete

delete

delete

delete

register

register

register

register

register

register

assets

fileSystem

fileSystem

fileSystem

header

header

getRegistry

getLaunchConfig

chain