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

static class

MadvocConfig.AttrNames

Field Summary

protected java.lang.Class<? extends java.lang.annotation.Annotation>[]	actionAnnotations
protected boolean	actionPathMappingEnabled
protected MadvocConfig.AttrNames	attrNames
protected boolean	createDefaultAliases
protected java.lang.String[]	defaultActionMethodNames
protected java.lang.String	defaultExtension
protected java.lang.Class<? extends ActionInterceptor>[]	defaultInterceptors
protected java.lang.String	defaultResultType
protected boolean	detectDuplicatePathsEnabled
protected java.lang.String	encoding
protected jodd.servlet.upload.FileUploadFactory	fileUploadFactory
protected java.util.Map<java.lang.String,java.lang.String>	pathAliases
protected boolean	preventCaching
protected RequestScopeInjector.Config	requestScopeInjectorConfig
protected java.lang.String	rootPackage
protected boolean	strictExtensionStripForResultPath
protected java.lang.Class	supplementAction

Constructor Summary

MadvocConfig()

Method Summary

void	disableSupplementAction() Disable supplement actions.
ActionAnnotation<?>[]	getActionAnnotationInstances() Returns instances of action method annotation readers.
java.lang.Class<? extends java.lang.annotation.Annotation>[]	getActionAnnotations()
MadvocConfig.AttrNames	getAttrNames() Returns various servlet attribute names.
java.lang.String[]	getDefaultActionMethodNames() Returns default action method names which will have empty method path.
java.lang.String	getDefaultExtension() Returns default action extension.
java.lang.Class<? extends ActionInterceptor>[]	getDefaultInterceptors() Returns default interceptors.
java.lang.String	getDefaultResultType() Returns default action result type.
java.lang.String	getEncoding() Returns character encoding.
jodd.servlet.upload.FileUploadFactory	getFileUploadFactory() Returns file upload factory.
RequestScopeInjector.Config	getRequestScopeInjectorConfig()
java.lang.String	getRootPackage() Returns root package.
java.lang.Class	getSupplementAction() Returns supplement action class for action requests that are not registered explicitly.
boolean	isActionPathMappingEnabled()
boolean	isCreateDefaultAliases()
boolean	isDetectDuplicatePathsEnabled()
boolean	isPreventCaching()
boolean	isStrictExtensionStripForResultPath()
java.lang.String	lookupPathAlias(java.lang.String alias) Returns path alias.
void	registerPathAlias(java.lang.String alias, java.lang.String path) Registers new path alias.
void	setActionAnnotations(java.lang.Class<? extends java.lang.annotation.Annotation>... actionAnnotations) Sets action annotations.
void	setActionPathMappingEnabled(boolean actionPathMappingEnabled)
void	setAttrNamePrefix(java.lang.String servletAttrNamePrefix) Sets the servlet attribute name prefix used in various places.
void	setCreateDefaultAliases(boolean createDefaultAliases) Specifies if default aliases should be created for all action paths.
void	setDefaultActionMethodNames(java.lang.String... defaultActionMethodNames) Specifies default action names that do not have method paths.
void	setDefaultExtension(java.lang.String defaultExtension) Sets default action extension that will be appended when omitted.
void	setDefaultInterceptors(java.lang.Class<? extends ActionInterceptor>... defaultInterceptors) Set default interceptors.
void	setDefaultResultType(java.lang.String type) Specifies default result type.
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.servlet.upload.FileUploadFactory fileUploadFactory) Specifies file upload factory.
void	setPreventCaching(boolean preventCaching) Specifies if Madvoc should add response params to prevent browser caching.
void	setRequestScopeInjectorConfig(RequestScopeInjector.Config requestScopeInjectorConfig) Sets request scope injector configuration.
void	setRootPackage(java.lang.String rootPackage) Sets root package.
void	setRootPackageOf(java.lang.Class clazz) Sets root package equals to package of provided class.
void	setStrictExtensionStripForResultPath(boolean strictExtensionStripForResultPath) Specifies if action path extension should be stripped only if it is equal to defined one, during result path creation.
void	setSupplementAction(java.lang.Class supplementAction) Specifies new supplement action.

Methods inherited from class java.lang.Object

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

Field Detail

actionAnnotations

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

encoding

protected java.lang.String encoding

fileUploadFactory

protected jodd.servlet.upload.FileUploadFactory fileUploadFactory

defaultExtension

protected java.lang.String defaultExtension

defaultActionMethodNames

protected java.lang.String[] defaultActionMethodNames

defaultInterceptors

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

defaultResultType

protected java.lang.String defaultResultType

pathAliases

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

createDefaultAliases

protected boolean createDefaultAliases

supplementAction

protected java.lang.Class supplementAction

rootPackage

protected java.lang.String rootPackage

detectDuplicatePathsEnabled

protected boolean detectDuplicatePathsEnabled

actionPathMappingEnabled

protected boolean actionPathMappingEnabled

preventCaching

protected boolean preventCaching

requestScopeInjectorConfig

protected RequestScopeInjector.Config requestScopeInjectorConfig

strictExtensionStripForResultPath

protected boolean strictExtensionStripForResultPath

attrNames

protected MadvocConfig.AttrNames attrNames

Constructor Detail

MadvocConfig

public MadvocConfig()

Method Detail

getActionAnnotations

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

setActionAnnotations

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

Sets action annotations.

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.

getFileUploadFactory

public jodd.servlet.upload.FileUploadFactory getFileUploadFactory()

Returns file upload factory.

setFileUploadFactory

public void setFileUploadFactory(jodd.servlet.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.

getDefaultInterceptors

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

Returns default interceptors.

setDefaultInterceptors

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

Set default interceptors.

setDefaultResultType

public void setDefaultResultType(java.lang.String type)

Specifies default result type.

getDefaultResultType

public java.lang.String getDefaultResultType()

Returns default action result type.

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.

isCreateDefaultAliases

public boolean isCreateDefaultAliases()

setCreateDefaultAliases

public void setCreateDefaultAliases(boolean createDefaultAliases)

Specifies if default aliases should be created for all action paths.

getSupplementAction

public java.lang.Class getSupplementAction()

Returns supplement action class for action requests that are not registered explicitly.

setSupplementAction

public void setSupplementAction(java.lang.Class supplementAction)

Specifies new supplement action. If set to null supplement actions will not be used.

disableSupplementAction

public void disableSupplementAction()

Disable supplement actions.

getRootPackage

public java.lang.String getRootPackage()

Returns root package.

setRootPackage

public void setRootPackage(java.lang.String rootPackage)

Sets root package.

setRootPackageOf

public void setRootPackageOf(java.lang.Class clazz)

Sets root package equals to package of provided class.

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.

isActionPathMappingEnabled

public boolean isActionPathMappingEnabled()

setActionPathMappingEnabled

public void setActionPathMappingEnabled(boolean actionPathMappingEnabled)

isPreventCaching

public boolean isPreventCaching()

setPreventCaching

public void setPreventCaching(boolean preventCaching)

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

getRequestScopeInjectorConfig

public RequestScopeInjector.Config getRequestScopeInjectorConfig()

setRequestScopeInjectorConfig

public void setRequestScopeInjectorConfig(RequestScopeInjector.Config requestScopeInjectorConfig)

Sets request scope injector configuration.

isStrictExtensionStripForResultPath

public boolean isStrictExtensionStripForResultPath()

setStrictExtensionStripForResultPath

public void setStrictExtensionStripForResultPath(boolean strictExtensionStripForResultPath)

Specifies if action path extension should be stripped only if it is equal to defined one, during result path creation.

getAttrNames

public MadvocConfig.AttrNames getAttrNames()

Returns various servlet attribute names.

setAttrNamePrefix

public void setAttrNamePrefix(java.lang.String servletAttrNamePrefix)

Sets the servlet attribute name prefix used in various places.