Package com.aquima.interactions.ds.xml
Class XmlPortalEngineDS
java.lang.Object
com.aquima.interactions.ds.xml.XmlPortalEngineDS
- All Implemented Interfaces:
IPortalEngineDS
Portal engine data source for release 17 Zip files.
- Since:
- 17.1
-
Field Summary
Fields inherited from interface com.aquima.interactions.portal.ds.IPortalEngineDS
CATEGORY
-
Constructor Summary
ConstructorsConstructorDescriptionXmlPortalEngineDS
(IAquimaConfiguration aquimaConfiguration) Constructs the XML data-source with the resource manager that should be used to gather the XML files. -
Method Summary
Modifier and TypeMethodDescriptionThis method should return the default factory manager for the portal engine (required).This method should return the default resource manager for the portal engine (required).getProjectLoader
(ApplicationID id, IInitializationReport report) This method provides the data-source for the specified project.getTimer()
This method should return a time implementation to act on timed events.This method returns the user scope dao that is responsible for storing user specific data across applications and sessionsvoid
iterateApplications
(IApplicationVisitor visitor) This method should invoke the visitor for each application that this data-source can provide.void
void
This method needs to be invoked with the folder of export files before the datasource can be used.
-
Constructor Details
-
XmlPortalEngineDS
Constructs the XML data-source with the resource manager that should be used to gather the XML files.- Parameters:
aquimaConfiguration
- Configuration object that may be used to override default settings.
-
-
Method Details
-
setFolder
This method needs to be invoked with the folder of export files before the datasource can be used.Node: sub folders are also scanned recursively for export files.
- Parameters:
folder
- the root folder that contains the export files.
-
setFiles
-
getDefaultFactoryManager
Description copied from interface:IPortalEngineDS
This method should return the default factory manager for the portal engine (required).- Specified by:
getDefaultFactoryManager
in interfaceIPortalEngineDS
- Returns:
- the default factory manager for the portal engine (required).
-
getDefaultResourceManager
Description copied from interface:IPortalEngineDS
This method should return the default resource manager for the portal engine (required).- Specified by:
getDefaultResourceManager
in interfaceIPortalEngineDS
- Returns:
- the default resource manager for the portal engine (required).
-
getProjectLoader
Description copied from interface:IPortalEngineDS
This method provides the data-source for the specified project.- Specified by:
getProjectLoader
in interfaceIPortalEngineDS
- Parameters:
id
- An identifier of the project for which the data-source is requested.report
- The report that should be used to add initialization messages to.- Returns:
- a new data-source that can provide the data needed to initialize an application.
-
getTimer
Description copied from interface:IPortalEngineDS
This method should return a time implementation to act on timed events.- Specified by:
getTimer
in interfaceIPortalEngineDS
- Returns:
- the timer implementation (required).
-
getUserScopeDao
Description copied from interface:IPortalEngineDS
This method returns the user scope dao that is responsible for storing user specific data across applications and sessions- Specified by:
getUserScopeDao
in interfaceIPortalEngineDS
- Returns:
- The user scope dao, may not be null
-
iterateApplications
Description copied from interface:IPortalEngineDS
This method should invoke the visitor for each application that this data-source can provide.- Specified by:
iterateApplications
in interfaceIPortalEngineDS
- Parameters:
visitor
- Application visitor that can be used to add the available applications to.
-