jodd.madvoc.component

Class ActionsManager

java.lang.Object

jodd.madvoc.component.ActionsManager

Direct Known Subclasses:

ProxettaAwareActionsManager

public class ActionsManager
extends java.lang.Object

Manages all Madvoc action and aliases registrations.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionMethodParser	actionMethodParser
protected int	actionsCount
protected boolean	asyncMode
protected boolean	detectDuplicatePathsEnabled
protected java.util.Map<java.lang.String,java.lang.String>	pathAliases
protected java.lang.String[]	pathExtensionsToStrip
protected java.lang.Class<? extends PathMacros>	pathMacroClass
protected java.lang.String[]	pathMacroSeparators
protected Routes	routes
protected java.util.HashMap<java.lang.String,ActionRuntime>	runtimes
protected boolean	strictRoutePaths

Constructor Summary

Constructors

Constructor and Description
ActionsManager()

Method Summary

Modifier and Type	Method and Description
int	getActionsCount() Returns total number of registered actions.
java.util.List<ActionRuntime>	getAllActionRuntimes() Returns all registered action runtime configurations.
java.util.Map<java.lang.String,java.lang.String>	getAllAliases()
java.lang.String[]	getPathExtensionsToStrip()
java.lang.Class<? extends PathMacros>	getPathMacroClass() Returns current implementation for path macros.
java.lang.String[]	getPathMacroSeparators()
boolean	isAsyncModeOn() Returns true if at least one action has async mode turned on.
boolean	isDetectDuplicatePathsEnabled()
boolean	isStrictRoutePaths()
ActionRuntime	lookup(java.lang.String actionString) Lookups action runtime config for given action class and method string (aka 'action string').
ActionRuntime	lookup(java.lang.String method, java.lang.String[] actionPath)
java.lang.String	lookupPathAlias(java.lang.String alias) Returns path alias.
ActionRuntime	registerAction(java.lang.Class actionClass, java.lang.reflect.Method actionMethod, ActionDefinition actionDefinition) Registration main point.
ActionRuntime	registerAction(java.lang.Class actionClass, java.lang.String actionMethodName, ActionDefinition actionDefinition) Registers action with provided action class and method name.
ActionRuntime	registerActionRuntime(ActionRuntime actionRuntime) Registers manually created action runtime configurations.
void	registerPathAlias(java.lang.String alias, java.lang.String path) Registers new path alias.
java.lang.reflect.Method	resolveActionMethod(java.lang.Class<?> actionClass, java.lang.String methodName) Resolves action method for given action class ane method name.
void	setDetectDuplicatePathsEnabled(boolean detectDuplicatePathsEnabled)
void	setPathExtensionsToStrip(java.lang.String... pathExtensionsToStrip)
void	setPathMacroClass(java.lang.Class<? extends PathMacros> pathMacroClass) Sets implementation for path macros.
void	setPathMacroSeparators(java.lang.String... pathMacroSeparators) Sets path macro separators.
void	setStrictRoutePaths(boolean strictRoutePaths) Defines if the router should trim parts of the path to match the action path.

Methods inherited from class java.lang.Object

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

Field Detail

actionMethodParser

@PetiteInject
protected ActionMethodParser actionMethodParser

actionsCount

protected int actionsCount

asyncMode

protected boolean asyncMode

routes

protected final Routes routes

runtimes

protected final java.util.HashMap<java.lang.String,ActionRuntime> runtimes

pathAliases

protected java.util.Map<java.lang.String,java.lang.String> pathAliases

detectDuplicatePathsEnabled

protected boolean detectDuplicatePathsEnabled

pathMacroClass

protected java.lang.Class<? extends PathMacros> pathMacroClass

pathMacroSeparators

protected java.lang.String[] pathMacroSeparators

strictRoutePaths

protected boolean strictRoutePaths

pathExtensionsToStrip

protected java.lang.String[] pathExtensionsToStrip

Constructor Detail

ActionsManager

public ActionsManager()

Method Detail

getAllActionRuntimes

public java.util.List<ActionRuntime> getAllActionRuntimes()

Returns all registered action runtime configurations. Returned list is a join of action paths with and without the macro.

getAllAliases

public java.util.Map<java.lang.String,java.lang.String> getAllAliases()

getActionsCount

public int getActionsCount()

Returns total number of registered actions.

isAsyncModeOn

public boolean isAsyncModeOn()

Returns true if at least one action has async mode turned on.

resolveActionMethod

public java.lang.reflect.Method resolveActionMethod(java.lang.Class<?> actionClass,
                                                    java.lang.String methodName)

Resolves action method for given action class ane method name.

registerAction

public ActionRuntime registerAction(java.lang.Class actionClass,
                                    java.lang.String actionMethodName,
                                    ActionDefinition actionDefinition)

Registers action with provided action class and method name.

See Also:

registerAction(Class, Method, ActionDefinition)

registerAction

public ActionRuntime registerAction(java.lang.Class actionClass,
                                    java.lang.reflect.Method actionMethod,
                                    ActionDefinition actionDefinition)

Registration main point. Does two things:

• parse action and creates ActionRuntime
• registers created ActionRuntime

Returns created ActionRuntime.

See Also:

registerActionRuntime(ActionRuntime)

registerActionRuntime

public ActionRuntime registerActionRuntime(ActionRuntime actionRuntime)

Registers manually created action runtime configurations. Optionally, if action path with the same name already exist, exception will be thrown.

lookup

public ActionRuntime lookup(java.lang.String method,
                            java.lang.String[] actionPath)

lookup

public ActionRuntime lookup(java.lang.String actionString)

Lookups action runtime config for given action class and method string (aka 'action string'). The action string has the following format: className#methodName.

See Also:

ActionRuntime.createActionString()

registerPathAlias

public void registerPathAlias(java.lang.String alias,
                              java.lang.String path)

Registers new path alias.

lookupPathAlias

public java.lang.String lookupPathAlias(java.lang.String alias)

Returns path alias.

getPathMacroClass

public java.lang.Class<? extends PathMacros> getPathMacroClass()

Returns current implementation for path macros.

setPathMacroClass

public void setPathMacroClass(java.lang.Class<? extends PathMacros> pathMacroClass)

Sets implementation for path macros.

getPathMacroSeparators

public java.lang.String[] getPathMacroSeparators()

setPathMacroSeparators

public void setPathMacroSeparators(java.lang.String... pathMacroSeparators)

Sets path macro separators.

isDetectDuplicatePathsEnabled

public boolean isDetectDuplicatePathsEnabled()

setDetectDuplicatePathsEnabled

public void setDetectDuplicatePathsEnabled(boolean detectDuplicatePathsEnabled)

isStrictRoutePaths

public boolean isStrictRoutePaths()

setStrictRoutePaths

public void setStrictRoutePaths(boolean strictRoutePaths)

Defines if the router should trim parts of the path to match the action path.

getPathExtensionsToStrip

public java.lang.String[] getPathExtensionsToStrip()

setPathExtensionsToStrip

public void setPathExtensionsToStrip(java.lang.String... pathExtensionsToStrip)