org.ametys.core.util.filereloader

Class FileReloaderUtils

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.util.filereloader.FileReloaderUtils

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class FileReloaderUtils
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

a helper to track modification of a configuration file

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	FileReloaderUtils.FileMetadatas

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,FileReloaderUtils.FileMetadatas>	_files
protected SourceResolver	_resolver The source resolver
static String	ROLE The avalon role

Constructor Summary

Constructors

Constructor and Description
FileReloaderUtils()

Method Summary

Modifier and Type	Method and Description
void	initialize()
void	service(ServiceManager manager)
void	updateFile(String sourceUrl, boolean forceRead, FileReloader fileReloader) Request to read/update the file
void	updateFile(String sourceUrl, FileReloader fileReloader) Request to read/update the file
void	updateFile(String sourceUrl, Map parameters, boolean forceRead, FileReloader fileReloader) Request to read/update the file
void	updateFile(String sourceUrl, Map parameters, FileReloader fileReloader) Request to read/update the file

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role

_resolver

protected SourceResolver _resolver

The source resolver

_files

private Map<String,FileReloaderUtils.FileMetadatas> _files

Constructor Detail

FileReloaderUtils

public FileReloaderUtils()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

updateFile

public void updateFile(String sourceUrl,
                       FileReloader fileReloader)
                throws Exception

Request to read/update the file

Parameters:

sourceUrl - url of the file to read

fileReloader - FileReloader that will be called to get an ID and read the file

Throws:

Exception - the source can not be read

updateFile

public void updateFile(String sourceUrl,
                       boolean forceRead,
                       FileReloader fileReloader)
                throws Exception

Request to read/update the file

Parameters:

sourceUrl - url of the file to read

forceRead - true to force reload even if the file was not modified

fileReloader - FileReloader that will be called to get an ID and read the file

Throws:

Exception - the source can not be read

updateFile

public void updateFile(String sourceUrl,
                       Map parameters,
                       FileReloader fileReloader)
                throws Exception

Request to read/update the file

Parameters:

sourceUrl - url of the file to read

parameters - parameters passed to the resolver to get the file via it's url (can be null)

fileReloader - FileReloader that will be called to get an ID and read the file

Throws:

Exception - the source can not be read

updateFile

public void updateFile(String sourceUrl,
                       Map parameters,
                       boolean forceRead,
                       FileReloader fileReloader)
                throws Exception

Request to read/update the file

Parameters:

sourceUrl - url of the file to read

parameters - parameters passed to the resolver to get the file via it's url (can be null)

forceRead - true to force reload even if the file was not modified

fileReloader - FileReloader that will be called to get an ID and read the file

Throws:

Exception - the source can not be read