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 javax.servlet.ServletRequest;
022import javax.ws.rs.core.HttpHeaders;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * Evaluation context from where to get information in order to generate additional JSON.
028 *
029 * @since 5.7.3
030 * @deprecated The JSON marshalling was migrated to nuxeo-core-io. An enricher system is also available. See
031 *             org.nuxeo.ecm.core.io.marshallers.json.enrichers.BreadcrumbJsonEnricher for an example. To migrate an
032 *             existing enricher, keep the marshalling code and use it in class implementing
033 *             AbstractJsonEnricher<DocumentModel> (the use of contextual parameters is a bit different but
034 *             compatible / you have to manage the enricher's parameters yourself). Don't forget to contribute to
035 *             service org.nuxeo.ecm.core.io.registry.MarshallerRegistry to register your enricher.
036 */
037@Deprecated
038public interface RestEvaluationContext {
039
040    /**
041     * Gives the contextual document
042     *
043     * @return
044     */
045    DocumentModel getDocumentModel();
046
047    /**
048     * Returns the request headers. It may be used by contributors to refine their writing strategies.
049     *
050     * @return
051     */
052    HttpHeaders getHeaders();
053
054    /**
055     * Returns the request that is currently served.
056     *
057     * @since 5.9.3
058     */
059    ServletRequest getRequest();
060
061}