Package org.nuxeo.ecm.web.resources.api

Interface Processor

All Superinterfaces:

Comparable<Processor>, Descriptor

All Known Implementing Classes:

ProcessorDescriptor

public interface Processor
extends Descriptor, Comparable<Processor>

Resource processor.

Since:

7.3

Field Summary

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Method Summary

Modifier and Type	Method	Description
default String	getId()	The descriptor id, descriptors with same id are merged.
String	getName()	Processor name, to be registered as an alias on wro.
int	getOrder()
Class<?>	getTargetProcessorClass()	Returns the target processor class.
List<String>	getTypes()	Flag type markers for processors filtering depending on use cases.
boolean	isEnabled()	Boolean flag controlling enablement of a processor.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove, merge

Method Details

getId

default String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getName

String getName()

Processor name, to be registered as an alias on wro.

isEnabled

boolean isEnabled()

Boolean flag controlling enablement of a processor.

getTypes

List<String> getTypes()

Flag type markers for processors filtering depending on use cases.

getOrder

int getOrder()

getTargetProcessorClass

Class<?> getTargetProcessorClass()

Returns the target processor class.

Does not follow any given interface to avoid adherence to a given processing implementation.