org.apache.cxf.jaxrs.springmvc.SpringWebUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cxf-rt-frontend-jaxrs Show documentation

Apache CXF Runtime JAX-RS Frontend

There is a newer version: 4.1.0

Show newest version

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.cxf.jaxrs.springmvc;

import jakarta.servlet.http.HttpServletRequest;
import org.apache.cxf.common.classloader.ClassLoaderUtils;
import org.springframework.web.filter.ServerHttpObservationFilter;

public final class SpringWebUtils {
    private static final boolean SPRING_WEB_DETECTED;
    
    static {
        boolean springWebDetected = false;

        try {
            ClassLoaderUtils.loadClass("org.springframework.web.filter.ServerHttpObservationFilter",
                SpringWebUtils.class);
            springWebDetected = true;
        } catch (final ClassNotFoundException ex) {
            /* Nothing to do, Spring Web is not present */
        }

        SPRING_WEB_DETECTED = springWebDetected;
    }
    
    private SpringWebUtils() {
    }

    public static void setHttpRequestURI(HttpServletRequest request, String uriTemplate) {
        request.setAttribute("org.springframework.web.servlet.HandlerMapping.bestMatchingPattern", uriTemplate);

        // Populate the HTTP URI to be available to Spring Boot actuator metrics
        if (SPRING_WEB_DETECTED) {
            ServerHttpObservationFilter.findObservationContext(request)
                .ifPresent(context -> context.setPathPattern(uriTemplate));
        }
    }
}