Package org.ametys.plugins.odfsync.generic.scc

Class AbstractMappingHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfsync.generic.scc.AbstractMappingHelper

All Implemented Interfaces:

FileReloader, LogEnabled, PluginAware, Initializable, Component, Configurable, Serviceable

Direct Known Subclasses:

ODFSynchronizingContentOperatorHelper, PegaseSCCMappingHelper

public abstract class AbstractMappingHelper
extends AbstractLogEnabled
implements Component, Serviceable, Configurable, PluginAware, Initializable, FileReloader

Abstract class for reading mapping files in ODF helpers. First look for a project mapping files in WEB-INF/param/odf Then look for the default mapping files in plugin.odf-sync

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected FileReloaderUtils	_fileReloaderUtils	The file reloader utils
protected String	_implementationName	The implementation name
protected SourceResolver	_srcResolver	The source resolver

Constructor Summary

Constructors

Constructor	Description
AbstractMappingHelper()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	_readMapping(String baseUri)	Read the mapping file to convert types.
void	configure(Configuration configuration)
protected abstract I18nizableText	getCacheDescription()	Get the cache description.
protected abstract I18nizableText	getCacheLabel()	Get the cache label.
String	getId(String sourceUrl)	Get an unique ID for this File Reloader
void	initialize()
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
void	updateFile(String sourceUrl, Source source, InputStream is)	Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

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 Details

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_fileReloaderUtils

protected FileReloaderUtils _fileReloaderUtils

The file reloader utils

_implementationName

protected String _implementationName

The implementation name

Constructor Details

AbstractMappingHelper

public AbstractMappingHelper()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_readMapping

protected Map<String,String> _readMapping(String baseUri)
                                   throws Exception

Read the mapping file to convert types.

Parameters:

baseUri - The base uri of the file

Returns:

The mapping

Throws:

Exception - if an exception occurs

updateFile

public void updateFile(String sourceUrl,
 Source source,
 InputStream is)
                throws Exception

Description copied from interface: FileReloader

Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Specified by:

updateFile in interface FileReloader

Parameters:

sourceUrl - the url of the file.

source - the source to read, can be null if no file was read

is - the input stream to read, can be null if no file was read

Throws:

Exception - something went wrong while reading the inputstream

getId

public String getId(String sourceUrl)

Description copied from interface: FileReloader

Get an unique ID for this File Reloader

Specified by:

getId in interface FileReloader

Parameters:

sourceUrl - this is passed as an argument if your class read multiple files. If it reads only one file, the full class name can be a good enough ID

Returns:

an unique ID

getCacheLabel

protected abstract I18nizableText getCacheLabel()

Get the cache label.

Returns:

the cache label

getCacheDescription

protected abstract I18nizableText getCacheDescription()

Get the cache description.

Returns:

the cache description