Package org.ametys.odf.cdmfr

Class DepositCDMfrProcessor

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.cdmfr.AbstractCDMfrProcessor

org.ametys.odf.cdmfr.DepositCDMfrProcessor

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class DepositCDMfrProcessor
extends AbstractCDMfrProcessor

Processor to deposit the CDM-fr file

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.

Fields inherited from class org.ametys.odf.cdmfr.AbstractCDMfrProcessor

_odfHelper, _sourceResolver

Constructor Summary

Constructors

Constructor	Description
DepositCDMfrProcessor()

Method Summary

Modifier and Type	Method	Description
protected String	getConfigActiveParam()	Get the configuration parameter name to determine if the process is active.
protected String	getErrorMessage()	Get the error message if process fails.
void	initialize()
protected boolean	isCDMfrForAmetys()	true to generate CDM-fr for another Ametys, false otherwise.
protected void	processProgram(Program program, InputStream cdmfrContent)	Process the program and its CDM-fr input stream.

Methods inherited from class org.ametys.odf.cdmfr.AbstractCDMfrProcessor

_getCDMfrContent, filterPrograms, isActive, processPrograms, service

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

ROLE

public static final String ROLE

The component role.

Constructor Details

DepositCDMfrProcessor

public DepositCDMfrProcessor()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractCDMfrProcessor

Throws:

Exception

getConfigActiveParam

protected String getConfigActiveParam()

Description copied from class: AbstractCDMfrProcessor

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

Specified by:

getConfigActiveParam in class AbstractCDMfrProcessor

Returns:

The configuration parameter name

processProgram

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

Description copied from class: AbstractCDMfrProcessor

Process the program and its CDM-fr input stream.

Specified by:

processProgram in class AbstractCDMfrProcessor

Parameters:

program - The program

cdmfrContent - The CDM-fr content as InputStream

Throws:

IOException - if an exception occurs

isCDMfrForAmetys

protected boolean isCDMfrForAmetys()

Description copied from class: AbstractCDMfrProcessor

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

Specified by:

isCDMfrForAmetys in class AbstractCDMfrProcessor

Returns:

true to generate CDM-fr for another Ametys instance

getErrorMessage

protected String getErrorMessage()

Description copied from class: AbstractCDMfrProcessor

Get the error message if process fails.

Specified by:

getErrorMessage in class AbstractCDMfrProcessor

Returns:

the error message