com.sdl.odata.renderer.xml.XMLErrorResponseRenderer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of odata_renderer Show documentation
Tridion OData Framework Renderer Implementation
The newest version!
/**
 * Copyright (c) 2014-2024 All Rights Reserved by the RWS Group for and on behalf of its affiliates and subsidiaries.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.sdl.odata.renderer.xml;

import com.sdl.odata.api.ODataException;
import com.sdl.odata.api.ODataSystemException;
import com.sdl.odata.api.processor.query.QueryResult;
import com.sdl.odata.api.renderer.ChunkedActionRenderResult;
import com.sdl.odata.api.service.MediaType;
import com.sdl.odata.api.service.ODataRequestContext;
import com.sdl.odata.api.service.ODataResponse;
import com.sdl.odata.renderer.AbstractRenderer;
import com.sdl.odata.renderer.xml.writer.XMLErrorResponseWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.List;

import static com.sdl.odata.api.processor.query.QueryResult.ResultType.EXCEPTION;
import static com.sdl.odata.api.processor.query.QueryResult.ResultType.NOTHING;
import static com.sdl.odata.api.service.HeaderNames.CONTENT_LANGUAGE;
import static com.sdl.odata.api.service.MediaType.ATOM_XML;
import static com.sdl.odata.api.service.MediaType.XML;
import static java.lang.Math.max;
import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.Locale.ENGLISH;

/**
 * Renderer render error responses.
 * Reference: OData Atom Format Version 4.0.
 */
@Component
public class XMLErrorResponseRenderer extends AbstractRenderer {

    private static final Logger LOG = LoggerFactory.getLogger(XMLErrorResponseRenderer.class);

    @Override
    public int score(ODataRequestContext requestContext, QueryResult data) {

        if (data == null || data.getType() == NOTHING || data.getType() != EXCEPTION) {
            return DEFAULT_SCORE;
        }

        // Try the types that should be allowed according to the OData specification
        // See: OData Atom Format Version 4.0, chapter 19: Error Response
        List accept = requestContext.getRequest().getAccept();
        // Accept header score calculation
        int atomXmlAcceptScore = scoreByMediaType(accept, ATOM_XML);
        int xmlAcceptScore = scoreByMediaType(accept, XML);
        int totalAcceptScore = max(atomXmlAcceptScore, xmlAcceptScore);
        // Content type score calculation
        int xmlContentTypeScore = scoreByContentType(requestContext, XML);
        int atomXmlContentTypeScore = scoreByContentType(requestContext, ATOM_XML);
        int totalContentTypeScore = max(xmlContentTypeScore, atomXmlContentTypeScore);

        int totalScore = max(totalAcceptScore, totalContentTypeScore);

        // This is very ugly but if you want to default to XML then score should be little more in case of wildcard
        if (totalScore == WILDCARD_MATCH_SCORE || totalScore == DEFAULT_SCORE) {
            totalScore += PRIORITY_SCORE;
        }

        return totalScore > 0 ? (totalScore + ERROR_EXTRA_SCORE) : DEFAULT_SCORE;
    }

    @Override
    public void render(ODataRequestContext requestContext, QueryResult data, ODataResponse.Builder responseBuilder)
            throws ODataException {

        LOG.debug("Start rendering error response for request: {}", requestContext);

        XMLErrorResponseWriter writer = new XMLErrorResponseWriter();
        writer.startDocument();
        writer.writeError((ODataException) data.getData());
        writer.endDocument();

        try {
            responseBuilder
                    .setContentType(XML)
                    .setHeader("OData-Version", ODATA_VERSION_HEADER)
                    .setHeader(CONTENT_LANGUAGE, ENGLISH.getLanguage())
                    .setBodyText(writer.getXml(), UTF_8.name());
        } catch (UnsupportedEncodingException e) {
            throw new ODataSystemException(e);
        }

        LOG.debug("End rendering error response for request: {}", requestContext);
    }

    @Override
    public ChunkedActionRenderResult renderStart(ODataRequestContext requestContext, QueryResult result,
                                                 OutputStream outputStream) throws ODataException {
        ChunkedActionRenderResult renderResult = super.renderStart(requestContext, result, outputStream);
        renderResult.addHeader("OData-Version", ODATA_VERSION_HEADER);
        renderResult.addHeader(CONTENT_LANGUAGE, ENGLISH.getLanguage());

        return renderResult;
    }
}