Package org.ametys.odf.cdmfr

Class CDMFRHandler

java.lang.Object

org.ametys.odf.cdmfr.CDMFRHandler

All Implemented Interfaces:

Component, Contextualizable, Serviceable

public class CDMFRHandler
extends Object
implements Component, Serviceable, Contextualizable

CDM-fr handler to deposit or send CDM-fr

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context
protected DepositCDMfrProcessor	_depositCDMfrProcessor	The deposit CDM-fr processor
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected SendCDMfrProcessor	_sendCDMfrProcessor	The send CDM-fr processor
static final String	ROLE	The component role.
static final String	SUSPEND_CDMFR	Key to get if the CDM-fr observer is suspended

Constructor Summary

Constructors

Constructor	Description
CDMFRHandler()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Set<Program>	getProgramParents(Content content)	Get the program parents for CDM-fr treatment
void	handleCDMFR(List<ModifiableContent> contents)	Handle CDM-fr for the given contents
boolean	isSuspended()	true if the CDM-fr observer is suspended
boolean	needToHandle()	Check if at least one of the external CDM-fr actions is active.
void	service(ServiceManager manager)
void	suspendCDMFRObserver()	Suspend CDM-fr observers.
void	unsuspendCDMFRObserver(Set<String> waitingContentIds)	Unsuspend CDM-fr observers.

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.

SUSPEND_CDMFR

public static final String SUSPEND_CDMFR

Key to get if the CDM-fr observer is suspended

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_sendCDMfrProcessor

protected SendCDMfrProcessor _sendCDMfrProcessor

The send CDM-fr processor

_depositCDMfrProcessor

protected DepositCDMfrProcessor _depositCDMfrProcessor

The deposit CDM-fr processor

_context

protected Context _context

The context

Constructor Details

CDMFRHandler

public CDMFRHandler()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

needToHandle

public boolean needToHandle()

Check if at least one of the external CDM-fr actions is active.

Returns:

true if one of the action is active and the handler is useful

handleCDMFR

public void handleCDMFR(List<ModifiableContent> contents)

Handle CDM-fr for the given contents

Parameters:

contents - the list of contents

getProgramParents

public Set<Program> getProgramParents(Content content)

Get the program parents for CDM-fr treatment

Parameters:

content - the content

Returns:

the set of program parents

isSuspended

public boolean isSuspended()

true if the CDM-fr observer is suspended

Returns:

true if the CDM-fr observer is suspended

suspendCDMFRObserver

public void suspendCDMFRObserver()

Suspend CDM-fr observers. If you call this method, the unsuspendCDMFRObserver(Set) method should be call at the end of you treatments.

unsuspendCDMFRObserver

public void unsuspendCDMFRObserver(Set<String> waitingContentIds)

Unsuspend CDM-fr observers. You can give content identifiers to the method to be handled.

Parameters:

waitingContentIds - The collection of content identifiers waiting to be handle, can be null