001/*
002 * (C) Copyright 2013 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     dmetzler
018 */
019package org.nuxeo.ecm.automation.io.services.enricher;
020
021import java.io.IOException;
022import java.util.List;
023
024import org.codehaus.jackson.JsonGenerationException;
025import org.codehaus.jackson.JsonGenerator;
026
027/**
028 * Expose a way to get contributors to rest entities.
029 *
030 * @since 5.7.3
031 * @deprecated The JSON marshalling was migrated to nuxeo-core-io. An enricher system is also available. See
032 *             org.nuxeo.ecm.core.io.marshallers.json.enrichers.BreadcrumbJsonEnricher for an example. To migrate an
033 *             existing enricher, keep the marshalling code and use it in class implementing
034 *             AbstractJsonEnricher<DocumentModel> (the use of contextual parameters is a bit different but
035 *             compatible / you have to manage the enricher's parameters yourself). Don't forget to contribute to
036 *             service org.nuxeo.ecm.core.io.registry.MarshallerRegistry to register your enricher.
037 */
038@Deprecated
039public interface ContentEnricherService {
040
041    /**
042     * Gets contributors for a category
043     * <p>
044     * Only contributors available in the given context are returned
045     */
046    List<ContentEnricher> getEnrichers(String category, RestEvaluationContext context);
047
048    /**
049     * Write some JSon for a given evaluation context.
050     *
051     * @param jg
052     * @param ec
053     * @throws IOException
054     * @throws JsonGenerationException
055     */
056    void writeContext(JsonGenerator jg, RestEvaluationContext ec) throws JsonGenerationException, IOException;
057
058}