de.tsl2.nano.h5.plugin

Interface INanoPlugin

All Superinterfaces:

de.tsl2.nano.plugin.Plugin

All Known Implementing Classes:

NanoH5UnitPlugin

public interface INanoPlugin
extends de.tsl2.nano.plugin.Plugin

NanoH5 Plugin interface to define an own NanoH5 Application through callbacks invoked on most important entry points. All classpath-implmenetations of this interface will be found by the framework and will be invoked on the instruction points.

At least one implementation should have a main function calling

 Main.startApplication(NanoH5.class, null, args);
 

Each method will be called with parameters, pre-filled and provided by the framework.

To enhance the the Html-Output, see IDOMDecorator.

Version:

$Revision$

Author:

Tom, Thomas Schneider

Method Summary

Modifier and Type	Method and Description
void	actionAfterHandler(de.tsl2.nano.action.IAction<?> action) after running the requested user interaction, you can inspect the action that was called
void	actionBeforeHandler(de.tsl2.nano.action.IAction<?> action) before running the requested user interaction, you can inspect the action that will be called
void	beansGenerated(de.tsl2.nano.persistence.Persistence persistence) do some initializings on the jar-file. the jar-file-name is inside the persistence object
void	configuration(SortedMap<Object,Object> properties, Map<Class<?>,Object> services) change the default properties of the application. see 'environment.xml' for a list of all keys and their defaults
void	databaseGenerated(de.tsl2.nano.persistence.Persistence persistence) do some initializings on the database. the connection-info is inside the persistence object
void	defineBeanDefinition(de.tsl2.nano.bean.def.BeanDefinition<?> beanDef) for each bean type (belonging to an entity class) the default handling can be changed. the output can be found at the presentation directory
void	definePersistence(de.tsl2.nano.persistence.Persistence persistence) before an authentication, the properties for the jpa persistence.xml will be defined.
<PAGE,OUTPUT,T extends de.tsl2.nano.bean.def.IPageBuilder<PAGE,OUTPUT>> T	definePresentationType(T pageBuilder) The Html page-builder defines the creation of each response. you must return an instance of pageBuilder (null will result in errors)!
void	exceptionHandler(Exception ex)
void	onAuthentication(de.tsl2.nano.serviceaccess.IAuthorization auth) do some inspections on authentication.
void	requestHandler(String uri, NanoHTTPD.Method m, Map<String,String> header, Map<String,String> parms, Map<String,String> files) on each new http request, you can inspect and change the header, parameters and files
void	workflowHandler(IBeanNavigator workflow) on creating a new session, the workflow / navigation stack is defined by loading from 'workflow.xml' or if not found by providing all entity beans in a list.

Methods inherited from interface de.tsl2.nano.plugin.Plugin

isEnabled

Method Detail

configuration

void configuration(SortedMap<Object,Object> properties,
                   Map<Class<?>,Object> services)

change the default properties of the application. see 'environment.xml' for a list of all keys and their defaults

onAuthentication

void onAuthentication(de.tsl2.nano.serviceaccess.IAuthorization auth)

do some inspections on authentication. The auth object is pre-filled

definePersistence

void definePersistence(de.tsl2.nano.persistence.Persistence persistence)

before an authentication, the properties for the jpa persistence.xml will be defined. You can change these settings before a new session will be started

databaseGenerated

void databaseGenerated(de.tsl2.nano.persistence.Persistence persistence)

do some initializings on the database. the connection-info is inside the persistence object

beansGenerated

void beansGenerated(de.tsl2.nano.persistence.Persistence persistence)

do some initializings on the jar-file. the jar-file-name is inside the persistence object

definePresentationType

<PAGE,OUTPUT,T extends de.tsl2.nano.bean.def.IPageBuilder<PAGE,OUTPUT>> T definePresentationType(T pageBuilder)

The Html page-builder defines the creation of each response. you must return an instance of pageBuilder (null will result in errors)!

defineBeanDefinition

void defineBeanDefinition(de.tsl2.nano.bean.def.BeanDefinition<?> beanDef)

for each bean type (belonging to an entity class) the default handling can be changed. the output can be found at the presentation directory

actionBeforeHandler

void actionBeforeHandler(de.tsl2.nano.action.IAction<?> action)

before running the requested user interaction, you can inspect the action that will be called

actionAfterHandler

void actionAfterHandler(de.tsl2.nano.action.IAction<?> action)

after running the requested user interaction, you can inspect the action that was called

workflowHandler

void workflowHandler(IBeanNavigator workflow)

on creating a new session, the workflow / navigation stack is defined by loading from 'workflow.xml' or if not found by providing all entity beans in a list. This workflow can be changed by your inspector.

exceptionHandler

void exceptionHandler(Exception ex)

requestHandler

void requestHandler(String uri,
                    NanoHTTPD.Method m,
                    Map<String,String> header,
                    Map<String,String> parms,
                    Map<String,String> files)

on each new http request, you can inspect and change the header, parameters and files