io.gravitee.policy.rest2soap.RestToSoapTransformerPolicy Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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 io.gravitee.policy.rest2soap;

import io.gravitee.common.http.HttpMethod;
import io.gravitee.common.http.HttpStatusCode;
import io.gravitee.common.http.MediaType;
import io.gravitee.common.util.LinkedMultiValueMap;
import io.gravitee.common.util.MultiValueMap;
import io.gravitee.el.exceptions.ELNullEvaluationException;
import io.gravitee.gateway.api.ExecutionContext;
import io.gravitee.gateway.api.Request;
import io.gravitee.gateway.api.RequestWrapper;
import io.gravitee.gateway.api.Response;
import io.gravitee.gateway.api.buffer.Buffer;
import io.gravitee.gateway.api.context.MutableExecutionContext;
import io.gravitee.gateway.api.el.EvaluableRequest;
import io.gravitee.gateway.api.http.stream.TransformableRequestStreamBuilder;
import io.gravitee.gateway.api.stream.ReadWriteStream;
import io.gravitee.policy.api.PolicyChain;
import io.gravitee.policy.api.annotations.OnRequest;
import io.gravitee.policy.api.annotations.OnRequestContent;
import io.gravitee.policy.rest2soap.configuration.SoapTransformerPolicyConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public class RestToSoapTransformerPolicy {

    /**
     * LOGGER
     */
    private final static Logger LOGGER = LoggerFactory.getLogger(RestToSoapTransformerPolicy.class);

    private final static String SOAP_ACTION_HEADER = "SOAPAction";

    /**
     * SOAP transformer configuration
     */
    private final SoapTransformerPolicyConfiguration soapTransformerPolicyConfiguration;

    public RestToSoapTransformerPolicy(SoapTransformerPolicyConfiguration soapTransformerPolicyConfiguration) {
        this.soapTransformerPolicyConfiguration = soapTransformerPolicyConfiguration;
    }

    @OnRequest
    public void onRequest(Request request, Response response, ExecutionContext executionContext, PolicyChain policyChain) {
        // Force method to POST for SOAP requests
        LOGGER.debug("Override HTTP methods for SOAP invocation");
        executionContext.setAttribute(ExecutionContext.ATTR_REQUEST_METHOD, HttpMethod.POST);

        if (soapTransformerPolicyConfiguration.getSoapAction() != null &&
                !soapTransformerPolicyConfiguration.getSoapAction().trim().isEmpty()) {
            LOGGER.debug("Add a SOAPAction header to invoke SOAP WS: {}", soapTransformerPolicyConfiguration.getSoapAction());
            request.headers().set(SOAP_ACTION_HEADER, soapTransformerPolicyConfiguration.getSoapAction());
        }

        // The ManagedRequestWrapper removes pathInfo for SOAP request in order to use the Server URL as defined into the OpenAPI spec
        // it also hides the query parameters if required, the query parameter may be used as variable in the template, so to allow
        // the template engine to process query parameters we have to hide them from the EndpointInvoker but preserve them in the original request.
        if (executionContext instanceof MutableExecutionContext) {
            ((MutableExecutionContext) executionContext)
                    .request(new RestToSoapResquestWrapper(executionContext.request(), !soapTransformerPolicyConfiguration.isPreserveQueryParams()));
        }

        policyChain.doNext(request, response);
    }

    @OnRequestContent
    public ReadWriteStream onRequestContent(Request request, ExecutionContext executionContext, PolicyChain policyChain) {
        String charset =  soapTransformerPolicyConfiguration.getCharset() ;
        String contentType = (charset == null || charset.isEmpty() ? MediaType.TEXT_XML : MediaType.TEXT_XML + "; charset="+charset);
        return TransformableRequestStreamBuilder
                .on(request)
		.contentType(contentType)
                .transform(
                        buffer -> {

                            executionContext.getTemplateEngine().getTemplateContext().setVariable("request",
                                    new EvaluableRequest(request, buffer.toString()));

                            String soapEnvelope = executionContext.getTemplateEngine().convert(
                                    soapTransformerPolicyConfiguration.getEnvelope());

                            if (soapEnvelope == null) {

                                policyChain.streamFailWith(io.gravitee.policy.api.PolicyResult.failure(
                                        HttpStatusCode.INTERNAL_SERVER_ERROR_500,  new ELNullEvaluationException(soapTransformerPolicyConfiguration.getEnvelope()).getMessage()));
                                return null;
                            }

                            return Buffer.buffer(soapEnvelope);
                        }
                ).build();
    }

    /**
     * Use to hide the pathInfo and query parameters according to the wrapper options.
     */
    private static class RestToSoapResquestWrapper extends RequestWrapper {
        /**
         * hide the pathInfo attribute
         */
        private boolean hidePathInfo = true;
        /**
         * hide the query parameters
         */
        private boolean hideQueryParams = false;

        public RestToSoapResquestWrapper(Request request, boolean  hideQueryParams) {
            super(request);
            this.hideQueryParams = hideQueryParams;
        }

        public boolean clearPathInfo() {
            return hidePathInfo;
        }

        public void setHidePathInfo(boolean hidePathInfo) {
            this.hidePathInfo = hidePathInfo;
        }

        public boolean clearQueryParams() {
            return hideQueryParams;
        }

        public void setHideQueryParams(boolean hideQueryParams) {
            this.hideQueryParams = hideQueryParams;
        }

        @Override
        public String pathInfo() {
            if (hidePathInfo) {
                return "";
            } else {
                return super.pathInfo();
            }
        }

        @Override
        public MultiValueMap parameters() {
            if (hideQueryParams) {
                return new LinkedMultiValueMap<>();
            } else {
                return super.parameters();
            }
        }
    }
}