jodd.madvoc.component

Class MadvocConfig

java.lang.Object

jodd.madvoc.component.MadvocConfig

public class MadvocConfig
extends java.lang.Object

Madvoc configuration. This is the single place where component configuration is stored. New custom component that requires configuration may override and enhance this config with new configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MadvocConfig.AsyncConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<? extends java.lang.annotation.Annotation>[]	actionAnnotations
protected boolean	applyCharacterEncoding
protected MadvocConfig.AsyncConfig	asyncConfig
protected java.lang.String	attributeMoveId
protected java.lang.String[]	defaultActionMethodNames
protected java.lang.Class<? extends ActionResult>	defaultActionResult
protected java.lang.String	defaultExtension
protected java.lang.Class<? extends ActionFilter>[]	defaultFilters
protected java.lang.Class<? extends ActionInterceptor>[]	defaultInterceptors
protected java.lang.Class<? extends ActionNamingStrategy>	defaultNamingStrategy
protected boolean	detectDuplicatePathsEnabled
protected java.lang.String	encoding
protected jodd.upload.FileUploadFactory	fileUploadFactory
protected java.lang.String	madvocRootPackageClassName
protected java.lang.Class<? extends PathMacros>	pathMacroClass
protected java.lang.String[]	pathMacroSeparators
protected boolean	preventCaching
protected java.lang.String	resultPathPrefix
protected RootPackages	rootPackages
protected java.lang.String	routesFileName

Constructor Summary

Constructors

Constructor and Description
MadvocConfig()

Method Summary

Modifier and Type	Method and Description
ActionAnnotation<?>[]	getActionAnnotationInstances() Returns instances of action method annotation readers.
java.lang.Class<? extends java.lang.annotation.Annotation>[]	getActionAnnotations() Returns array of action annotations.
MadvocConfig.AsyncConfig	getAsyncConfig() Returns asynchronous configuration.
java.lang.String	getAttributeMoveId()
java.lang.String[]	getDefaultActionMethodNames() Returns default action method names which will have empty method path.
java.lang.Class<? extends ActionResult>	getDefaultActionResult() Returns default action result.
java.lang.String	getDefaultExtension() Returns default action extension.
java.lang.Class<? extends ActionFilter>[]	getDefaultFilters() Returns default filters.
java.lang.Class<? extends ActionInterceptor>[]	getDefaultInterceptors() Returns default interceptors.
java.lang.Class<? extends ActionNamingStrategy>	getDefaultNamingStrategy()
java.lang.String	getEncoding() Returns character encoding.
jodd.upload.FileUploadFactory	getFileUploadFactory() Returns file upload factory.
java.lang.String	getMadvocRootPackageClassName() Returns root package marker class name.
java.lang.Class<? extends PathMacros>	getPathMacroClass() Returns current implementation for path macros.
java.lang.String[]	getPathMacroSeparators()
java.lang.String	getResultPathPrefix() Returns default prefix for all result paths.
RootPackages	getRootPackages() Returns root packages collection.
java.lang.String	getRoutesFileName()
boolean	isApplyCharacterEncoding() Returns if character encoding should be set in request and response by Madvoc.
boolean	isDetectDuplicatePathsEnabled()
boolean	isPreventCaching()
void	setActionAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation>... actionAnnotations) Sets action annotations.
void	setApplyCharacterEncoding(boolean applyCharacterEncoding) Defines is character encoding has to be set by Madvoc into the request and response.
void	setAttributeMoveId(java.lang.String attributeMoveId) Sets attribute name for move results.
void	setDefaultActionMethodNames(java.lang.String... defaultActionMethodNames) Specifies default action names that do not have method paths.
void	setDefaultActionResult(java.lang.Class<? extends ActionResult> defaultActionResult) Specifies default action result.
void	setDefaultExtension(java.lang.String defaultExtension) Sets default action extension that will be appended when omitted.
void	setDefaultFilters(java.lang.Class<? extends ActionFilter>[] defaultFilters) Set default filters.
void	setDefaultInterceptors(java.lang.Class<? extends ActionInterceptor>... defaultInterceptors) Set default interceptors.
void	setDefaultNamingStrategy(java.lang.Class<? extends ActionNamingStrategy> defaultNamingStrategy) Specifies default ActionNamingStrategy action naming strategy.
void	setDetectDuplicatePathsEnabled(boolean detectDuplicatePathsEnabled) Defines if duplicate paths should be detected and if an exception should be thrown on duplication.
void	setEncoding(java.lang.String encoding) Sets web application character encoding.
void	setFileUploadFactory(jodd.upload.FileUploadFactory fileUploadFactory) Specifies file upload factory.
void	setMadvocRootPackageClassName(java.lang.String madvocRootPackageClassName) Sets root package marker name.
void	setPathMacroClass(java.lang.Class<? extends PathMacros> pathMacroClass) Sets implementation for path macros.
void	setPathMacroSeparators(java.lang.String[] pathMacroSeparators) Sets path macro separators.
void	setPreventCaching(boolean preventCaching) Specifies if Madvoc should add response params to prevent browser caching.
void	setResultPathPrefix(java.lang.String resultPathPrefix) Defines result path prefix that will be added to all result paths.
void	setRoutesFileName(java.lang.String routesFileName)
java.lang.String	toString() Prepares string with full configuration.

Methods inherited from class java.lang.Object

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

Field Detail

actionAnnotations

protected java.lang.Class<? extends java.lang.annotation.Annotation>[] actionAnnotations

encoding

protected java.lang.String encoding

applyCharacterEncoding

protected boolean applyCharacterEncoding

fileUploadFactory

protected jodd.upload.FileUploadFactory fileUploadFactory

defaultExtension

protected java.lang.String defaultExtension

defaultActionMethodNames

protected java.lang.String[] defaultActionMethodNames

defaultNamingStrategy

protected java.lang.Class<? extends ActionNamingStrategy> defaultNamingStrategy

defaultInterceptors

protected java.lang.Class<? extends ActionInterceptor>[] defaultInterceptors

defaultFilters

protected java.lang.Class<? extends ActionFilter>[] defaultFilters

defaultActionResult

protected java.lang.Class<? extends ActionResult> defaultActionResult

rootPackages

protected RootPackages rootPackages

madvocRootPackageClassName

protected java.lang.String madvocRootPackageClassName

detectDuplicatePathsEnabled

protected boolean detectDuplicatePathsEnabled

preventCaching

protected boolean preventCaching

resultPathPrefix

protected java.lang.String resultPathPrefix

attributeMoveId

protected java.lang.String attributeMoveId

pathMacroClass

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

pathMacroSeparators

protected java.lang.String[] pathMacroSeparators

asyncConfig

protected MadvocConfig.AsyncConfig asyncConfig

routesFileName

protected java.lang.String routesFileName

Constructor Detail

MadvocConfig

public MadvocConfig()

Method Detail

getActionAnnotations

public java.lang.Class<? extends java.lang.annotation.Annotation>[] getActionAnnotations()

Returns array of action annotations.

setActionAnnotations

public void setActionAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation>... actionAnnotations)

Sets action annotations. User may define custom annotations with predefined values.

getActionAnnotationInstances

public ActionAnnotation<?>[] getActionAnnotationInstances()

Returns instances of action method annotation readers.

getEncoding

public java.lang.String getEncoding()

Returns character encoding.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets web application character encoding. If set to null encoding will be not applied.

isApplyCharacterEncoding

public boolean isApplyCharacterEncoding()

Returns if character encoding should be set in request and response by Madvoc.

setApplyCharacterEncoding

public void setApplyCharacterEncoding(boolean applyCharacterEncoding)

Defines is character encoding has to be set by Madvoc into the request and response.

getFileUploadFactory

public jodd.upload.FileUploadFactory getFileUploadFactory()

Returns file upload factory.

setFileUploadFactory

public void setFileUploadFactory(jodd.upload.FileUploadFactory fileUploadFactory)

Specifies file upload factory.

getDefaultExtension

public java.lang.String getDefaultExtension()

Returns default action extension.

setDefaultExtension

public void setDefaultExtension(java.lang.String defaultExtension)

Sets default action extension that will be appended when omitted.

getDefaultActionMethodNames

public java.lang.String[] getDefaultActionMethodNames()

Returns default action method names which will have empty method path.

setDefaultActionMethodNames

public void setDefaultActionMethodNames(java.lang.String... defaultActionMethodNames)

Specifies default action names that do not have method paths.

getDefaultNamingStrategy

public java.lang.Class<? extends ActionNamingStrategy> getDefaultNamingStrategy()

setDefaultNamingStrategy

public void setDefaultNamingStrategy(java.lang.Class<? extends ActionNamingStrategy> defaultNamingStrategy)

Specifies default ActionNamingStrategy action naming strategy.

getDefaultInterceptors

public java.lang.Class<? extends ActionInterceptor>[] getDefaultInterceptors()

Returns default interceptors.

setDefaultInterceptors

public void setDefaultInterceptors(java.lang.Class<? extends ActionInterceptor>... defaultInterceptors)

Set default interceptors.

getDefaultFilters

public java.lang.Class<? extends ActionFilter>[] getDefaultFilters()

Returns default filters.

setDefaultFilters

public void setDefaultFilters(java.lang.Class<? extends ActionFilter>[] defaultFilters)

Set default filters.

setDefaultActionResult

public void setDefaultActionResult(java.lang.Class<? extends ActionResult> defaultActionResult)

Specifies default action result.

getDefaultActionResult

public java.lang.Class<? extends ActionResult> getDefaultActionResult()

Returns default action result.

getRootPackages

public RootPackages getRootPackages()

Returns root packages collection.

getMadvocRootPackageClassName

public java.lang.String getMadvocRootPackageClassName()

Returns root package marker class name. Returns null if these classes should be ignored.

setMadvocRootPackageClassName

public void setMadvocRootPackageClassName(java.lang.String madvocRootPackageClassName)

Sets root package marker name. By setting it to null this feature will be turned off.

isDetectDuplicatePathsEnabled

public boolean isDetectDuplicatePathsEnabled()

setDetectDuplicatePathsEnabled

public void setDetectDuplicatePathsEnabled(boolean detectDuplicatePathsEnabled)

Defines if duplicate paths should be detected and if an exception should be thrown on duplication.

isPreventCaching

public boolean isPreventCaching()

setPreventCaching

public void setPreventCaching(boolean preventCaching)

Specifies if Madvoc should add response params to prevent browser caching.

getResultPathPrefix

public java.lang.String getResultPathPrefix()

Returns default prefix for all result paths. Returns null when not used.

setResultPathPrefix

public void setResultPathPrefix(java.lang.String resultPathPrefix)

Defines result path prefix that will be added to all result paths. If set to null will be ignored.

getAttributeMoveId

public java.lang.String getAttributeMoveId()

setAttributeMoveId

public void setAttributeMoveId(java.lang.String attributeMoveId)

Sets attribute name for move results.

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.

getAsyncConfig

public MadvocConfig.AsyncConfig getAsyncConfig()

Returns asynchronous configuration.

getRoutesFileName

public java.lang.String getRoutesFileName()

setRoutesFileName

public void setRoutesFileName(java.lang.String routesFileName)

toString

public java.lang.String toString()

Prepares string with full configuration.

Overrides:

toString in class java.lang.Object