|Version:||0.6.35 - 21 May 2012|
Returns an overview of all the PSML files within a folder using the specified
An overview is created by parsing every PSML file and extracting the following information from its content:
- Title, using the first
- Summary, using the first
- Properties, using all the
This generator is useful to provide some of the PSML information and properties from a set of PSML files rather than simply uses their file names.
No configuration is required.
The root of the PSML folder can be configured using the global property
bastille.psml.root which can be either an absolute path or a relative path from the global repository.
By default, the PSML root is set to
"psml" which usually corresponds to the
/WEB-INF/psml folder of your Web application.
This generator requires a
path parameter. The path parameter must be a relative path from within the PSML root folder to a PSML file without the extension.
If the path resolves to a location outside the PSML folder, this generator will not load the content.
The top level element is always the requested folder. Its child elements are either sub folders or files within that folder.
<overview folder="[folder name]" base="[folder path]"> <!-- for each PSML file ... --> <entry name="[file name]"> <title>[title]</title> <summary>[summary]</summary> <!-- for each property ... --> <property name="[name]" value="[value]" /> </entry> </file>
Folder does not exists
If the folder cannot be found this generator will simply set the status to
NOT_FOUND and no content.
Missing path parameter
If the path parameter is not specified, this generator will set the status to
BAD_REQUEST and return the following:
<error type="client" message="The parameter 'path' was not specified"/>
<generator class="com.weborganic.bastille.psml.GetFolderOverview" ... > <parameter name="path" value="[path]"/> </generator>