Package com.zfabrik.util.microweb.actions

Class OutCome

java.lang.Object

com.zfabrik.util.microweb.actions.OutCome

Direct Known Subclasses:

OutCome.Decorate, OutCome.Delegate, OutCome.Done, OutCome.Error, OutCome.Forward, OutCome.GoTo, OutCome.Include, OutCome.PassThrough, OutCome.Redirect

public abstract class OutCome
extends Object

Representation of an OutCome of an action. OutCome's describe how to proceed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OutCome.Decorate
static final class	OutCome.Delegate
static final class	OutCome.Done
static final class	OutCome.Error
static final class	OutCome.Forward
static final class	OutCome.GoTo
static final class	OutCome.Include
static final class	OutCome.PassThrough
static final class	OutCome.Redirect

Constructor Summary

Constructors

Constructor	Description
OutCome()

Method Summary

Modifier and Type	Method	Description
abstract void	apply(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
static OutCome	decorate(String decorator, String target)	implies a decoration of a forward target
static OutCome	decorate(String decorator, String prefix, String target)
static OutCome	delegate(IAction action)	wraps another actions and makes sure there is no security
static OutCome	done()
static OutCome	done(int sc)
static OutCome	error(int sc)	Used to return with a status code.
static OutCome	error(int sc, String message)
static OutCome	forward(String target)	implies a direct forward
static OutCome	forward(String prefix, String target)
static OutCome	goTo(String target)	implies an internal forward, going through the engine again
static OutCome	include(String target)	implies an include
static OutCome	include(String prefix, String target)
static OutCome	passThrough()	implies by-passing of the Microweb filter and continue with the filter chain
static OutCome	redirect(String target)	implies a direct redirect, without going through the engine again

Methods inherited from class java.lang.Object

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

Constructor Details

OutCome

public OutCome()

Method Details

passThrough

public static OutCome passThrough()

implies by-passing of the Microweb filter and continue with the filter chain

forward

public static OutCome forward(String target)

implies a direct forward

Parameters:

target -

Returns:

forward

public static OutCome forward(String prefix,
 String target)

include

public static OutCome include(String target)

implies an include

Parameters:

target -

Returns:

include

public static OutCome include(String prefix,
 String target)

decorate

public static OutCome decorate(String decorator,
 String target)

implies a decoration of a forward target

decorate

public static OutCome decorate(String decorator,
 String prefix,
 String target)

error

public static OutCome error(int sc)

Used to return with a status code.

error

public static OutCome error(int sc,
 String message)

done

public static OutCome done()

done

public static OutCome done(int sc)

redirect

public static OutCome redirect(String target)

implies a direct redirect, without going through the engine again

Parameters:

target -

Returns:

goTo

public static OutCome goTo(String target)

implies an internal forward, going through the engine again

Parameters:

target -

Returns:

delegate

public static OutCome delegate(IAction action)

wraps another actions and makes sure there is no security

apply

public abstract void apply(jakarta.servlet.ServletContext context,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                    throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException