Package org.ametys.odf.cdmfr

Class AbstractCDMfrProcessor

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.cdmfr.AbstractCDMfrProcessor

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

Direct Known Subclasses:

DepositCDMfrProcessor, SendCDMfrProcessor

public abstract class AbstractCDMfrProcessor
extends AbstractLogEnabled
implements Component, Serviceable, Initializable

Processor to process CDM-fr files. - Filter programs if need - Iterate on programs - Generate the CDM-fr file - Process on the CDM-fr file

Field Summary

Fields

Modifier and Type	Field	Description
protected ODFHelper	_odfHelper	The ODF helper
protected SourceResolver	_sourceResolver	The source resolver

Constructor Summary

Constructors

Constructor	Description
AbstractCDMfrProcessor()

Method Summary

Modifier and Type	Method	Description
protected InputStream	_getCDMfrContent(Program program)	Get the CDM-fr of the current program.
protected Stream<Program>	filterPrograms(Stream<Program> programs)	Filter programs if needed.
protected abstract String	getConfigActiveParam()	Get the configuration parameter name to determine if the process is active.
protected abstract String	getErrorMessage()	Get the error message if process fails.
void	initialize()
boolean	isActive()	true if the process is active
protected abstract boolean	isCDMfrForAmetys()	true to generate CDM-fr for another Ametys, false otherwise.
protected abstract void	processProgram(Program program, InputStream cdmfrContent)	Process the program and its CDM-fr input stream.
void	processPrograms(Set<Program> programs)	Process the CDM-fr of the given programs.
void	service(ServiceManager manager)

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

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

Constructor Details

AbstractCDMfrProcessor

public AbstractCDMfrProcessor()

Method Details

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

getConfigActiveParam

protected abstract String getConfigActiveParam()

Get the configuration parameter name to determine if the process is active.

Returns:

The configuration parameter name

isActive

public boolean isActive()

true if the process is active

Returns:

true if the process is active

processPrograms

public void processPrograms(Set<Program> programs)

Process the CDM-fr of the given programs.

Parameters:

programs - The programs to process

processProgram

protected abstract void processProgram(Program program,
 InputStream cdmfrContent)
                                throws IOException

Process the program and its CDM-fr input stream.

Parameters:

program - The program

cdmfrContent - The CDM-fr content as InputStream

Throws:

IOException - if an exception occurs

getErrorMessage

protected abstract String getErrorMessage()

Get the error message if process fails.

Returns:

the error message

filterPrograms

protected Stream<Program> filterPrograms(Stream<Program> programs)

Filter programs if needed.

Parameters:

programs - The programs to filter

Returns:

The filtered programs

_getCDMfrContent

protected InputStream _getCDMfrContent(Program program)
                                throws IOException

Get the CDM-fr of the current program.

Parameters:

program - The program to export as CDM-fr

Returns:

The InputStream with the CDM-fr content

Throws:

IOException - if an exception occurs

isCDMfrForAmetys

protected abstract boolean isCDMfrForAmetys()

true to generate CDM-fr for another Ametys, false otherwise.

Returns:

true to generate CDM-fr for another Ametys instance