Package org.apache.struts2.config
Class StrutsXmlConfigurationProvider
java.lang.Object
org.apache.struts2.config.providers.XmlDocConfigurationProvider
org.apache.struts2.config.providers.XmlConfigurationProvider
org.apache.struts2.config.StrutsXmlConfigurationProvider
- All Implemented Interfaces:
ConfigurationProvider,ContainerProvider,PackageProvider
Override Xwork class so we can use an arbitrary config file
-
Field Summary
Fields inherited from class org.apache.struts2.config.providers.XmlConfigurationProvider
fileManagerFields inherited from class org.apache.struts2.config.providers.XmlDocConfigurationProvider
allowlistClasses, configuration, declaredPackages, documents, dtdMappings, objectFactory, providerAllowlist, throwExceptionOnDuplicateBeans, valueSubstitutor -
Constructor Summary
ConstructorsConstructorDescriptionConstructs the Struts configuration provider using the default struts.xml and no ServletContextStrutsXmlConfigurationProvider(String filename) Constructs the configuration provider based on the provided config fileStrutsXmlConfigurationProvider(String filename, jakarta.servlet.ServletContext ctx) Constructs the Struts configuration provider -
Method Summary
Modifier and TypeMethodDescriptionprotected URLfindInFileSystem(String fileName) getConfigurationUrls(String fileName) Look for the configuration file on the classpath and in the file systemvoidLoads the packages for the configuration.booleanOverrides needs reload to ensure it is only checked once per requestvoidregister(ContainerBuilder containerBuilder, LocatableProperties props) Registers beans and properties for the ContainertoString()Methods inherited from class org.apache.struts2.config.providers.XmlConfigurationProvider
equals, getDocs, getFinalDocs, getURLs, hashCode, init, loadConfigurationFiles, parseFile, setFileManagerFactoryMethods inherited from class org.apache.struts2.config.providers.XmlDocConfigurationProvider
addAction, addAllowedMethodsToSet, addPackage, addResultTypes, allowAndLoadClass, buildActionConfig, buildAllowedMethods, buildExceptionMappings, buildInterceptorConfig, buildInterceptorList, buildPackageContext, buildResultConfig, buildResultParams, buildResults, buildResultTypeConfig, destroy, getDtdMappings, guessResultType, iterateChildren, iterateChildrenByTagName, iterateElementChildren, iterateElementChildren, loadClass, loadDefaultActionRef, loadDefaultClassRef, loadDefaultInterceptorRef, loadExtraConfiguration, loadGlobalAllowedMethods, loadGlobalExceptionMappings, loadGlobalResults, loadInterceptors, loadInterceptorStack, loadInterceptorStacks, lookupInterceptorReference, registerBean, registerBeanSelection, registerConstant, registerUnknownHandlerStack, setDtdMappings, setObjectFactory, setProviderAllowlist, setThrowExceptionOnDuplicateBeans, setValueSubstitutor, verifyAction, verifyInterceptor, verifyResultType
-
Constructor Details
-
StrutsXmlConfigurationProvider
public StrutsXmlConfigurationProvider()Constructs the Struts configuration provider using the default struts.xml and no ServletContext -
StrutsXmlConfigurationProvider
Constructs the configuration provider based on the provided config file- Parameters:
filename- file with Struts configuration
-
StrutsXmlConfigurationProvider
Constructs the Struts configuration provider- Parameters:
filename- The filename to look forctx- Our ServletContext
-
-
Method Details
-
register
public void register(ContainerBuilder containerBuilder, LocatableProperties props) throws ConfigurationException Description copied from interface:ContainerProviderRegisters beans and properties for the Container- Specified by:
registerin interfaceContainerProvider- Overrides:
registerin classXmlConfigurationProvider- Parameters:
containerBuilder- The builder to register beans withprops- The properties to register constants with- Throws:
ConfigurationException- If anything goes wrong
-
loadPackages
public void loadPackages()Description copied from interface:PackageProviderLoads the packages for the configuration.- Specified by:
loadPackagesin interfacePackageProvider- Overrides:
loadPackagesin classXmlConfigurationProvider
-
getConfigurationUrls
Look for the configuration file on the classpath and in the file system- Overrides:
getConfigurationUrlsin classXmlConfigurationProvider- Parameters:
fileName- The file name to retrieve- Throws:
IOException- See Also:
-
findInFileSystem
- Throws:
IOException
-
needsReload
public boolean needsReload()Overrides needs reload to ensure it is only checked once per request- Specified by:
needsReloadin interfaceContainerProvider- Specified by:
needsReloadin interfacePackageProvider- Overrides:
needsReloadin classXmlConfigurationProvider- Returns:
- true if the file has been changed since the last time we read it
-
toString
- Overrides:
toStringin classXmlConfigurationProvider
-