ratpack.groovy.handling

Class GroovyChainAction

java.lang.Object

ratpack.groovy.handling.GroovyChainAction

All Implemented Interfaces:

ratpack.func.Action<ratpack.handling.Chain>, GroovyChain, ratpack.handling.Chain

public abstract class GroovyChainAction
extends java.lang.Object
implements GroovyChain, ratpack.func.Action<ratpack.handling.Chain>

A convenience super class for a standalone implementation of a Action<GroovyChain>.

Subclasses implement the execute() method, and implicitly program against the GroovyChain DSL.

import ratpack.groovy.handling.GroovyChainAction
 import ratpack.groovy.test.embed.GroovyEmbeddedApp

 class Handlers extends GroovyChainAction {
   public void execute() throws Exception {
     path { render "root" }
     prefix("foo") {
       path("bar") { render "foobar" }
     }
   }
 }

 GroovyEmbeddedApp.of {
   handlers new Handlers()
 } test {
   assert getText() == "root"
   assert getText("foo/bar") == "foobar"
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface ratpack.func.Action

ratpack.func.Action.ConditionalSpec<I>

Constructor Summary

Constructors

Constructor and Description
GroovyChainAction()

Method Summary

Modifier and Type	Method and Description
GroovyChain	all(ratpack.handling.Handler handler)
abstract void	execute() Defines the handler chain.
void	execute(ratpack.handling.Chain chain) Invokes execute() while setting the given chain as the implicit receiver.
ratpack.registry.Registry	getRegistry()
ratpack.server.ServerConfig	getServerConfig()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ratpack.groovy.handling.GroovyChain

all, all, chain, delete, delete, delete, delete, delete, delete, files, files, files, fileSystem, fileSystem, fileSystem, from, get, get, get, get, get, get, host, host, host, insert, insert, insert, notFound, onlyIf, onlyIf, onlyIf, onlyIf, onlyIf, onlyIf, options, options, options, options, options, options, patch, patch, patch, patch, patch, patch, path, path, path, path, path, path, post, post, post, post, post, post, prefix, prefix, prefix, put, put, put, put, put, put, redirect, register, register, register, register, register, register, register, register, register, when, when, when, when, when, when, when, when, when, when, when, when, when, when, when, when, when, when

Methods inherited from interface ratpack.handling.Chain

chain, chain

Methods inherited from interface ratpack.func.Action

append, beforeThrow, beforeThrow, conditional, conditional, curry, from, ignoreArg, join, noop, noopIfNull, prepend, suppressAndThrow, throwException, throwException, toConsumer, uncheckedWith, uncheckedWith, when, when, with, with

Constructor Detail

GroovyChainAction

public GroovyChainAction()

Method Detail

execute

public abstract void execute()
                      throws java.lang.Exception

Defines the handler chain.

Throws:

java.lang.Exception - any

execute

public final void execute(ratpack.handling.Chain chain)
                   throws java.lang.Exception

Invokes execute() while setting the given chain as the implicit receiver.

Specified by:

execute in interface ratpack.func.Action<ratpack.handling.Chain>

Parameters:

chain - the handler chain

Throws:

java.lang.Exception - any

all

public GroovyChain all(ratpack.handling.Handler handler)

Specified by:

all in interface GroovyChain

Specified by:

all in interface ratpack.handling.Chain

getServerConfig

public ratpack.server.ServerConfig getServerConfig()

Specified by:

getServerConfig in interface ratpack.handling.Chain

getRegistry

public ratpack.registry.Registry getRegistry()
                                      throws java.lang.IllegalStateException

Specified by:

getRegistry in interface ratpack.handling.Chain

Throws:

java.lang.IllegalStateException