001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017package org.nuxeo.ecm.web.resources.api;
018
019import java.util.List;
020
021/**
022 * Resource processor.
023 *
024 * @since 7.3
025 */
026public interface Processor extends Comparable<Processor> {
027
028    /**
029     * Processor name, to be registered as an alias on wro.
030     */
031    String getName();
032
033    /**
034     * Boolean flag controlling enablement of a processor.
035     */
036    boolean isEnabled();
037
038    /**
039     * Flag type markers for processors filtering depending on use cases.
040     */
041    List<String> getTypes();
042
043    int getOrder();
044
045    /**
046     * Returns the target processor class.
047     * <p>
048     * Does not follow any given interface to avoid adherence to a given processing implementation.
049     */
050    Class<?> getTargetProcessorClass();
051
052}