org.ametys.cms.file

Class AbstractGetFilesAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.cms.file.AbstractGetFilesAction

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetExtractionResultFilesAction, GetParameterFileAction, GetTempSkinResourcesAction

public abstract class AbstractGetFilesAction
extends ServiceableAction
implements Contextualizable

Abstract action for getting child files/folders of a local application folder

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_cocoonContext The cocoon context
private SourceResolver	_srcResolver The source resolver

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractGetFilesAction()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	_collection2JsonObject(TraversableSource folder, TraversableSource root) Convert collection to JSON object
protected String	_getRelativePath(TraversableSource root, TraversableSource file) Get the relative path from root directory
protected Map<String,Object>	_resource2JsonObject(TraversableSource file, TraversableSource root) Convert file to JSON object
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
void	contextualize(Context context)
protected abstract String	getRootURI(Request request) Get the URI of root directory such as 'context://WEB-INF/param'
protected boolean	isIgnoredSource(String fileName) Test if the source has to be ignored
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_cocoonContext

protected Context _cocoonContext

The cocoon context

_srcResolver

private SourceResolver _srcResolver

The source resolver

Constructor Detail

AbstractGetFilesAction

public AbstractGetFilesAction()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Specified by:

act in interface Action

Throws:

Exception

getRootURI

protected abstract String getRootURI(Request request)

Get the URI of root directory such as 'context://WEB-INF/param'

Parameters:

request - the request

Returns:

The root URI

isIgnoredSource

protected boolean isIgnoredSource(String fileName)

Test if the source has to be ignored

Parameters:

fileName - The file name

Returns:

true if the source has to be ignored

_collection2JsonObject

protected Map<String,Object> _collection2JsonObject(TraversableSource folder,
                                                    TraversableSource root)

Convert collection to JSON object

Parameters:

folder - the folder

root - the root directory

Returns:

JSON object

_resource2JsonObject

protected Map<String,Object> _resource2JsonObject(TraversableSource file,
                                                  TraversableSource root)

Convert file to JSON object

Parameters:

file - the file

root - the root directory

Returns:

JSON object

_getRelativePath

protected String _getRelativePath(TraversableSource root,
                                  TraversableSource file)

Get the relative path from root directory

Parameters:

root - The root directory

file - The file

Returns:

The relative path