act.plugin

Class ControllerPlugin

java.lang.Object

act.plugin.ControllerPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

ControllerPlugin.Manager

public abstract class ControllerPlugin
extends Object
implements Plugin

allows plugin different controller annotations framework, e.g. JAX-RS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerPlugin.Manager
static class	ControllerPlugin.PathAnnotationSpec

Nested classes/interfaces inherited from interface act.plugin.Plugin

Plugin.InfoRepo

Constructor Summary

Constructors

Constructor and Description
ControllerPlugin()

Method Summary

Modifier and Type	Method and Description
org.osgl.Lang.Func2<org.osgl.mvc.result.Result,ActionContext,org.osgl.mvc.result.Result>	afterHandler(Class<?> controllerClass, Method actionMethod) Returns function that takes Result and ActionContext as parameter and returns a Result.
protected abstract Map<Class<? extends Annotation>,org.osgl.http.H.Method>	annotationMethodLookup()
org.osgl.Lang.Function<ActionContext,org.osgl.mvc.result.Result>	beforeHandler(Class<?> controllerClass, Method actionMethod) Returns function that takes ActionContext as parameter and returns a Result.
protected abstract boolean	noDefaultPath()
void	register()
protected abstract ControllerPlugin.PathAnnotationSpec	urlContextAnnotation()

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerPlugin

public ControllerPlugin()

Method Detail

annotationMethodLookup

protected abstract Map<Class<? extends Annotation>,org.osgl.http.H.Method> annotationMethodLookup()

urlContextAnnotation

protected abstract ControllerPlugin.PathAnnotationSpec urlContextAnnotation()

noDefaultPath

protected abstract boolean noDefaultPath()

beforeHandler

public org.osgl.Lang.Function<ActionContext,org.osgl.mvc.result.Result> beforeHandler(Class<?> controllerClass,
                                                                                      Method actionMethod)

Returns function that takes ActionContext as parameter and returns a Result. If a non-null result is returned, then it will by pass the ActFramework handling process and return directly, in which case the plugin literally hijack the ActFramework handling process.

The plugin might also do some changes to ActionContext and return null value in which case ActFramework normal handling process still happens.

Parameters:

controllerClass - the controller class

actionMethod - the action method

Returns:

a logic to be injected before ActFramework handling request

afterHandler

public org.osgl.Lang.Func2<org.osgl.mvc.result.Result,ActionContext,org.osgl.mvc.result.Result> afterHandler(Class<?> controllerClass,
                                                                                                             Method actionMethod)

Returns function that takes Result and ActionContext as parameter and returns a Result. This function is called after ActFramework’s processing has finished.

The afterHandler allows plugin to inject logic to further process the returned result or do some updates to ActionContext for example to change the response content type etc.

The afterHandler shall always returns a result even if there is nothing to do with it, it must return the result passed in.

Parameters:

controllerClass - the controller class

actionMethod - the action method

Returns:

a logic to be injected before ActFramework handling request

register

public void register()

Specified by:

register in interface Plugin