Package org.ametys.odf.cdmfr

Class SendCDMfrProcessor

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.cdmfr.AbstractCDMfrProcessor

org.ametys.odf.cdmfr.SendCDMfrProcessor

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

Direct Known Subclasses:

DeleteRemoteProgramProcessor

public class SendCDMfrProcessor
extends AbstractCDMfrProcessor

Processor to send the CDM-fr file

Field Summary

Fields

Modifier and Type	Field	Description
protected CatalogsManager	_catalogsManager	The catalogs manager
static final String	ROLE	The component role.

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

_odfHelper, _sourceResolver

Constructor Summary

Constructors

Constructor	Description
SendCDMfrProcessor()

Method Summary

Modifier and Type	Method	Description
protected Stream<Program>	filterPrograms(Stream<Program> programs)	Filter programs if needed.
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.
void	service(ServiceManager manager)

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

_getCDMfrContent, isActive, processPrograms

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.

_catalogsManager

protected CatalogsManager _catalogsManager

The catalogs manager

Constructor Details

SendCDMfrProcessor

public SendCDMfrProcessor()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractCDMfrProcessor

Throws:

ServiceException

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

filterPrograms

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

Description copied from class: AbstractCDMfrProcessor

Filter programs if needed.

Overrides:

filterPrograms in class AbstractCDMfrProcessor

Parameters:

programs - The programs to filter

Returns:

The filtered programs

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

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

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