com.technia.tvc.core

Class ActionRegistry

java.lang.Object

com.technia.tvc.core.ActionRegistry

public abstract class ActionRegistry
extends java.lang.Object

The ActionRegistry allows tvc plugins to register custom struts actions and/or struts form beans that has been annotated instead of having to maintain this information in a struts-xml file.

Since:

2013.1.0

Method Summary

Methods

Modifier and Type	Method and Description
static void	registerAction(java.lang.Class<? extends com.technia.tvc.struts.action.Action> c) Registers an action class using annotations.
static void	registerActions(java.lang.Class<? extends com.technia.tvc.struts.action.Action>... clazzes) Convenient method that accepts a variable amount of actions to be registered.
static void	registerForm(java.lang.Class<? extends com.technia.tvc.struts.action.ActionForm> c) Registers an action-form class using annotations.
static void	registerForms(java.lang.Class<? extends com.technia.tvc.struts.action.ActionForm>... clazzes) Convenient method that accepts a variable amount of action form classes to be registered.
static void	registerGlobalForward(java.lang.String name, java.lang.String path, boolean redirect) Registers a global action forward.
static void	registerPackage(java.lang.String packageName, boolean includeSubPackages) Allows registering actions / action forms from a given package.

Methods inherited from class java.lang.Object

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

Method Detail

registerPackage

public static void registerPackage(java.lang.String packageName,
                   boolean includeSubPackages)

Allows registering actions / action forms from a given package.

• NOTE 1: The specified package MUST contain a "package-info" class.
• NOTE 2: The classes found must be annotated using one of the @Mapping, @Mappings or @Form annotations.
• NOTE 3: This method is still experimental and has not been tested on all platforms yet.

Parameters:

packageName - The name of the package, example "com.foo.bar.actions".

includeSubPackages - True if to also scan sub-packages for actions / action forms

Since:

2014.3.0

registerGlobalForward

public static void registerGlobalForward(java.lang.String name,
                         java.lang.String path,
                         boolean redirect)

Registers a global action forward.

Parameters:

name - The name of the global forward

path - The path to the resource.

redirect - True to use client side redirect to the forward page.

Since:

2013.1.0

registerForms

@SafeVarargs
public static void registerForms(java.lang.Class<? extends com.technia.tvc.struts.action.ActionForm>... clazzes)

Convenient method that accepts a variable amount of action form classes to be registered.

This method calls registerForm(Class) for each argument.

Parameters:

clazzes - The classes to be registered

Since:

2013.1.0

registerForm

public static void registerForm(java.lang.Class<? extends com.technia.tvc.struts.action.ActionForm> c)

Registers an action-form class using annotations.

The registration is done via your init method inside your TVCPlugin.

Parameters:

c - The class to be registered.

Throws:

java.lang.NullPointerException - If the class argument is null.

java.lang.IllegalStateException - If you try to register the action outside of your init() method in your TVCPlugin.

Since:

2013.1.0

registerActions

@SafeVarargs
public static void registerActions(java.lang.Class<? extends com.technia.tvc.struts.action.Action>... clazzes)

Convenient method that accepts a variable amount of actions to be registered.

This method calls registerAction(Class) for each argument.

Parameters:

clazzes - The classes to be registered

Since:

2013.1.0

registerAction

public static void registerAction(java.lang.Class<? extends com.technia.tvc.struts.action.Action> c)

Registers an action class using annotations.

The registration is done via your init method inside your TVCPlugin.

Parameters:

c - The class to be registered.

Throws:

java.lang.NullPointerException - If the class argument is null.

java.lang.IllegalStateException - If you try to register the action outside of your init() method in your TVCPlugin.

Since:

2013.1.0