ratpack.groovy.handling

Interface GroovyChain

All Superinterfaces:

Chain

All Known Implementing Classes:

GroovyChainAction

public interface GroovyChain
extends Chain

A Groovy oriented handler chain builder DSL.

The methods specific to this subclass create Handler instances from closures and add them to the underlying chain.

These methods are generally shortcuts for all(ratpack.handling.Handler) on this underlying chain.

Method Summary

Modifier and Type	Method and Description
default GroovyChain	all(java.lang.Class<? extends Handler> handler)
default GroovyChain	all(Closure<?> handler) Adds the given Closure as a Handler to this GroovyChain.
GroovyChain	all(Handler handler)
default Handler	chain(Closure<?> closure) Creates a handler from the given closure.
default GroovyChain	delete(java.lang.Class<? extends Handler> handler)
default 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.
default GroovyChain	delete(Handler handler)
default GroovyChain	delete(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	delete(java.lang.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.
default GroovyChain	delete(java.lang.String path, Handler handler)
default GroovyChain	files()
default GroovyChain	files(Action<? super FileHandlerSpec> config)
default GroovyChain	files(Closure<?> closure)
default GroovyChain	fileSystem(java.lang.String path, Action<? super Chain> action)
default GroovyChain	fileSystem(java.lang.String path, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	fileSystem(java.lang.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.
static GroovyChain	from(Chain chain) Creates a Groovy chain wrapper over a chain instance.
default GroovyChain	get(java.lang.Class<? extends Handler> handler)
default 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.
default GroovyChain	get(Handler handler)
default GroovyChain	get(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	get(java.lang.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.
default GroovyChain	get(java.lang.String path, Handler handler)
default GroovyChain	host(java.lang.String hostName, Action<? super Chain> action)
default GroovyChain	host(java.lang.String hostName, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	host(java.lang.String hostName, Closure<?> handler) If the request has a Host header that matches the given host name exactly, handling will be delegated to the chain defined by the given closure.
default GroovyChain	insert(Action<? super Chain> action)
default GroovyChain	insert(java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	insert(Closure<?> closure) Inserts the given nested handler chain.
default GroovyChain	onlyIf(Closure<?> test, Closure<?> handler)
default GroovyChain	onlyIf(Closure<?> test, Handler handler)
default GroovyChain	onlyIf(Predicate<? super Context> test, java.lang.Class<? extends Handler> handler)
default GroovyChain	onlyIf(Predicate<? super Context> test, Closure<?> handler)
default GroovyChain	onlyIf(Predicate<? super Context> test, Handler handler)
default GroovyChain	patch(java.lang.Class<? extends Handler> handler)
default 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.
default GroovyChain	patch(Handler handler)
default GroovyChain	patch(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	patch(java.lang.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.
default GroovyChain	patch(java.lang.String path, Handler handler)
default GroovyChain	path(java.lang.Class<? extends Handler> handler)
default GroovyChain	path(Closure<?> handler)
default GroovyChain	path(Handler handler)
default GroovyChain	path(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	path(java.lang.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.
default GroovyChain	path(java.lang.String path, Handler handler)
default GroovyChain	post(java.lang.Class<? extends Handler> handler)
default 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.
default GroovyChain	post(Handler handler)
default GroovyChain	post(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	post(java.lang.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.
default GroovyChain	post(java.lang.String path, Handler handler)
default GroovyChain	prefix(java.lang.String prefix, Action<? super Chain> action)
default GroovyChain	prefix(java.lang.String prefix, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	prefix(java.lang.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.
default GroovyChain	put(java.lang.Class<? extends Handler> handler)
default 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.
default GroovyChain	put(Handler handler)
default GroovyChain	put(java.lang.String path, java.lang.Class<? extends Handler> handler)
default GroovyChain	put(java.lang.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.
default GroovyChain	put(java.lang.String path, Handler handler)
default GroovyChain	redirect(int code, java.lang.String location)
default GroovyChain	register(Action<? super RegistrySpec> action)
default GroovyChain	register(Action<? super RegistrySpec> registryAction, Action<? super Chain> chainAction)
default GroovyChain	register(Action<? super RegistrySpec> registryAction, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	register(Action<? super RegistrySpec> registryAction, Closure<?> handler)
default GroovyChain	register(Closure<?> closure)
default GroovyChain	register(Registry registry)
default GroovyChain	register(Registry registry, Action<? super Chain> action)
default GroovyChain	register(Registry registry, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	register(Registry registry, Closure<?> handlers)
default GroovyChain	when(Closure<?> test, Action<? super Chain> chain)
default GroovyChain	when(Closure<?> test, Closure<?> handlers)
default GroovyChain	when(Predicate<? super Context> test, Action<? super Chain> action)
default GroovyChain	when(Predicate<? super Context> test, java.lang.Class<? extends Action<? super Chain>> action)
default GroovyChain	when(Predicate<? super Context> test, Closure<?> handlers)

Methods inherited from interface ratpack.handling.Chain

chain, chain, getRegistry, getServerConfig

Method Detail

from

static GroovyChain from(Chain chain)

Creates a Groovy chain wrapper over a chain instance.

Parameters:

chain - a chain instance

Returns:

a Groovy wrapper

all

default GroovyChain all(@DelegatesTo(value=GroovyContext.class,strategy=1)
                        Closure<?> handler)

Adds the given Closure as a Handler to this GroovyChain.

Parameters:

handler - the Closure to add

Returns:

this GroovyChain

all

GroovyChain all(Handler handler)

Specified by:

all in interface Chain

all

default GroovyChain all(java.lang.Class<? extends Handler> handler)

Specified by:

all in interface Chain

chain

default Handler chain(@DelegatesTo(value=GroovyChain.class,strategy=1)
                      Closure<?> closure)
               throws java.lang.Exception

Creates a handler from the given closure.

Parameters:

closure - a chain definition

Returns:

a new handler

Throws:

java.lang.Exception - any thrown by closure

delete

default GroovyChain delete(java.lang.String path,
                           @DelegatesTo(value=GroovyContext.class,strategy=1)
                           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.

See delete(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match on

handler - the handler to delegate to

Returns:

this GroovyChain

delete

default GroovyChain delete(@DelegatesTo(value=GroovyContext.class,strategy=1)
                           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.

See delete(ratpack.handling.Handler) for more details.

Parameters:

handler - the handler to delegate to

Returns:

this GroovyChain

delete

default GroovyChain delete(java.lang.String path,
                           Handler handler)

Specified by:

delete in interface Chain

delete

default GroovyChain delete(java.lang.String path,
                           java.lang.Class<? extends Handler> handler)

Specified by:

delete in interface Chain

delete

default GroovyChain delete(Handler handler)

Specified by:

delete in interface Chain

delete

default GroovyChain delete(java.lang.Class<? extends Handler> handler)

Specified by:

delete in interface Chain

fileSystem

default GroovyChain fileSystem(java.lang.String path,
                               @DelegatesTo(value=GroovyChain.class,strategy=1)
                               Closure<?> handlers)
                        throws java.lang.Exception

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 fileSystem(String, ratpack.func.Action) for more details.

Parameters:

path - the relative path to the new file system binding point

handlers - the definition of the handler chain

Returns:

this GroovyChain

Throws:

java.lang.Exception - any thrown by closure

fileSystem

default GroovyChain fileSystem(java.lang.String path,
                               Action<? super Chain> action)
                        throws java.lang.Exception

Specified by:

fileSystem in interface Chain

Throws:

java.lang.Exception

fileSystem

default GroovyChain fileSystem(java.lang.String path,
                               java.lang.Class<? extends Action<? super Chain>> action)
                        throws java.lang.Exception

Specified by:

fileSystem in interface Chain

Throws:

java.lang.Exception

files

default GroovyChain files(Action<? super FileHandlerSpec> config)
                   throws java.lang.Exception

Specified by:

files in interface Chain

Throws:

java.lang.Exception

files

default GroovyChain files()

Specified by:

files in interface Chain

files

default GroovyChain files(@DelegatesTo(value=ratpack.file.FileHandlerSpec.class,strategy=1)
                          Closure<?> closure)
                   throws java.lang.Exception

Throws:

java.lang.Exception

get

default GroovyChain get(java.lang.String path,
                        Handler handler)

Specified by:

get in interface Chain

get

default GroovyChain get(java.lang.String path,
                        java.lang.Class<? extends Handler> handler)

Specified by:

get in interface Chain

get

default GroovyChain get(Handler handler)

Specified by:

get in interface Chain

get

default GroovyChain get(java.lang.Class<? extends Handler> handler)

Specified by:

get in interface Chain

get

default GroovyChain get(java.lang.String path,
                        @DelegatesTo(value=GroovyContext.class,strategy=1)
                        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.

See get(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match on

handler - the handler to delegate to

Returns:

this GroovyChain

get

default GroovyChain get(@DelegatesTo(value=GroovyContext.class,strategy=1)
                        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.

See get(ratpack.handling.Handler) for more details.

Parameters:

handler - the handler to delegate to

Returns:

this GroovyChain

host

default GroovyChain host(java.lang.String hostName,
                         Action<? super Chain> action)
                  throws java.lang.Exception

Specified by:

host in interface Chain

Throws:

java.lang.Exception

host

default GroovyChain host(java.lang.String hostName,
                         java.lang.Class<? extends Action<? super Chain>> action)
                  throws java.lang.Exception

Specified by:

host in interface Chain

Throws:

java.lang.Exception

host

default GroovyChain host(java.lang.String hostName,
                         @DelegatesTo(value=GroovyChain.class,strategy=1)
                         Closure<?> handler)
                  throws java.lang.Exception

If the request has a Host header that matches the given host name exactly, handling will be delegated to the chain defined by the given closure.

Parameters:

hostName - the name of the HTTP Header to match on

handler - the handler to delegate to

Returns:

this GroovyChain

Throws:

java.lang.Exception - any thrown by closure

See Also:

host(String, ratpack.func.Action)

insert

default GroovyChain insert(Action<? super Chain> action)
                    throws java.lang.Exception

Specified by:

insert in interface Chain

Throws:

java.lang.Exception

insert

default GroovyChain insert(java.lang.Class<? extends Action<? super Chain>> action)
                    throws java.lang.Exception

Specified by:

insert in interface Chain

Throws:

java.lang.Exception

insert

default GroovyChain insert(@DelegatesTo(value=GroovyChain.class,strategy=1)
                           Closure<?> closure)
                    throws java.lang.Exception

Inserts the given nested handler chain.

Shorter form of all(Handler) handler}(chain(closure).

Parameters:

closure - the handler chain to insert

Returns:

this

Throws:

java.lang.Exception - any thrown by closure

patch

default GroovyChain patch(java.lang.String path,
                          Handler handler)

Specified by:

patch in interface Chain

patch

default GroovyChain patch(java.lang.String path,
                          java.lang.Class<? extends Handler> handler)

Specified by:

patch in interface Chain

patch

default GroovyChain patch(Handler handler)

Specified by:

patch in interface Chain

patch

default GroovyChain patch(java.lang.Class<? extends Handler> handler)

Specified by:

patch in interface Chain

patch

default GroovyChain patch(java.lang.String path,
                          @DelegatesTo(value=GroovyContext.class,strategy=1)
                          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.

See put(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match on

handler - the handler to delegate to

Returns:

this GroovyChain

patch

default GroovyChain patch(@DelegatesTo(value=GroovyContext.class,strategy=1)
                          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.

See put(ratpack.handling.Handler) for more details.

Parameters:

handler - the handler to delegate to

Returns:

this GroovyChain

path

default GroovyChain path(java.lang.String path,
                         Handler handler)

Specified by:

path in interface Chain

path

default GroovyChain path(Handler handler)

Specified by:

path in interface Chain

path

default GroovyChain path(java.lang.String path,
                         java.lang.Class<? extends Handler> handler)

Specified by:

path in interface Chain

path

default GroovyChain path(java.lang.Class<? extends Handler> handler)

Specified by:

path in interface Chain

path

default GroovyChain path(java.lang.String path,
                         @DelegatesTo(value=GroovyContext.class,strategy=1)
                         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.

See path(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match exactly on

handler - the handler to delegate to

Returns:

this GroovyChain

path

default GroovyChain path(@DelegatesTo(value=GroovyContext.class,strategy=1)
                         Closure<?> handler)

post

default GroovyChain post(java.lang.String path,
                         Handler handler)

Specified by:

post in interface Chain

post

default GroovyChain post(java.lang.String path,
                         java.lang.Class<? extends Handler> handler)

Specified by:

post in interface Chain

post

default GroovyChain post(Handler handler)

Specified by:

post in interface Chain

post

default GroovyChain post(java.lang.Class<? extends Handler> handler)

Specified by:

post in interface Chain

post

default GroovyChain post(java.lang.String path,
                         @DelegatesTo(value=GroovyContext.class,strategy=1)
                         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.

See post(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match on

handler - the handler to delegate to

Returns:

this GroovyChain

post

default GroovyChain post(@DelegatesTo(value=GroovyContext.class,strategy=1)
                         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.

See post(ratpack.handling.Handler) for more details.

Parameters:

handler - the handler to delegate to

Returns:

this GroovyChain

prefix

default GroovyChain prefix(java.lang.String prefix,
                           Action<? super Chain> action)
                    throws java.lang.Exception

Specified by:

prefix in interface Chain

Throws:

java.lang.Exception

prefix

default GroovyChain prefix(java.lang.String prefix,
                           java.lang.Class<? extends Action<? super Chain>> action)
                    throws java.lang.Exception

Specified by:

prefix in interface Chain

Throws:

java.lang.Exception

prefix

default GroovyChain prefix(java.lang.String prefix,
                           @DelegatesTo(value=GroovyChain.class,strategy=1)
                           Closure<?> chain)
                    throws java.lang.Exception

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.func.Action) for more details.

Parameters:

prefix - the relative path to match on

chain - the definition of the chain to delegate to

Returns:

this GroovyChain

Throws:

java.lang.Exception - any exception thrown by the given closure

put

default GroovyChain put(java.lang.String path,
                        Handler handler)

Specified by:

put in interface Chain

put

default GroovyChain put(java.lang.String path,
                        java.lang.Class<? extends Handler> handler)

Specified by:

put in interface Chain

put

default GroovyChain put(Handler handler)

Specified by:

put in interface Chain

put

default GroovyChain put(java.lang.Class<? extends Handler> handler)

Specified by:

put in interface Chain

put

default GroovyChain put(java.lang.String path,
                        @DelegatesTo(value=GroovyContext.class,strategy=1)
                        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.

See put(String, ratpack.handling.Handler) for more details.

Parameters:

path - the relative path to match on

handler - the handler to delegate to

Returns:

this GroovyChain

put

default GroovyChain put(@DelegatesTo(value=GroovyContext.class,strategy=1)
                        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.

See put(ratpack.handling.Handler) for more details.

Parameters:

handler - the handler to delegate to

Returns:

this GroovyChain

redirect

default GroovyChain redirect(int code,
                             java.lang.String location)

Specified by:

redirect in interface Chain

register

default GroovyChain register(Registry registry)

Specified by:

register in interface Chain

register

default GroovyChain register(Action<? super RegistrySpec> action)
                      throws java.lang.Exception

Specified by:

register in interface Chain

Throws:

java.lang.Exception

register

default GroovyChain register(Registry registry,
                             Action<? super Chain> action)
                      throws java.lang.Exception

Specified by:

register in interface Chain

Throws:

java.lang.Exception

register

default GroovyChain register(Registry registry,
                             java.lang.Class<? extends Action<? super Chain>> action)
                      throws java.lang.Exception

Specified by:

register in interface Chain

Throws:

java.lang.Exception

register

default GroovyChain register(Action<? super RegistrySpec> registryAction,
                             Action<? super Chain> chainAction)
                      throws java.lang.Exception

Specified by:

register in interface Chain

Throws:

java.lang.Exception

register

default GroovyChain register(Action<? super RegistrySpec> registryAction,
                             java.lang.Class<? extends Action<? super Chain>> action)
                      throws java.lang.Exception

Specified by:

register in interface Chain

Throws:

java.lang.Exception

register

default GroovyChain register(Action<? super RegistrySpec> registryAction,
                             @DelegatesTo(value=GroovyChain.class,strategy=1)
                             Closure<?> handler)
                      throws java.lang.Exception

Throws:

java.lang.Exception

register

default GroovyChain register(Registry registry,
                             @DelegatesTo(value=GroovyChain.class,strategy=1)
                             Closure<?> handlers)
                      throws java.lang.Exception

Throws:

java.lang.Exception

register

default GroovyChain register(@DelegatesTo(value=ratpack.registry.RegistrySpec.class,strategy=1)
                             Closure<?> closure)
                      throws java.lang.Exception

Throws:

java.lang.Exception

when

default GroovyChain when(Predicate<? super Context> test,
                         Action<? super Chain> action)
                  throws java.lang.Exception

Specified by:

when in interface Chain

Throws:

java.lang.Exception

when

default GroovyChain when(Predicate<? super Context> test,
                         java.lang.Class<? extends Action<? super Chain>> action)
                  throws java.lang.Exception

Specified by:

when in interface Chain

Throws:

java.lang.Exception

when

default GroovyChain when(Predicate<? super Context> test,
                         @DelegatesTo(value=GroovyChain.class,strategy=1)
                         Closure<?> handlers)
                  throws java.lang.Exception

Throws:

java.lang.Exception

when

default GroovyChain when(@DelegatesTo(value=GroovyContext.class,strategy=1)
                         Closure<?> test,
                         @DelegatesTo(value=GroovyChain.class,strategy=1)
                         Closure<?> handlers)
                  throws java.lang.Exception

Throws:

java.lang.Exception

when

default GroovyChain when(@DelegatesTo(value=GroovyContext.class,strategy=1)
                         Closure<?> test,
                         Action<? super Chain> chain)
                  throws java.lang.Exception

Throws:

java.lang.Exception

onlyIf

default GroovyChain onlyIf(Predicate<? super Context> test,
                           Handler handler)

Specified by:

onlyIf in interface Chain

onlyIf

default GroovyChain onlyIf(Predicate<? super Context> test,
                           java.lang.Class<? extends Handler> handler)

Specified by:

onlyIf in interface Chain

onlyIf

default GroovyChain onlyIf(Predicate<? super Context> test,
                           @DelegatesTo(value=GroovyContext.class,strategy=1)
                           Closure<?> handler)

onlyIf

default GroovyChain onlyIf(@DelegatesTo(value=GroovyContext.class,strategy=1)
                           Closure<?> test,
                           @DelegatesTo(value=GroovyContext.class,strategy=1)
                           Closure<?> handler)

onlyIf

default GroovyChain onlyIf(@DelegatesTo(value=GroovyContext.class,strategy=1)
                           Closure<?> test,
                           Handler handler)